--- title: "Trellix ETP collector" canonical: "https://docs.devo.com/space/latest/429522962/Trellix%20ETP%20collector" format: markdown --- > Macro (toc) ## Devo collector features | **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 >/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 >/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 >/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 >/api/v1/stats` | `statistics` | `mail.trellix.etp.statistic` | `v1.0.0` | For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/426737863). ## Flattening preprocessing | **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** | | --- | --- | | `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** | | --- | --- | --- | | 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). > Macro (rw-ui-tabs-macro) > > > Macro (rw-tab) > > We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, [get in touch with us](https://devo.my.site.com/support/login?ec=302&startURL=%2Fsupport%2Fs%2F) and we will guide you through the configuration. > > > Macro (rw-tab) > > This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running. > > ### Structure > > The following directory structure should be created for being used when running the collector: > > ``` > > └── devo-collectors/ > └── / > ├── certs/ > │ ├── chain.crt > │ ├── .key > │ └── .crt > ├── state/ > └── config/ > └── config.yaml > ``` > > > ⚠️ Replace `` with the proper value. > > ### Devo credentials > > In Devo, go to **Administration → Credentials → X.509 Certificates**, download the **Certificate**, **Private key** and **Chain CA** and save them in `/certs/`. Learn more about security credentials in Devo [here](#). > > ![image](media://c565bf0e-d034-4eea-9dbe-ecb6c189ee05) > > > ⚠️ Replace `` with the proper value. > > ### Editing the config.yaml file > > ``` > globals: > debug: false > id: not_used > name: trellix_email_security_collector > persistence: > type: filesystem > config: > directory_name: state > > outputs: > devo_1: > type: devo_platform > config: > address: > port: 443 > type: SSL > chain: > cert: > key: > > inputs: > trellix_collector_input: > id: > enabled: true > credentials: > instance_id: > access_token: > services: > alerts_summary: > from_LastModifiedOn: > override_tag : > requests_limits: > - period: 1m > number_of_requests: 60 > > email_trace: > lastModifiedDateTime: > hasAttachment: > override_tag : > requests_limits: > - period: 1m > number_of_requests: 60 > > user_activity_search: > from_time: > override_tag : > requests_limits: > - period: 1m > number_of_requests: 60 > > statistics: > override_tag : > requests_limits: > - period: 1m > number_of_requests: 60 > ``` > > > ℹ️ All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the `services` object. > > Replace the placeholders with your required values following the description table below: > > | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** | > | --- | --- | --- | --- | --- | > | `devo_address` | `str` | `Mandatory` | [collector-us.devo.io](http://collector-us.devo.io/)
[collector-eu.devo.io](http://collector-eu.devo.io/) | Use this param to identify the Devo Cloud where the events will be sent. | > | `chain_filename` | `str` | `Mandatory` | Minimum length: 4
Maximum length: 20 | Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: chain.crt | > | `cert_filename` | `str` | `Mandatory` | Minimum length: 4
Maximum length: 20 | Use this param to identify the file.cert downloaded from your Devo domain. | > | `key_filename` | `str` | `Mandatory` | Minimum length: 4
Maximum length: 20 | Use this param to identify the file.key downloaded from your Devo domain. | > | `input_id` | `int` | `Mandatory` | Minimum length: 1
Maximum length: 5 | Use this param to give an unique id to this input service.
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision. | > | `access_token` | `str` | `Mandatory` | Minimum length: 1 | apiKey | access_token for API authorization. | > | `instance_id` | `str` | `Mandatory`` | Minimum length: 1 | ETP instance Id, to be passed in the API. | > | `override_tag` | `str` | `Optional` | A devo tag | This parameter allows to define a custom devo tag.
> ℹ️ This parameter should be removed if it is not used. | > | `from_LastModifiedOn` | `str` | `Required` | Minimum length: 1
`Format : "YYYY-MM-DDThh:mm:ss.fffZ"` | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.
Example : "2017-07-11T04:51:26.365Z"
> ⚠️ Strictly adhere to the Date format. | > | `lastModifiedDateTime` | `str` | `Required` | Minimum length: 1
`Format : "YYYY-MM-DDThh:mm:ss.fffZ"` | This configuration allows you to set a custom date as the beginning of the period to download.
Example : "2017-07-11T04:51:26.365Z"
> ⚠️ Strictly adhere to the Date format. | > | `hasAttachment` | `bool` | `Required` | `true / false` | This flags check if the emails data to be fetched should include attachments or not. | > | `from_time` | `str` | `Required` | Minimum length: 1
`Format : "YYYY-MM-DDThh:mm:ss+0000Z"`
> ℹ️ Any offset can be used i.e -0530Z, +0630 | This configuration allows you to set a custom date as the beginning of the period to download. Example : "2023-07-18T16:30:04+0000Z"
> ⚠️ Strictly adhere to the Date format. | > > ### Download the Docker image > > The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table: > > | **Collector Docker image** | **SHA-256 hash** | > | --- | --- | > | [collector-trellix_etp_if-docker-image-1.1.0.tgz](https://drive.google.com/file/d/15P4e1KuJzcfNtBn5KghwyOGgFJHyEe1U/view?usp=drive_link) | `e7f7221bb9dff5cf42061463744c2c8a0c79795e4df4776caa01c406ed716309` | > > Use the following command to add the Docker image to the system: > > ``` > gunzip -c -.tgz | docker load > ``` > > > ⚠️ Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `` and `` with a proper value. > > The Docker image can be deployed on the following services: > > #### Docker > > Execute the following command on the root directory `/devo-collectors//` > > ``` > docker run > --name collector- > --volume $PWD/certs:/devo-collector/certs > --volume $PWD/config:/devo-collector/config > --volume $PWD/state:/devo-collector/state > --env CONFIG_FILE=config.yaml > --rm > --interactive > --tty > : > ``` > > > ⚠️ Replace ``, `` and `` with the proper values. > > #### Docker Compose > > The following Docker Compose file can be used to execute the Docker container. It must be created in the `/devo-collectors//` directory. > > ``` > version: '3' > services: > collector-: > image: :${IMAGE_VERSION:-latest} > container_name: collector- > volumes: > - ./certs:/devo-collector/certs > - ./config:/devo-collector/config > - ./credentials:/devo-collector/credentials > - ./state:/devo-collector/state > environment: > - CONFIG_FILE=${CONFIG_FILE:-config.yaml} > ``` > > To run the container using docker-compose, execute the following command from the `/devo-collectors//` directory: > > ``` > IMAGE_VERSION= docker-compose up -d > ``` > > > ⚠️ Replace ``, `` and `` with the proper values. ## Collector services detail This section is intended to explain how to proceed with specific actions for services. ### Alert Summary
Verify data collection 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** | | --- | --- | | 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 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. ``` > ℹ️ 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.
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: 1. Edit the configuration file. 2. Change the value of the `from_LastModifiedOn` parameter to a different one. 3. Save the changes. 4. 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.
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. | **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
Verify data collection 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** | | --- | --- | | 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,email_trace,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\": \"email_trace\", \"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\": \"email_trace\", \"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\": \"email_trace\", \"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\": \"email_trace\", \"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,email_trace#predefined) -> Setup for module 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,email_trace,predefined) -> TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) Starting the execution of pre_pull() 2023-11-22T10:58:55.004 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Reading persisted data 2023-11-22T10:58:55.005 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Data retrieved from the persistence: None 2023-11-22T10:58:55.005 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,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,email_trace,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,email_trace,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\": \"email_trace\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.006 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,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\": \"email_trace\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.006 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Running the persistence corrections steps 2023-11-22T10:58:55.006 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,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\": \"email_trace\", \"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\": \"email_trace\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.009 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Updating the persistence 2023-11-22T10:58:55.009 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Persistence has been updated successfully 2023-11-22T10:58:55.010 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> TrellixStatefulPuller(trellix_collector_input,12345,email_trace,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\": \"email_trace\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.010 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Starting data collection every 60 seconds 2023-11-22T10:58:55.010 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,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\": \"email_trace\", \"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\": \"email_trace\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:57.161 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Updated persistence 2023-11-22T10:58:57.162 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,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.165 INFO OutputProcess::ConsoleSender(standard_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:41:07.094203+00:00", "message_tag": "mail.trellix.etp.email_trace", "message_content": "{\"id\": \"3yPv6OB-9921-08627109779F8806356e4fc2ee6\", \"type\": \"trace\", \"included\": [{\"attributes\": {\"name\": \"smrt.com.sg\"}, \"type\": \"domain\"}], \"attributes\": {\"verdicts\": {\"AS\": \"\", \"AV\": \"\", \"AT\": \"\", \"PV\": \"pass\", \"YARA\": \"\", \"ActionYARA\": \"\"}, \"domain\": \"smrt.com.sg\", \"downStreamMsgID\": \"250 2.6.0 <1192170684.1616259.1698039949865@pc66bsub1004.dc066.sf.priv.successfactors.com> [InternalId=105566001182682, Hostname=SI2PR03MB5499.apcprd03.prod.outlook.com] 13385 bytes in 0.065, 198.389 KB/sec Queued mail for delivery\", \"subject\": \"SuccessFactors system Candidate User Sync [CAND_USER_SYNC_C0001138062P_Mon Oct 23 16:45:39 AEDT 2023 23/10/23 16:45] status\", \"acceptedDateTime\": \"2023-10-23T05:45:52.000\", \"lastModifiedDateTime\": \"2023-10-23T05:45:54.630\", \"originalMessageID\": \"<1192170684.1616259.1698039949865@pc66bsub1004.dc066.sf.priv.successfactors.com>\", \"countryCode\": \"au\", \"senderHeader\": \"\\\"SMRT Achieving Career Excellence (ACE)\\\" \", \"senderSMTP\": \"pmnotifications@successfactors.com\", \"senderIP\": \"20.5.82.25\", \"status\": \"delivered\", \"recipientSMTP\": [\"a.inbha@smrt.com.sg\"], \"recipientHeader\": [\"API Admin \"], \"emailSize\": 3.02, \"customRuleNames\": [\"Allow pmnotifications@successfactors.com\"]}, \"@devo_pulling_id\": \"1700631667094\"}"} 2023-11-22T11:11:09.376 INFO OutputProcess::ConsoleSender(standard_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 05:41:07.094203+00:00", "message_tag": "mail.trellix.etp.email_trace", "message_content": "{\"id\": \"3yPv6OB-9921-0896710977919806356e4fc2ee6\", \"type\": \"trace\", \"included\": [{\"attributes\": {\"name\": \"smrt.com.sg\"}, \"type\": \"domain\"}], \"attributes\": {\"verdicts\": {\"AS\": \"\", \"AV\": \"\", \"AT\": \"\", \"PV\": \"pass\", \"YARA\": \"\", \"ActionYARA\": \"\"}, \"domain\": \"smrt.com.sg\", \"downStreamMsgID\": \"250 2.6.0 <6d8d6770-7167-11ee-b3d7-33a4b9188cf3@fbworkmail.com> [InternalId=105415677327564, Hostname=TYZPR03MB5597.apcprd03.prod.outlook.com] 33681 bytes in 0.154, 212.741 KB/sec Queued mail for delivery\", \"subject\": \"Rosli, respond to your 199 unread notifications, 23 new coworkers and 193 group updates\", \"acceptedDateTime\": \"2023-10-23T05:45:54.000\", \"lastModifiedDateTime\": \"2023-10-23T05:45:56.143\", \"originalMessageID\": \"<6d8d6770-7167-11ee-b3d7-33a4b9188cf3@fbworkmail.com>\", \"countryCode\": \"us\", \"senderHeader\": \"\\\"SMRT via Workplace\\\" \", \"senderSMTP\": \"notification@fbworkmail.com\", \"senderIP\": \"69.171.232.173\", \"status\": \"delivered\", \"recipientSMTP\": [\"arshadr@smrt.com.sg\"], \"recipientHeader\": [\"Rosli Bin Arshad \"], \"emailSize\": 23.54, \"customRuleNames\": [\"Allow notification@fbworkmail.com\"]}, \"@devo_pulling_id\": \"1700631667094\"}"} 2023-11-22T11:11:09.706 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: "4568523008" 2023-11-22T11:11:11.555 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> Updated persistence 2023-11-22T11:11:11.556 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700631667094):Number of requests made: 2; Number of events received: 599; Number of duplicated events filtered out: 0; Number of events generated and sent: 299; Average of events per second: 67.103 ``` After a successful collector’s execution (that is, no error logs found), you will see the following log message: ``` 2023-11-22T11:11:11.556 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,email_trace,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700631667094):Number of requests made: 2; Number of events received: 599; Number of duplicated events filtered out: 0; Number of events generated and sent: 299; Average of events per second: 67.103 ``` > ℹ️ 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.
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: 1. Edit the configuration file. 2. Change the value of the `lastModifiedDateTime` parameter to a different one. 3. Save the changes. 4. 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.
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. | **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` | `202, 203` | Error occurred while fetching Email trace from ETP servers | | Reach out to the developer with the exact error message. | | `SdkInputInitializationError` | `1` | `lastModifiedDateTime` 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 `lastModifiedDateTime` is in the future | The start time mentioned is ahead of the present time | Make sure the start time is in the past. |
### User Activity
Verify data collection It searches the user activity for the Admin Users of the client information 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. Actions are deduplicated by the Hash of email and timestamp field. 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: ``` 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,user_activity_search,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\": \"user_activity_search\", \"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\": \"user_activity_search\", \"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\": \"user_activity_search\", \"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\": \"user_activity_search\", \"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,user_activity_search#predefined) -> Setup for module 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,user_activity_search,predefined) -> TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) Starting the execution of pre_pull() 2023-11-22T10:58:55.004 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Reading persisted data 2023-11-22T10:58:55.005 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Data retrieved from the persistence: None 2023-11-22T10:58:55.005 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,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,user_activity_search,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,user_activity_search,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\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.006 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,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\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.006 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Running the persistence corrections steps 2023-11-22T10:58:55.006 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,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\": \"user_activity_search\", \"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\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.009 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Updating the persistence 2023-11-22T10:58:55.009 WARNING InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Persistence has been updated successfully 2023-11-22T10:58:55.010 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,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\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:55.010 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Starting data collection every 60 seconds 2023-11-22T10:58:55.010 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,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\": \"user_activity_search\", \"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\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T10:58:57.161 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Updated persistence 2023-11-22T10:58:57.162 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,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.165 INFO OutputProcess::ConsoleSender(standard_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 06:44:28.091218+00:00", "message_tag": "mail.trellix.etp.user_activity_search", "message_content": "{\"attributes\": {\"user_email_id\": \"desmondyao@smrt.com.sg\", \"time\": \"2023-11-16T15:38:07+0000Z\", \"user_ip\": \"57.140.24.52\", \"details_values\": [\"3yPz0Fk-9921-09470526818CFB75556f66ebf31\"], \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36\", \"user_action\": \"VIEWED_QUARANTINE_MESSAGE\", \"user_action_text\": \"Quarantine Message Viewed\", \"details\": \"Viewed Quarantine Message 3yPz0Fk-9921-09470526818CFB75556f66ebf31\"}, \"@devo_pulling_id\": \"1700635468091\"}"} 2023-11-22T12:14:30.459 INFO OutputProcess::ConsoleSender(standard_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 06:44:28.091218+00:00", "message_tag": "mail.trellix.etp.user_activity_search", "message_content": "{\"attributes\": {\"user_email_id\": \"desmondyao@smrt.com.sg\", \"time\": \"2023-11-16T15:37:06+0000Z\", \"user_ip\": \"57.140.24.52\", \"details_values\": [\"3yPz0Fv-9921-085B9D3103009E7555686b96848\"], \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36\", \"user_action\": \"MESSAGE_PREVIEW_VIEWED\", \"user_action_text\": \"Message Preview Viewed\", \"details\": \"Message was previewed for \\\"3yPz0Fv-9921-085B9D3103009E7555686b96848\\\"\"}, \"@devo_pulling_id\": \"1700635468091\"}"} 2023-11-22T12:14:30.774 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: "4457726016" 2023-11-22T12:14:31.580 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Updated persistence 2023-11-22T12:14:31.581 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700635468091):Number of requests made: 2; Number of events received: 500; 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-11-22T12:14:31.581 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700635468091):Number of requests made: 2; Number of events received: 500; 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.
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: 1. Edit the configuration file. 2. Change the value of the `lastModifiedDateTime` parameter to a different one. 3. Save the changes. 4. 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.
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. | **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` | `204, 205` | Error occurred while fetching User activity from ETP servers | | Reach out to the developer with the exact error message. | | `SdkInputInitializationError` | `1` | `lastModifiedDateTime` 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 `lastModifiedDateTime` is in the future | The start time mentioned is ahead of the present time | Make sure the start time is in the past. |
### Statistics
Verify data collection Users can view the statistics of emails via the Dashboard and Reports tabs on the ETP Portal. 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: ``` 2023-11-22T13:25:33.158 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds) 2023-11-22T13:25:33.158 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread 2023-11-22T13:25:33.159 INFO OutputProcess::MainThread -> ConsoleSender(standard_senders,console_sender_0) -> Starting thread 2023-11-22T13:25:33.159 INFO OutputProcess::MainThread -> ConsoleSenderManagerMonitor(standard_senders,console_1) -> Starting thread (every 300 seconds) 2023-11-22T13:25:33.159 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.159 INFO OutputProcess::MainThread -> ConsoleSenderManager(standard_senders,manager,console_1) -> Starting thread 2023-11-22T13:25:33.160 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2023-11-22T13:25:33.160 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds) 2023-11-22T13:25:33.160 INFO OutputProcess::ConsoleSenderManager(standard_senders,manager,console_1) -> [EMERGENCY PERSISTENCE SYSTEM] ConsoleSenderManager(standard_senders,manager,console_1) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.160 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.160 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread 2023-11-22T13:25:33.161 INFO OutputProcess::MainThread -> ConsoleSender(lookup_senders,console_sender_0) -> Starting thread 2023-11-22T13:25:33.161 INFO OutputProcess::MainThread -> ConsoleSenderManagerMonitor(lookup_senders,console_1) -> Starting thread (every 300 seconds) 2023-11-22T13:25:33.161 INFO OutputProcess::MainThread -> ConsoleSenderManager(lookup_senders,manager,console_1) -> Starting thread 2023-11-22T13:25:33.161 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.162 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2023-11-22T13:25:33.162 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds) 2023-11-22T13:25:33.162 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread 2023-11-22T13:25:33.163 INFO OutputProcess::ConsoleSenderManager(lookup_senders,manager,console_1) -> [EMERGENCY PERSISTENCE SYSTEM] ConsoleSenderManager(lookup_senders,manager,console_1) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.163 INFO OutputProcess::MainThread -> ConsoleSender(internal_senders,console_sender_0) -> Starting thread 2023-11-22T13:25:33.163 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.163 INFO OutputProcess::MainThread -> ConsoleSenderManagerMonitor(internal_senders,console_1) -> Starting thread (every 300 seconds) 2023-11-22T13:25:33.163 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.163 INFO OutputProcess::MainThread -> ConsoleSenderManager(internal_senders,manager,console_1) -> Starting thread 2023-11-22T13:25:33.183 INFO OutputProcess::MainThread -> [GC] global: 66.8% -> 66.8%, process: RSS(41.15MiB -> 41.15MiB), VMS(32.96GiB -> 32.96GiB) 2023-11-22T13:25:33.184 INFO OutputProcess::ConsoleSenderManager(internal_senders,manager,console_1) -> [EMERGENCY PERSISTENCE SYSTEM] ConsoleSenderManager(internal_senders,manager,console_1) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.184 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-22T13:25:33.604 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: "4515289840" 2023-11-22T13:25:33.605 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:55:33.085", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Adding raw config to the collector store\", \"time\": \"2023-11-22T07:55:33.085623Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"statistics\", \"module_name\": \"TrellixStatelessPuller\"}"} 2023-11-22T13:25:33.609 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:55:33.137", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"[GC] global: 66.8% -> 66.8%, process: RSS(40.97MiB -> 40.98MiB), VMS(32.71GiB -> 32.71GiB)\", \"time\": \"2023-11-22T07:55:33.137229Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null}"} 2023-11-22T13:25:34.642 INFO InputProcess::TrellixPullerSetup(unknown,trellix_collector_input#12345,statistics#predefined) -> Setup for module 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-22T13:25:35.121 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) Starting the execution of pre_pull() 2023-11-22T13:25:35.122 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Reading persisted data 2023-11-22T13:25:35.122 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Data retrieved from the persistence: None 2023-11-22T13:25:35.122 WARNING InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Persistence will be overridden due to the retrieved state is empty 2023-11-22T13:25:35.123 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Running the persistence upgrade steps 2023-11-22T13:25:35.123 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:55:35.121", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) Starting the execution of pre_pull()\", \"time\": \"2023-11-22T07:55:35.121747Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"statistics\", \"module_name\": \"TrellixStatelessPuller\"}"} 2023-11-22T13:25:35.123 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:55:35.122", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Reading persisted data\", \"time\": \"2023-11-22T07:55:35.122075Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"statistics\", \"module_name\": \"TrellixStatelessPuller\"}"} 2023-11-22T13:25:35.123 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Running the persistence corrections steps 2023-11-22T13:25:35.123 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Running the persistence corrections steps 2023-11-22T13:25:35.123 WARNING InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> The persistence version value is , so no persistence will be allocated 2023-11-22T13:25:35.124 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) Finalizing the execution of pre_pull() 2023-11-22T13:25:35.124 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Starting data collection every 60 seconds 2023-11-22T13:25:35.124 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Pull Started 2023-11-22T13:25:35.126 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:55:35.122", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Data retrieved from the persistence: None\", \"time\": \"2023-11-22T07:55:35.122634Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"statistics\", \"module_name\": \"TrellixStatelessPuller\"}"} 2023-11-22T13:25:38.382 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700639735121):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 0.307. 2023-11-22T13:25:38.382 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1700639735121):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 0.307. 2023-11-22T13:25:38.382 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> The data is up to date! 2023-11-22T13:25:38.383 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Data collection completed. Elapsed time: 3.261 seconds. Waiting for 56.739 second(s) until the next one 2023-11-22T13:25:38.385 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:55:38.382", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"(Partial) Statistics for this pull cycle (@devo_pulling_id=1700639735121):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 0.307.\", \"time\": \"2023-11-22T07:55:38.382131Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"statistics\", \"module_name\": \"TrellixStatelessPuller\"}"} 2023-11-22T13:25:38.712 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: "4515396960" 2023-11-22T13:26:33.155 INFO InputProcess::MainThread -> [GC] global: 67.0% -> 67.0%, process: RSS(46.09MiB -> 46.09MiB), VMS(32.73GiB -> 32.73GiB) 2023-11-22T13:26:33.157 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:56:33.155", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"[GC] global: 67.0% -> 67.0%, process: RSS(46.09MiB -> 46.09MiB), VMS(32.73GiB -> 32.73GiB)\", \"time\": \"2023-11-22T07:56:33.155884Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null}"} 2023-11-22T13:26:33.659 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Consumed messages: 38 messages (60.494292 seconds) => 0 msg/sec 2023-11-22T13:26:35.124 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> Pull Started 2023-11-22T13:26:35.126 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 39, total_bytes: 26782 (61.962052 seconds) ``` After a successful collector’s execution (that is, no error logs found), you will see the following log message: ``` 2023-11-22T13:25:38.382 INFO InputProcess::TrellixStatelessPuller(trellix_collector_input,12345,statistics,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700639735121):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 0.307. ``` > ℹ️ 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.
Restart the persistence > ⚠️ This collector does not use persistent storage.
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. | **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` | `206, 207` | Error occurred while fetching User activity from ETP servers | | Reach out to the developer with the exact error message. |
## Collector operations This section is intended to explain how to proceed with specific operations of this collector.
Verify collector operations ### Initialization he 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: ``` 2023-11-22T13:19:46.924 INFO InputProcess::MainThread -> TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) Starting the execution of init_variables() 2023-11-22T13:19:46.925 INFO InputProcess::MainThread -> Validating service metadata 2023-11-22T13:19:46.935 INFO InputProcess::MainThread -> Validating defined module definition 2023-11-22T13:19:46.945 INFO InputProcess::MainThread -> Validating common input config 2023-11-22T13:19:46.950 INFO InputProcess::MainThread -> Validating service input config 2023-11-22T13:19:46.954 INFO InputProcess::MainThread -> Running overriding rules 2023-11-22T13:19:46.954 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2023-11-22T13:19:46.960 INFO InputProcess::MainThread -> Adding raw config to the collector store 2023-11-22T13:19:46.961 INFO InputProcess::MainThread -> Running custom validation rules 2023-11-22T13:19:46.965 INFO InputProcess::MainThread -> Creating API client. 2023-11-22T13:19:46.966 INFO InputProcess::MainThread -> Created request client: 2023-11-22T13:19:46.966 INFO InputProcess::MainThread -> TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) Finalizing the execution of init_variables() ``` ### 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: ``` 2023-11-22T13:19:50.255 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> Updated persistence 2023-11-22T13:19:50.256 INFO InputProcess::TrellixStatefulPuller(trellix_collector_input,12345,user_activity_search,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1700639388999):Number of requests made: 1; Number of events received: 6; Number of duplicated events filtered out: 0; Number of events generated and sent: 6; Average of events per second: 4.792. 2023-11-22T13:19:50.257 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:49:50.255", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Updated persistence\", \"time\": \"2023-11-22T07:49:50.255969Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T13:19:50.257 INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2023-11-22 07:49:50.256", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"(Partial) Statistics for this pull cycle (@devo_pulling_id=1700639388999):Number of requests made: 1; Number of events received: 6; Number of duplicated events filtered out: 0; Number of events generated and sent: 6; Average of events per second: 4.792.\", \"time\": \"2023-11-22T07:49:50.256323Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"trellix_collector_input\", \"service_name\": \"user_activity_search\", \"module_name\": \"TrellixStatefulPuller\"}"} 2023-11-22T13:19:50.578 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: "4348708848" ``` > ℹ️ 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. | | `Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 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
## Change log | **Release** | **Released on** | **Release type** | **Details** | **Recommendations** | | --- | --- | --- | --- | --- | | `v1.1.0` | 1/8/2024 | [Changed] | ``` * Upgraded the DCSDK to v1.13.1 * Ensure special characters are properly sent to the platform * Changed log level to some messages from info to debug * Changed some wrong log messages * Upgraded some internal dependencies * Changed queue passed to setup instance constructor * Ability to validate collector setup and exit without pulling any data * Ability to store in the persistence the messages that couldn't be sent after the collector stopped * Ability to send messages from the persistence when the collector starts and before the puller begins working * 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 * Change internal queue management for protecting against OOMK * Extracted ModuleThread structure from PullerAbstract * Improve Controlled stop when both processes fails to instantiate * Improve Controlled stop when InputProcess is killed * Fixed error related a ValueError exception not well controlled * Fixed error related with loss of some values in internal messages * Upgraded the docker base image to 1.3.1. * Added support of differen domains. ``` | `Recommended version` | | `v1.0.0` | 11/13/2023 | [NEW FEATURE] | Released the first version of the Trellix ETP collector. | `Recommended version` |