Trellix ETP collector

[ 1 Devo collector features ] [ 2 Data sources ] [ 3 Flattening preprocessing ] [ 4 Minimum configuration required for basic pulling ] [ 5 Accepted authentication methods ] [ 6 Run the collector ] [ 7 Collector services detail ] [ 8 Collector operations ] [ 9 Change log ]

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server`
Populated Devo events	`table`
Flattening preprocessing	`no`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
Alert Summary	Gets a list of advanced threat alerts in summary format.	`POST <https://<etp_instance_addr>>/api/v1/alerts`	`alerts_summary`	`mail.trellix.etp.alert_summary`	`v1.0.0`
Email Trace	This retrieves email trace information as per the attributes	`POST <https://<etp_instance_addr>>/api/v1/messages/trace`	`email_trace`	`mail.trellix.etp.email_trace`	`v1.0.0`
User Activity	Searches the user activity for the Admin Users of the client	`POST <https://<etp_instance_addr>>/api/v1/users/activitylogs/search`	`user_activity_search`	`mail.trellix.etp.user_actiivity_search`	`v1.0.0`
Statistics	Users can view the statistics of emails on the ETP Portal.	`POST <https://<etp_instance_addr>>/api/v1/stats`	`statistics`	`mail.trellix.etp.statistic`	`v1.0.0`

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

Flattening preprocessing

Data source	Collector service	Optional	Flattening details

Data source	Collector service	Optional	Flattening details
Alert Summary	`alerts_summary`	`yes`	Flattening not required.
Email Trace	`email_trace`	`yes`	Flattening not required.
User Activity	`user_activity_search`	`yes`	Flattening not required.
Statistics	`statistics`	`yes`	Flattening not required.

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
`access_token`	The Trellix ETP API api key used for authorization.
`instance_id`	Get the ETP instance ID you want to fetch the alerts data for.

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

Accepted authentication methods

Authentication method	API Key	Instance ID

Authentication method	API Key	Instance ID
Access Token \| API Key	REQUIRED	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.

Alert Summary

It gives information of the alerts using the Trellix ETP API. The last known event time for a given batch of record(s) and the IDs associated with the latest records are persisted and referenced in the subsequent pull. Alerts actions are deduplicated by the id field.

This service has the following components:

Component	Description

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:

2023-11-22T10:54:48.371    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2023-11-22T10:54:48.371    INFO OutputProcess::MainThread -> ConsoleSender(internal_senders,console_sender_0) -> Starting thread
2023-11-22T10:54:48.372    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence.
2023-11-22T10:54:48.372    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2023-11-22T10:54:48.372    INFO OutputProcess::MainThread -> ConsoleSenderManagerMonitor(internal_senders,console_1) -> Starting thread (every 300 seconds)
2023-11-22T10:54:48.372    INFO OutputProcess::MainThread -> ConsoleSenderManager(internal_senders,manager,console_1) -> Starting thread
2023-11-22T10:54:48.385    INFO OutputProcess::MainThread -> [GC] global: 70.2% -> 70.2%, process: RSS(41.38MiB -> 41.39MiB), VMS(32.96GiB -> 32.96GiB)
2023-11-22T10:54:48.386    INFO OutputProcess::ConsoleSenderManager(internal_senders,manager,console_1) -> [EMERGENCY PERSISTENCE SYSTEM] ConsoleSenderManager(internal_senders,manager,console_1) -> Nothing retrieved from the persistence.
2023-11-22T10:54:48.386    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence.le_sender_0) -> {"message_timestamp": "2023-11-22 05:24:48.292", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) Starting the execution of init_variables()\", \"time\": \"2023-11-22T05:24:48.292994Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:54:48.388    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:24:48.293", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service metadata\", \"time\": \"2023-11-22T05:24:48.293275Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}2023-11-22T10:54:48.390    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:24:48.315", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Adding raw config to the collector store\", \"time\": \"2023-11-22T05:24:48.315127Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:54:48.730    INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(internal_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/Users/kamran.hussain/collectors/devo-collector-trellix-email-security/certs/chain.crt", "cert_path": "/Users/kamran.hussain/collectors/devo-collector-trellix-email-security/certs/int-if-integrations-india.crt", "key_path": "/Users/kamran.hussain/collectors/devo-collector-trellix-email-security/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2019APAC0027.local", session_id: "4567144528"
2023-11-22T10:54:48.739    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:24:48.343", "message_tag": "devo.collectors.out.local.warning", "message_content": "{\"msg\": \"Waiting until setup will be executed\", \"time\": \"2023-11-22T05:24:48.343612Z\", \"level\": \"warning\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:54:48.739    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:24:48.357", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"[GC] global: 70.2% -> 70.2%, process: RSS(40.99MiB -> 41.07MiB), VMS(32.71GiB -> 32.71GiB)\", \"time\": \"2023-11-22T05:24:48.357311Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null}"}
2023-11-22T10:54:49.726    INFO InputProcess::TrellixPullerSetup(unknown,trellix_collector_input#12345,alerts_summary#predefined) -> Setup for module <TrellixStatefulPuller> 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-11-22T10:58:55.004    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) Starting the execution of pre_pull()
2023-11-22T10:58:55.004    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Reading persisted data
2023-11-22T10:58:55.005    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Data retrieved from the persistence: None
2023-11-22T10:58:55.005 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Persistence will be overridden due to the retrieved state is empty
2023-11-22T10:58:55.005    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Running the persistence upgrade steps
2023-11-22T10:58:55.006    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.004", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) Starting the execution of pre_pull()\", \"time\": \"2023-11-22T05:28:55.004697Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:55.006    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Running the persistence corrections steps
2023-11-22T10:58:55.006    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.005", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Reading persisted data\", \"time\": \"2023-11-22T05:28:55.005024Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:55.006    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Running the persistence corrections steps
2023-11-22T10:58:55.006 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'@persistence_version': 1, 'initial_start_time': '2017-07-11T04:51:26.365Z', 'time_of_last_event': '2017-07-11T04:51:26.365Z', 'last_pull_cycle': '', 'entries_list': []}
2023-11-22T10:58:55.008    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.005", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Data retrieved from the persistence: None\", \"time\": \"2023-11-22T05:28:55.005543Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:55.009    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.006", "message_tag": "devo.collectors.out.local.warning", "message_content": "{\"msg\": \"Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'@persistence_version': 1, 'initial_start_time': '2017-07-11T04:51:26.365Z', 'time_of_last_event': '2017-07-11T04:51:26.365Z', 'last_pull_cycle': '', 'entries_list': []}\", \"time\": \"2023-11-22T05:28:55.006766Z\", \"level\": \"warning\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:55.009    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Updating the persistence
2023-11-22T10:58:55.009 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Persistence has been updated successfully
2023-11-22T10:58:55.010    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) Finalizing the execution of pre_pull()
2023-11-22T10:58:55.010    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.009", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Updating the persistence\", \"time\": \"2023-11-22T05:28:55.009385Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:55.010    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Starting data collection every 60 seconds
2023-11-22T10:58:55.010    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Pull Started
2023-11-22T10:58:55.011    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.009", "message_tag": "devo.collectors.out.local.warning", "message_content": "{\"msg\": \"Persistence has been updated successfully\", \"time\": \"2023-11-22T05:28:55.009976Z\", \"level\": \"warning\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:55.013    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:28:55.010", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Pull Started\", \"time\": \"2023-11-22T05:28:55.010703Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"alerts_summary\", \"module_name\": \"TrellixStatefulPuller\"}"}
2023-11-22T10:58:57.161    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Updated persistence
2023-11-22T10:58:57.162    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700630935004):Number of requests made: 1; Number of events received: 200; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 92.973.
2023-11-22T10:58:57.532    INFO OutputProcess::DevoSender(standard_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(standard_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/Users/kamran.hussain/collectors/devo-collector-trellix-email-security/certs/chain.crt", "cert_path": "/Users/kamran.hussain/collectors/devo-collector-trellix-email-security/certs/int-if-integrations-india.crt", "key_path": "/Users/kamran.hussain/collectors/devo-collector-trellix-email-security/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2019APAC0027.local", session_id: "4600221856"
2023-11-22T10:58:59.555    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> Updated persistence
2023-11-22T10:58:59.556    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700630935004):Number of requests made: 2; Number of events received: 400; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 44.000

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

2023-11-22T10:58:59.556    INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,alerts_summary,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700630935004):Number of requests made: 2; Number of events received: 400; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 44.000.

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 from_LastModifiedOn 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.

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
`PullerSetupError`	`100`	HTTP Error occurred while retrieving events from ETP server, Summary:{HTTPError}, Details:{HTTPError.respons}	This error happens when the collector tries to fetch the ETP alerts from its REST API.	In this error you will find the HTTP error code as well as the response’s text. This information should be enough to understand why is the error happening. Otherwise, please contact support.
	`101`	Some errors occurred while retrieving events from the ETP server. Error details: {Exception}	Some exceptions occurred while making the API request. Example : API Token expired.	Reach out to the developer with the exact error message.
`PullerPullError`	`200, 201`	Error occurred while fetching Alert summary from ETP servers		Reach out to the developer with the exact error message.
`SdkInputInitializationError`	`1`	Initial_start_time is not set as per datetime_format in service_name	The start time specified in config is not in accordance with the datetime format.	Make sure you have specified the start time in the proper datetime format.
	`2`	Date initial_start_time is in the future	The start time mentioned is ahead of the present time	Make sure the start time is in the past.

Email Trace

It gives information of the Email traces using the Trellix ETP API. The last known event time for a given batch of record(s) and the IDs associated with the latest records are persisted and referenced in the subsequent pull. Email Trace actions are deduplicated by the id field.

This service has the following components:

Component	Description

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:

Puller output

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

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

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 lastModifiedDateTime 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.

User Activity

Statistics

Collector operations

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

Change log

Release	Released on	Release type	Details	Recommendations

Release

Released on

Release type

Details

Recommendations

v1.0.0

Nov 13, 2023

NEW FEATURE

Released the first version of the Trellix ETP collector.

Recommended version