Proofpoint CASB collector

Overview

Proofpoint Cloud App Security Broker (Proofpoint CASB) helps you secure applications such as Microsoft Office 365, Google Workspace, Box, and more. It gives you people-centric visibility and control over your cloud apps, so you can deploy cloud services with confidence.

Configuration requirements

To run this collector, there are some configurations detailed below that you need to consider.

Configuration	Details
API access to a Proofpoint CASB	You will need a API access to a Proofpoint CASB instance configured in an environment acting as a cloud security app broker.
Configure Proofpoint CASB	Install and configure Proofpoint CASB in a cloud environment per Proofpoint instructions and guidance
Obtain API authentication details	Contact your Proofpoint customer representative to obtain your `api_key`, `cliend_id`, and `client_secret`

More information

Refer to the Vendor setup section to know more about these configurations.

Devo collector features

Feature	Details
Allow parallel downloading (`multipod`)	`Allowed`
Running environments	`Collector server` `On-premise`
Populated Devo events	`Table`
Flattening preprocessing	`Yes`

Data sources

Data Source	Description	API Endpoint	Collector service name	Devo Table	Available from release
Alerts	Alerts corresponding to related events	`/v1/alerts`	`alerts`	`casb.proofpoint.alert`	`v1.0.0`
Events	Cloud activity events	`/v2/events`	`events`	`casb.proofpoint.event`	`v1.0.0`

For more information on how the events are parsed, visit our page.

Flattening preprocessing

Data Source	Collector Service	Optional	Flattening Details
Alerts	`alerts`	No	Alerts are flattened on the `related_events` field. Each resultant record includes all the fields of the parent object, the target child object, and fields identifying the index of the target child object.
Events	`events`	No	Events are flattened on the `additionalProperties` field. Each resultant record includes all the fields of the parent object, the target child object, and fields identifying the index of the target child object.

Vendor setup

There are some requirements to set up this collector. You will require API access to a Proofpoint CASB instance configured in an environment acting as a cloud security app broker for one or more cloud applications. To achieve that, you should:

Configure Proofpoint CASB: Install and configure Proofpoint CASB in a cloud environment per Proofpoint instructions and guidance.
Obtain API authentication details: Contact your Proofpoint customer representative to obtain your api_key, cliend_id, and client_secret.

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details
`api_key`	The `api_key` obtained from Proofpoint for authentication.
`client_id`	The `client_id` obtained from Proofpoint for authentication.
`client_secret`	The `client_secret` obtained from Proofpoint for authentication.

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Depending on how did you obtain your credentials, you will have to either fill in or delete the following properties on the JSON credentials configuration block.

Authentication Method	API Key	Client ID	Client Secret
OAuth	REQUIRED	REQUIRED	REQUIRED

Run the collector

Once the data source is configured, you can send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

Alerts

These are the alerts corresponding to related events.

Devo categorization and destination

All events of this service are ingested into the table casb.proofpoint.alert

Verify data collection

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component	Description
Setup	The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller	The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

