Proofpoint Isolation collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Vendor setup ] [ 5 Run the collector ] [ 6 Collector services detail ] [ 7 Collector operations ] [ 8 Change log ]

Overview

With Proofpoint Email Isolation, administrators can configure isolation policies based on specific criteria, such as sender reputation, attachment type, or keyword filtering. Isolated messages are stored securely and can be analyzed for threats, providing visibility into potential attacks and allowing organizations to take action to prevent them.

Proofpoint Browser Isolation secures the web browsing and email activities of your users. It uses cloud-based remote browser isolation to allow your people to access websites and their personal and corporate email freely, without exposing your organization to malware and data loss.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table`
Flattening preprocessing	`no`
Allowed source events obfuscation	`yes`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
Browser and email isolation reports	Browser and email isolation report events	`https://proofpointisolation.com/api/v2/reporting/usage-data/`	`browser_and_email_isolation`	`tap.proofpoint.isolation.browser_and_email`	`v1.0.0`
URL isolation reports	URL isolation report events	`https://urlisolation.com/api/v2/reporting/usage-data/`	`url_isolation`	`tap.proofpoint.isolation.url_isolation`	`v1.0.0`

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

Vendor setup

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

Setting	Details
`api_key`	API key

Steps

Action	Steps
Obtain API key	Navigate to Product Settings → Reporting API. The API key can be generated and found in the Isolation Reporting API Console's main viewing panel under Reporting API Key.

Assigning necessary permissions

Only the credentials above are required.

Run the collector

Once the data source is configured, you can either 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.

Internal process and deduplication method

Proofpoint Isolation API stores events up to 30 days in the past. All isolation events are fetched on a polling basis. If there are more events available for a given time period than can be retrieved in a single page (limited to 10,000 records per page), the collector continues to fetch new events until none are available for the query window.

Events are sorted by the date field and deduplicated by comparing the hash signature of the event against previous pulls.

Devo categorization and destination

All events of this service are ingested into the table tap.proofpoint.isolation.url_isolation

Setup output

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

2023-04-03T16:18:50.783    INFO InputProcess::MainThread -> IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Starting thread
2023-04-03T16:18:50.784 WARNING InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> The token/header/authentication has not been created yet
2023-04-03T16:18:50.785    INFO InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Making sample request to test authentication.
2023-04-03T16:18:50.792    INFO InputProcess::MainThread -> IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Starting thread
2023-04-03T16:18:50.792    INFO InputProcess::MainThread -> IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) - Starting thread
2023-04-03T16:18:50.792 WARNING InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Waiting until setup will be executed
2023-04-03T16:18:50.793 WARNING InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> The token/header/authentication has not been created yet
2023-04-03T16:18:51.509    INFO InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Setup for module <IsolationPuller> has been successfully executed
2023-04-03T16:18:51.510    INFO InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Making sample request to test authentication.
2023-04-03T16
2023-04-03T16:20:12.074    INFO InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Authentication successful.
2023-04-03T16:18:52.096    INFO InputProcess::IsolationPullerSetup(unknown,proofpoint_isolation#10001,url_isolation#predefined) -> Setup for module <IsolationPuller> has been successfully executed

Puller output

2023-05-16T23:02:54.695    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) Starting the execution of pre_pull()
2023-05-16T23:02:54.696    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Reading persisted data
2023-05-16T23:02:54.698    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Data retrieved from the persistence: {'start_time_in_utc': '2023-05-16T00:00:00.000000Z', 'last_event_time_in_utc': '2023-05-17T03:01:40.121516Z', 'last_ids': ['57bddd353b7cc010ab4a696cf86d4c18e97aafbdc49a52498bddc756de044c9f', '57bddd353b7cc010ab4a696cf86d4c18e97aafbdc49a52498bddc756de044c9f'], '@persistence_version': 1}
2023-05-16T23:02:54.699    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Running the persistence upgrade steps
2023-05-16T23:02:54.700    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Running the persistence corrections steps
2023-05-16T23:02:54.700    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Running the persistence corrections steps
2023-05-16T23:02:54.701    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> No changes were detected in the persistence
2023-05-16T23:02:54.702    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) Finalizing the execution of pre_pull()
2023-05-16T23:02:54.702    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Starting data collection every 60 seconds
2023-05-16T23:02:54.702    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Pull Started
2023-05-16T23:02:54.702    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Fetching all url_isolation event(s) from 2023-05-17T03:01:40.121516Z to 2023-05-17T03:02:54.695673Z.
2023-05-16T23:02:55.648    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> Updating the persistence
2023-05-16T23:02:55.650    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1684292574695):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.

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

2023-04-03T16:20:41.575    INFO InputProcess::IsolationPuller(proofpoint_isolation,10001,url_isolation,predefined) -> The data is up to date!

Internal process and deduplication method

Proofpoint Isolation API stores events up to 30 days in the past. All isolation events are fetched on a polling basis. If there are more events available for a given time period than can be retrieved in a single page (limited to 10,000 records per page), the collector continues to fetch new events until none are available for the query window.

Events are sorted by the date field and deduplicated by comparing the hash signature of the event against previous pulls.

Devo categorization and destination

All events of this service are ingested into the table tap.proofpoint.isolation.url_isolation.

Setup output

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

Puller output

After a successful collector’s execution (that is, no error logs were found), you should be able to see the following log message:

Restart the persistence

To restart the service, the user must reconfigure the start_time_in_utc parameter within the configuration file. When the collector is restarted, the system will register the new start time and begin pulling events from that date.

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.

Error Type	Error Id	Error Message	Cause	Solution

Error Type	Error Id	Error Message	Cause	Solution
ApiError	403	API Key XXXXXX is not valid.	Invalid API key	The key is not valid. Please create a new one through the Isolation system.

Collector operations

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

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:

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:

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

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

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.

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

Displays 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 2023-01-10 16:09:16.116750+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.

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

Change log

Release	Released on	Release type	Details	Recommendations

Release

Released on

Release type

Details

Recommendations

v1.1.1

Sep 26, 2023

bug fixing

Bug fixing

Controlled range values in user schemas for variable override_query_window_offset_in_minutes

Update

v1.1.0

Sep 22, 2023

NEW FEATURE

New feature

Added new variable override_query_window_offset_in_minutes to ensure the events are fully recorded in the API before we try to fetch them

Improvements

Upgraded DCSDK and internal modules to the latest version

Update

v1.0.0

Mar 20, 2022

INITIAL RELEASE

Initial release

-