INFO	InputProcess::ProofpointCasbPullerSetup(example_collector,proofpoint_casb#proofpoint_casb_1,alerts#predefined) -> Setup for module <ProofpointCasbAlertsPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

Note that the PrePull action is executed only one time before the first run of the Pull action.

2023-01-16T15:16:20.026    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) Starting the execution of pre_pull()
2023-01-16T15:16:20.027    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Reading persisted data
2023-01-16T15:16:20.028    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Data retrieved from the persistence: {'initial_start_time_in_utc': '2022-01-16T00:00:00Z', 'last_event_time_in_utc': '2022-01-21T00:00:00Z', 'last_ids': [], '@persistence_version': 1}
2023-01-16T15:16:20.029    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Running the persistence upgrade steps
2023-01-16T15:16:20.029    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Running the persistence corrections steps
2023-01-16T15:16:20.030    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Running the persistence corrections steps
2023-01-16T15:16:20.031    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Detected initial start time in UTC change: {'values_changed': {'root': {'new_value': '2023-01-16T00:00:00Z', 'old_value': '2022-01-16T00:00:00Z'}}}. Resetting state to {'initial_start_time_in_utc': '2023-01-16T00:00:00Z', 'last_event_time_in_utc': '2023-01-16T00:00:00Z', 'last_ids': [], '@persistence_version': 1}
2023-01-16T15:16:20.031 WARNING InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: {'initial_start_time_in_utc': '2022-01-16T00:00:00Z', 'last_event_time_in_utc': '2022-01-21T00:00:00Z', 'last_ids': [], '@persistence_version': 1}. New content: {'initial_start_time_in_utc': '2023-01-16T00:00:00Z', 'last_event_time_in_utc': '2023-01-16T00:00:00Z', 'last_ids': [], '@persistence_version': 1}
2023-01-16T15:16:20.038    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Updating the persistence
2023-01-16T15:16:20.039 WARNING InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Persistence has been updated successfully
2023-01-16T15:16:20.040    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) Finalizing the execution of pre_pull()
2023-01-16T15:16:20.040    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Starting data collection every 600 seconds
2023-01-16T15:16:20.040    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Pull Started
2023-01-16T15:16:20.042    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Retrieving/sending alerts event(s) having timestamp between 2023-01-16T00:00:00+00:00 and 2023-01-16T14:16:20.026261+00:00
2023-01-16T15:16:20.282    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Retrieved 0 alerts event(s) from 2023-01-16T00:00:00+00:00 to 2023-01-16T14:16:20.026261+00:00
2023-01-16T15:16:20.283    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673878580026):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
2023-01-16T15:16:20.283    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673878580026):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
2023-01-16T15:16:20.283    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> The data is up to date!
2023-01-16T15:16:20.284    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Data collection completed. Elapsed time: 0.258 seconds. Waiting for 599.742 second(s) until the next oneler(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Data collection completed. Elapsed time: 0.483 seconds. Waiting for 4.517 second(s) until the next one

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2023-01-16T15:16:20.283    INFO InputProcess::ProofpointCasbAlertsPuller(proofpoint_casb,proofpoint_casb_1,alerts,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673878580026):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.

The value @devo_pulling_id is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that Pull action in Devo’s search window.

Note that a Partial Statistics Report will be displayed after download a page when the pagination is required to pull all available events. Look for the report without the Partial reference.

(Partial) Statistics for this pull cycle (@devo_pulling_id=1656602793.044179) so far: Number of requests made: 2; Number of events received: 45; Number of duplicated events filtered out: 0; Number of events generated and sent: 40.

Restart the persistence

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

Edit the configuration file.
Change the value of the initial_start_time_in_utc parameter to a different one.
Save the changes.
Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

Events

These are the events generated by the cloud activity.

Devo categorization and destination

All events of this service are ingested into the table casb.proofpoint.event

Verify data collection

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component	Description
Setup	The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller	The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

INFO	InputProcess::ProofpointCasbPullerSetup(example_collector,proofpoint_casb#proofpoint_casb_1,alerts#predefined) -> Setup for module <ProofpointCasbAlertsPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

Note that the PrePull action is executed only one time before the first run of the Pull action.

INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) Starting the execution of pre_pull()
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Reading persisted data
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Data retrieved from the persistence: None
WARNING	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Persistence will be overridden due to the retrieved state is empty
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Running the persistence upgrade steps
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Running the persistence corrections steps
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Running the persistence corrections steps
WARNING	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'initial_start_time_in_utc': '2023-01-16T12:00:00Z', 'start_time_in_utc': '2023-01-16T12:00:00Z', 'last_page_token': None}
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Updating the persistence
WARNING	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Persistence has been updated successfully
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) Finalizing the execution of pre_pull()
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Starting data collection every 600 seconds
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Pull Started
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Retrieving events event(s) having start_time=2023-01-16T12:00:00Z and last_page_token=None
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Updating the persistence
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673878995031):Number of requests made: 1; Number of events received: 23; Number of duplicated events filtered out: 0; Number of events generated and sent: 23; Average of events per second: 29.523.
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Retrieving events event(s) having start_time=2023-01-16T12:00:00Z and last_page_token=eyJsaW5lTnVtYmVyIjotMSwiY3VycmVudEtleSI6InRlbmFudF9kZTEzNmM0OTE2YjE0Y2E4YTAzOGU5M2U1MDIzYTdmNC95ZWFyPTIwMjMvbW9udGg9MDEvZGF5PTE2L2hvdXI9MTIvbWludXRlPTA1L2ZsX2V2ZW50c19rZXllZF90ZW5hbnQrNis2MDY2OTc5NzM4Lmpzb24uZ3oifQ==
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Updating the persistence
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673878995031):Number of requests made: 2; Number of events received: 46; Number of duplicated events filtered out: 0; Number of events generated and sent: 46; Average of events per second: 20.960.
...
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Retrieving events event(s) having start_time=2023-01-16T12:00:00Z and last_page_token=eyJsaW5lTnVtYmVyIjotMSwiY3VycmVudEtleSI6InRlbmFudF9kZTEzNmM0OTE2YjE0Y2E4YTAzOGU5M2U1MDIzYTdmNC95ZWFyPTIwMjMvbW9udGg9MDEvZGF5PTE2L2hvdXI9MTQvbWludXRlPTIwL2ZsX2V2ZW50c19rZXllZF90ZW5hbnQrMTUrNzA2NTE0NTg2NC5qc29uLmd6In0=
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> No more new events events found
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673878995031):Number of requests made: 14; Number of events received: 139; Number of duplicated events filtered out: 0; Number of events generated and sent: 139; Average of events per second: 8.099.
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673878995031):Number of requests made: 14; Number of events received: 139; Number of duplicated events filtered out: 0; Number of events generated and sent: 139; Average of events per second: 8.099.
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> The data is up to date!
INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Data collection completed. Elapsed time: 17.177 seconds. Waiting for 582.823 second(s) until the next one

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

INFO	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673878995031):Number of requests made: 14; Number of events received: 139; Number of duplicated events filtered out: 0; Number of events generated and sent: 139; Average of events per second: 8.099.

The value @devo_pulling_id is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that Pull action in Devo’s search window.

Note that a Partial Statistics Report will be displayed after download a page when the pagination is required to pull all available events. Look for the report without the Partial reference.

(Partial) Statistics for this pull cycle (@devo_pulling_id=1656602793.044179) so far: Number of requests made: 2; Number of events received: 45; Number of duplicated events filtered out: 0; Number of events generated and sent: 40.

Restart the persistence

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

Edit the configuration file.
Change the value of the initial_start_time_in_utc parameter to a different one.
Save the changes.
Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

Collector operations

This section is intended to explain how to proceed with the specific operations of this collector.

Verify collector operations

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

A successful run has the following output messages for the initializer module:

INFO	MainProcess::MainThread -> Added "/path/to/collector/devo-collector-proofpoint-casb" directory to the Python path
INFO	MainProcess::MainThread -> Added "/path/to/collector/devo-collector-proofpoint-casb/config_internal" directory to the Python path
INFO	MainProcess::MainThread -> Added "/path/to/collector/devo-collector-proofpoint-casb/schemas" directory to the Python path
INFO	MainProcess::MainThread -> Production mode: False, execute only setup and exit: False, Python version: "3.9.12 (main, Mar 31 2022, 09:38:33) [GCC 9.4.0]", current dir: "/path/to/collector/devo-collector-proofpoint-casb", exists "config" dir: True, exists "config_internal" dir: True, exists "certs" dir: True, exists "schemas" dir: True, exists "credentials" dir: True
INFO	MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config.yaml", "job_config_loc": null, "collector_config_loc": null}
INFO	MainProcess::MainThread -> Using the default location for "job_config_loc" file: "/etc/devo/job/job_config.json"
INFO	MainProcess::MainThread -> "/etc/devo/job" does not exists
INFO	MainProcess::MainThread -> Using the default location for "collector_config_loc" file: "/etc/devo/collector/collector_config.json"
INFO	MainProcess::MainThread -> "/etc/devo/collector" does not exists
INFO	MainProcess::MainThread -> Results of validation of config files parameters: {"config": "/path/to/collector/devo-collector-proofpoint-casb/config/config.yaml", "config_validated": True, "job_config_loc": "/etc/devo/job/job_config.json", "job_config_loc_default": True, "job_config_loc_validated": False, "collector_config_loc": "/etc/devo/collector/collector_config.json", "collector_config_loc_default": True, "collector_config_loc_validated": False}
INFO	MainProcess::MainThread -> Build time: "UNKNOWN", OS: "Linux-5.14.0-1055-oem-x86_64-with-glibc2.31", collector(name:version): "example_collector:1.0.0", owner: "integrations_factory@devo.com", started at: "2023-01-16T14:23:08.949573Z"
INFO	MainProcess::MainThread -> Initialized all object from "MainProcess" process
INFO	MainProcess::MainThread -> OutputProcess - Starting thread (executing_period=120s)
INFO	MainProcess::MainThread -> InputProcess - Starting thread (executing_period=120s)
INFO	OutputProcess::MainThread -> Process started
INFO	MainProcess::MainThread -> Started all object from "MainProcess" process
INFO	InputProcess::MainThread -> Process Started
INFO	MainProcess::CollectorThread -> global_status: {"main_process": {"process_id": 40785, "process_status": "sleeping", "thread_counter": 5, "thread_names": ["MainThread", "QueueFeederThread", "OutputControllerThread", "InputControllerThread", "CollectorThread"], "memory_info": {"rss": "51.66MiB", "vms": "360.71MiB", "shared": "14.20MiB", "text": "2.19MiB", "lib": "0.00B", "data": "69.29MiB", "dirty": "0.00B"}, "CollectorThread": {"running_flag": true, "status": "RUNNING(10)", "shutdown_timestamp": "None", "message_queues": {"standard": {"name": "standard_queue_multiprocessing", "max_size_in_messages": 10000, "max_size_in_mb": 1024, "max_wrap_size_in_items": 100, "current_size": 0, "put_lock": "<Lock(owner=None)>", "input_lock": "<multiprocessing.synchronize.Event object at 0x7fb54cf908e0>"}, "lookup": {"name": "lookup_queue_multiprocessing", "max_size_in_messages": 10000, "max_size_in_mb": 1024, "max_wrap_size_in_items": 100, "current_size": 0, "put_lock": "<Lock(owner=None)>", "input_lock": "<multiprocessing.synchronize.Event object at 0x7fb54cf34280>"}, "internal": {"name": "internal_queue_multiprocessing", "max_size_in_messages": 10000, "max_size_in_mb": 1024, "max_wrap_size_in_items": 100, "current_size": 2, "put_lock": "<Lock(owner=SomeOtherProcess)>", "input_lock": "<multiprocessing.synchronize.Event object at 0x7fb54cf39b80>"}}, "controllers": {"InputControllerThread": {"running_flag": true, "status": "RUNNING(10)", "underlying_process": {"process_id": 40793, "process_status": "running", "num_threads": 2, "memory_info": {"rss": "41.92MiB", "vms": "216.70MiB", "shared": "4.51MiB", "text": "2.19MiB", "lib": "0.00B", "data": "53.03MiB", "dirty": "0.00B"}, "exit_code": null}}, "OutputControllerThread": {"running_flag": true, "status": "RUNNING(10)", "underlying_process": {"process_id": 40791, "process_status": "running", "num_threads": 1, "memory_info": {"rss": "40.88MiB", "vms": "144.70MiB", "shared": "3.46MiB", "text": "2.19MiB", "lib": "0.00B", "data": "44.90MiB", "dirty": "0.00B"}, "exit_code": null}}}}}}
INFO	InputProcess::MainThread -> ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) Starting the execution of init_variables()
INFO	InputProcess::MainThread -> Validating service metadata
INFO	InputProcess::MainThread -> Validating defined module definition
INFO	InputProcess::MainThread -> <rate_limiter> setting has been accepted with the content {'period_in_seconds': 1, 'requests_limit_in_units': 1}
WARNING	InputProcess::MainThread -> The rate_limiter object has been overridden with the following config: {'period_in_seconds': 1, 'requests_limit_in_units': 1}
INFO	InputProcess::MainThread -> Validating common input config
INFO	InputProcess::MainThread -> Validating service input config
INFO	InputProcess::MainThread -> Running overriding rules
INFO	InputProcess::MainThread -> Validating the rate limiter config given by the user
INFO	InputProcess::MainThread -> <rate_limiter> setting has been accepted with the content {'period_in_seconds': 1, 'requests_limit_in_units': 1}
WARNING	InputProcess::MainThread -> The rate_limiter object has been overridden with the following config: {'period_in_seconds': 1, 'requests_limit_in_units': 1}
INFO	InputProcess::MainThread -> Adding raw config to the collector store
INFO	InputProcess::MainThread -> Running custom validation rules
INFO	InputProcess::MainThread -> <rate_limiter> setting has been accepted with the content {'period_in_seconds': 1, 'requests_limit_in_units': 1}
WARNING	InputProcess::MainThread -> The rate_limiter object has been overridden with the following config: {'period_in_seconds': 1, 'requests_limit_in_units': 1}
INFO	InputProcess::MainThread -> ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) Finalizing the execution of init_variables()
INFO	OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
INFO	OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
INFO	OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
INFO	OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
INFO	OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
INFO	OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
INFO	OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
INFO	OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
INFO	OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
INFO	InputProcess::MainThread -> InputThread(proofpoint_casb,proofpoint_casb_1) - Starting thread (execution_period=60s)
INFO	InputProcess::MainThread -> ServiceThread(proofpoint_casb,proofpoint_casb_1,events,predefined) - Starting thread (execution_period=60s)
INFO	InputProcess::MainThread -> ProofpointCasbPullerSetup(example_collector,proofpoint_casb#proofpoint_casb_1,events#predefined) -> Starting thread
INFO	InputProcess::MainThread -> ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) - Starting thread
WARNING	InputProcess::ProofpointCasbEventsPuller(proofpoint_casb,proofpoint_casb_1,events,predefined) -> Waiting until setup will be executed
INFO	OutputProcess::MainThread -> [GC] global: 33.0% -> 33.1%, process: RSS(43.99MiB -> 45.91MiB), VMS(938.00MiB -> 938.00MiB)

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

A successful run has the following output messages for the initializer module:

INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Number of available senders: 1, sender manager internal queue size: 0
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> enqueued_elapsed_times_in_seconds_stats: {}
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Sender: SyslogSender(standard_senders,syslog_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Standard - Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 44 (elapsed 0.007 seconds)
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Number of available senders: 1, sender manager internal queue size: 0
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> enqueued_elapsed_times_in_seconds_stats: {}
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Sender: SyslogSender(internal_senders,syslog_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Internal - Total number of messages sent: 1, messages sent since "2022-06-28 10:39:22.516313+00:00": 1 (elapsed 0.019 seconds)

By default, these information traces will be displayed every 10 minutes.

Sender services

The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:

Sender services	Description
`internal_senders`	In charge of delivering internal metrics to Devo such as logging traces or metrics.
`standard_senders`	In charge of delivering pulled events to Devo.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace

Description

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders.

Standard - Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": 0 (elapsed 0.000 seconds

Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:

44 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2022-06-28 10:39:22.511671+00:00.
21 events where sent to Devo between the last UTC checkpoint and now.
Those 21 events required 0.007 seconds to be delivered.

By default these traces will be shown every 10 minutes.

Check memory usage

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
The global pressure of the available memory is displayed in the global value.
All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

INFO InputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(34.50MiB -> 34.08MiB), VMS(410.52MiB -> 410.02MiB)
INFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB -> 705.28MiB)

Differences between RSS and VMS memory usage:

RSS is the Resident Set Size, which is the actual physical memory the process is using
VMS is the Virtual Memory Size which is the virtual memory that process is using

Enable/disable the logging debug mode

Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes.

To enable this option you just need to edit the configuration file and change the debug_status parameter from false to true and restart the collector.
To disable this option, you just need to update the configuration file and change the debug_status parameter from true to false and restart the collector.

For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode.

Troubleshooting

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

ErrorType	Error Id	Error Message	Cause	Solution
`ProofpointCasbInitVariablesError`	1	`{error_message}`	There have been some kind of error while reading the user config file. Read the error carefully and find the parameter that is causing the error.	Read the error and make the appropriate modifications in the user config file. Some parameter could be missing, etc.
`ProofpointCasbInitVariablesError`	2	`{error_message}`	There have been some kind of error while validating the user config file. Read the error carefully and find the parameter that is causing the error.	Read the error and make the appropriate modifications in the user config file. The type of the parameter was not the expected one, etc.
`ProofpointCasbInitVariablesError`	3	`{error_message}`	There have been some kind of error while initializing the client class used to communicate with the API.	This is an internal issue. Please contact Devo Support.
`ProofpointCasbSetupError`	101	`Potential issue with authentication. Please check credentials and detailed error message: {error_message}`	The credentials used are not valid anymore.	Use some valid credentials.
`ValueError`	-	`Retry-After header not found`	The `Retry-After` header is not included in the response.	This is an internal issue. Please contact Devo Support.
`ValueError`	-	`Retry-After header value is None`	The `Retry-After` header is empty.	This is an internal issue. Please contact Devo Support.
`TypeError`	-	`Invalid type {type}. Must be epoch seconds, epoch millis, str, datetime, or DateTime`	The type used for the date is not correct.	Use one of the formats specified in the error message.

Change log

Release

Released on

Release type

Details

Recommendations

v1.1.0

13 May 2024

BUG FIXING IMPROVEMENTS

Improvements

Upgraded Docker base image from 1.0.0 to 1.2.0
Update DCSDK from 1.8.0 to 1.11.1:
- Updated DCSDK from 1.8.0 to 1.11.1 Updated DevoSDK to v5.1.9
- Fixed some bug related to development on MacOS
- Added an extra validation and fix when the DCSDK receives a wrong timestamp format
- Added an optional config property for use the Syslog timestamp format in a strict way
- Updated DevoSDK to v5.1.10
- Fix for SyslogSender related to UTF-8
- Enhace of troubleshooting. Trace Standardization, Some traces has been introduced.
- Introduced a mechanism to detect "Out of Memory killer" situation
- Updated DevoSDK to v5.1.9
- Fixed some bug related to development on MacOS
- Added an extra validation and fix when the DCSDK receives a wrong timestamp format
- Added an optional config property for use the Syslog timestamp format in a strict

Bug fixing

Fixed the issue with 429 error because of number of request exceeded.

Recommended version

v1.0.1

15 Jun 2023

BUG FIXINGIMPROVEMENTS

Improvements

Update DCSDK from 1.5.0 to 1.8.0

Bug fixing

Updated limits: The requests limits have been updated with the values recommended by the API to avoid 429 errors.

Update

v1.0.0

27 Dec 2022

NEW FEATURE

New features:

Events: Events generated by the cloud activity.
Alerts: Alerts corresponding to related events.

-