--- title: "Trellix Helix collector" canonical: "https://docs.devo.com/space/latest/425689153/Trellix%20Helix%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** | | --- | --- | --- | --- | --- | --- | | Alerts | Returns all the alerts sorted by updated time for a specified time interval. | `/helix/id/{instance_id}/api/{api_version}/alerts` | `alerts` | `siem.trellix.helix.alerts` | `v1.0.0` | For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/412909602). ## Flattening preprocessing | **Data source** | **Collector service** | **Optional** | **Flattening details** | | --- | --- | --- | --- | | Alerts | alerts | `yes` | 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** | | --- | --- | | `base_url` | The fireeye API base url to get list of alerts for Helix. | | `instance_id` | The id of the Helix instance. | | `api_version` | The version of the API that you want to use. (for example v1). | | `api_key` | The fireeye API api key used for authorization. | > ℹ️ 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** | **Base Url** | | --- | --- | --- | --- | | apiKey | [REQUIRED] | [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://b8f3daae-a7d2-4c57-bff9-1967111c7382) > > > ⚠️ Replace `` with the proper value. > > ### Editing the config.yaml file > > ``` > globals: > debug: false > id: not_used > name: trellix_helix_collector > persistence: > type: filesystem > config: > directory_name: state > > outputs: > devo_1: > type: devo_platform > config: > address: > port: 443 > type: SSL > chain: chain.crt > cert: .crt > key: .key > inputs: > trellix_helix: > id: > enabled: true > credentials: > instance_id: > api_key: > services: > alerts: > initial_start_time_in_utc: > override_tag: > api_version: > requests_limits: > - period: 1d > number_of_requests: 5000 > ``` > > > ℹ️ 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** | > | --- | --- | --- | --- | --- | > | `` | `int` | `Mandatory` | `Minimum Lenght 1`
`Maximum Length 5` | Use this param to give a 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. | > | `` | `bool` | `Mandatory` | `false` / `true` | Use this param to enable or disable the given input logic when running the collector. If the value is `true`, the input will be run. If the value is `false`, it will be ignored. | > | `` | `str` | `Mandatory` | `Minimum Length 1` | Provide the Helix instance value to be used in the API call. | > | `` | `str` | `Mandatory` | `Minimum Length 1` | The apiKey used for authorization during the API call. | > | `` | `str` | `Optional` | `Minimum Length 1` | 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. | > | `` | `str` | `Optional` | A devo tag | This parameter allows to define a custom devo tag. | > | `` | `str` | `Mandatory` | `Minimum Length 1` | The api version to be used. | > > ### 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_helix_if-docker-image-1.0.0](https://drive.google.com/file/d/1RdUL30vYLM0HQy62LIILA4RJ67BdZ6sM/view?usp=drive_link) | `1aee12694ba340f6d519756ad571e1d352cb31fe8718bd682dac454eed40bae0` | > > 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. ### Alerts
Verify data collection Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console. This service has the following components: | **Component** | **Description** | | --- | --- | | Setup | The setup module is in charge of authenticating the service and managing the token expiration when needed. | | Puller | The setup module is in charge of pulling the data in a organized way and delivering the events via SDK. | #### Setup output A successful run has the following output messages for the setup module: ``` 2023-11-10T08:50:40.048 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_2) -> Starting thread 2023-11-10T08:50:40.048 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_2) -> Nothing retrieved from the persistence. 2023-11-10T08:50:40.049 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-10T08:50:40.049 INFO InputProcess::MainThread -> Running overriding rules 2023-11-10T08:50:40.049 INFO InputProcess::MainThread -> Overriding rule #1 - service key with value overrides definition key with value when the first is not 2023-11-10T08:50:40.049 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2023-11-10T08:50:40.050 INFO InputProcess::MainThread -> Adding raw config to the collector store 2023-11-10T08:50:40.050 INFO InputProcess::MainThread -> Running custom validation rules 2023-11-10T08:50:40.051 INFO InputProcess::MainThread -> Creating API client. 2023-11-10T08:50:40.052 INFO InputProcess::MainThread -> Created request client: 2023-11-10T08:50:40.052 INFO InputProcess::MainThread -> TrellixHelixPuller(trellix_helix,12345,alerts,predefined) Finalizing the execution of init_variables() 2023-11-10T08:50:40.052 INFO InputProcess::MainThread -> InputThread(trellix_helix,12345) - Starting thread (execution_period=60s) 2023-11-10T08:50:40.052 INFO InputProcess::MainThread -> ServiceThread(trellix_helix,12345,alerts,predefined) - Starting thread (execution_period=60s) 2023-11-10T08:50:40.053 INFO InputProcess::MainThread -> TrellixHelixPullerSetup(trellix_helix_collector,trellix_helix#12345,alerts#predefined) -> Starting thread 2023-11-10T08:50:40.053 INFO InputProcess::MainThread -> TrellixHelixPuller(trellix_helix,12345,alerts,predefined) - Starting thread 2023-11-10T08:50:40.053 WARNING InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Waiting until setup will be executed 2023-11-10T08:50:40.063 INFO OutputProcess::MainThread -> [GC] global: 39.2% -> 39.2%, process: RSS(42.48MiB -> 43.61MiB), VMS(928.07MiB -> 928.07MiB) 2023-11-10T08:50:40.065 INFO InputProcess::MainThread -> [GC] global: 39.2% -> 39.2%, process: RSS(42.14MiB -> 42.14MiB), VMS(424.04MiB -> 424.04MiB) 2023-11-10T08:50:40.610 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": "/home/nikhilgoyal/devo-collector-trellix-helix/certs/chain.crt", "cert_path": "/home/nikhilgoyal/devo-collector-trellix-helix/certs/int-if-integrations-india.crt", "key_path": "/home/nikhilgoyal/devo-collector-trellix-helix/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-APAC-0050", session_id: "140677399433120" 2023-11-10T08:50:42.127 INFO InputProcess::TrellixHelixPullerSetup(trellix_helix_collector,trellix_helix#12345,alerts#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-10T08:50:43.064 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Pull Started 2023-11-10T08:50:43.064 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieving alerts event(s) having createDate between 2023-08-28T16:40:54.000000Z and 2023-08-28T17:40:54.000000Z 2023-11-10T08:50:59.497 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieved 1000 alerts event(s) 2023-11-10T08:50:59.525 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Updating the persistence 2023-11-10T08:50:59.527 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1699586443056):Number of requests made: 1; Number of events received: 1000; Number of duplicated events filtered out: 0; Number of events generated and sent: 1000; Average of events per second: 60.741. 2023-11-10T08:50:59.528 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieving alerts event(s) having createDate between 2023-08-28T17:40:54.000000Z and 2023-08-28T18:40:54.000000Z 2023-11-10T08:50:59.942 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": "/home/nikhilgoyal/devo-collector-trellix-helix/certs/chain.crt", "cert_path": "/home/nikhilgoyal/devo-collector-trellix-helix/certs/int-if-integrations-india.crt", "key_path": "/home/nikhilgoyal/devo-collector-trellix-helix/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-APAC-0050", session_id: "140677354301904" 2023-11-10T08:51:16.442 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieved 1000 alerts event(s) 2023-11-10T08:51:16.466 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Updating the persistence 2023-11-10T08:51:16.468 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1699586443056):Number of requests made: 2; Number of events received: 2000; Number of duplicated events filtered out: 1; Number of events generated and sent: 1999; Average of events per second: 59.843. 2023-11-10T08:51:16.468 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieving alerts event(s) having createDate between 2023-08-28T18:40:54.000000Z and 2023-08-28T19:40:54.000000Z 2023-11-10T08:51:32.620 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieved 1000 alerts event(s) 2023-11-10T08:51:32.645 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Updating the persistence 2023-11-10T08:51:32.646 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1699586443056):Number of requests made: 3; Number of events received: 3000; Number of duplicated events filtered out: 2; Number of events generated and sent: 2998; Average of events per second: 60.465. 2023-11-10T08:51:32.647 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> Retrieving alerts event(s) having createDate between 2023-08-28T19:40:54.000000Z and 2023-08-28T20:40:54.000000Z ``` After a successful collector’s execution (that is, no error logs found), you will see the following log message: ``` 2023-11-10T08:59:53.632 INFO InputProcess::TrellixHelixPuller(trellix_helix,12345,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1699586443056):Number of requests made: 33; Number of events received: 33000; Number of duplicated events filtered out: 32; Number of events generated and sent: 32968; Average of events per second: 59.880. ``` > ℹ️ 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 `initial_start_time_in_utc_value` 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** | | --- | --- | --- | --- | --- | | SetupError | 100 | `Error occurred while validating api key from the Helix server. Error message: {error}` | The `apiKey` is not valid. | Make sure the `apiKey` is valid to authorise the API call. | | InitVariablesError | 1 | `datetime_format`` is not set in service thread globals` | datetime format is not set. | Make sure the datetime format is set in the module globals. | | 2 | `initial_start_time_in_utc`` is not set as per the ``datetime_format` | 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. | | 3 | `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. | | PullError | 300 | `HTTP Error occurred while retrieving events from Helix server,summary: {HTTPError},details: {HTTPError.response}` | This error happens when the collector tries to fetch the Helix 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. | | | 301 | `Some error occurred while retrieving events from Helix server. Error details: {Exception}` | Some exception occured while making the API request. | 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 The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration. A successful run has the following output messages for the initializer module: ``` 2023-11-10T09:52:53.776 INFO InputProcess::MainThread -> Process Started 2023-11-10T09:52:53.793 INFO InputProcess::MainThread -> TrellixHelixPuller(trellix_helix,12345,alerts,predefined) Starting the execution of init_variables() 2023-11-10T09:52:53.793 INFO InputProcess::MainThread -> Validating service metadata 2023-11-10T09:52:53.795 INFO InputProcess::MainThread -> Validating defined module definition 2023-11-10T09:52:53.796 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread 2023-11-10T09:52:53.796 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_2) -> Starting thread (every 300 seconds) 2023-11-10T09:52:53.796 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_2) -> Starting thread 2023-11-10T09:52:53.797 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_2) -> Nothing retrieved from the persistence. 2023-11-10T09:52:53.797 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2023-11-10T09:52:53.797 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_2) -> Starting thread (every 300 seconds) 2023-11-10T09:52:53.797 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-10T09:52:53.797 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_2) -> Starting thread 2023-11-10T09:52:53.797 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2023-11-10T09:52:53.797 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_2) -> Nothing retrieved from the persistence. 2023-11-10T09:52:53.797 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-10T09:52:53.797 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_2) -> Starting thread (every 300 seconds) 2023-11-10T09:52:53.797 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_2) -> Starting thread 2023-11-10T09:52:53.798 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_2) -> Nothing retrieved from the persistence. 2023-11-10T09:52:53.798 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2023-11-10T09:52:53.798 INFO InputProcess::MainThread -> Validating common input config 2023-11-10T09:52:53.799 INFO InputProcess::MainThread -> Validating service input config 2023-11-10T09:52:53.800 INFO InputProcess::MainThread -> Running overriding rules 2023-11-10T09:52:53.800 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2023-11-10T09:52:53.802 INFO InputProcess::MainThread -> Adding raw config to the collector store 2023-11-10T09:52:53.802 INFO InputProcess::MainThread -> Running custom validation rules 2023-11-10T09:52:53.803 INFO InputProcess::MainThread -> Creating API client. 2023-11-10T09:52:53.804 INFO InputProcess::MainThread -> Created request client: 2023-11-10T09:52:53.804 INFO InputProcess::MainThread -> TrellixHelixPuller(trellix_helix,12345,alerts,predefined) Finalizing the execution of init_variables() 2023-11-10T09:52:53.805 INFO InputProcess::MainThread -> InputThread(trellix_helix,12345) - Starting thread (execution_period=60s) 2023-11-10T09:52:53.805 INFO InputProcess::MainThread -> ServiceThread(trellix_helix,12345,alerts,predefined) - Starting thread (execution_period=60s) 2023-11-10T09:52:53.805 INFO InputProcess::MainThread -> TrellixHelixPullerSetup(trellix_helix_collector,trellix_helix#12345,alerts#predefined) -> Starting thread ``` ### 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-10T09:57:53.797 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_2) -> Number of available senders: 1, sender manager internal queue size: 0 2023-11-10T09:57:53.797 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_2) -> enqueued_elapsed_times_in_seconds_stats: {} 2023-11-10T09:57:53.798 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_2) -> Sender: DevoSender(standard_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True} 2023-11-10T09:57:53.798 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_2) -> Standard - Total number of messages: 16984 messages/bytes sent since "2023-11-10T04:22:53.792175+00:00": 16984/56142456, (elapsed 26.950 seconds) 2023-11-10T09:57:53.798 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_2) -> Number of available senders: 1, sender manager internal queue size: 0 2023-11-10T09:57:53.799 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_2) -> enqueued_elapsed_times_in_seconds_stats: {} 2023-11-10T09:57:53.799 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_2) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False} 2023-11-10T09:57:53.799 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_2) -> Lookup - Total number of messages sent: 0, messages sent since "2023-11-10 04:22:53.794176+00:00": 0 (elapsed 0.000 seconds) 2023-11-10T09:57:53.800 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_2) -> Number of available senders: 1, sender manager internal queue size: 0 2023-11-10T09:57:53.802 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_2) -> enqueued_elapsed_times_in_seconds_stats: {} 2023-11-10T09:57:53.802 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_2) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True} 2023-11-10T09:57:53.802 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_2) -> Internal - Total number of messages: 106 messages/bytes sent since "2023-11-10T04:22:53.795899+00:00": 106/45514, (elapsed 0.566 seconds) ``` > ℹ️ By default, these information traces will be displayed every 10 minutes. #### Sender services The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (`internal`, `standard`, and `lookup`). This collector uses the following Sender Services: | **Sender services** | **Description** | | --- | --- | | `internal_senders` | In charge of delivering internal metrics to Devo such as logging traces or metrics. | | `standard_senders` | In charge of delivering pulled events to Devo. | #### Sender statistics Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type: | **Logging trace** | **Description** | | --- | --- | | `Number of available senders: 1` | Displays the number of concurrent senders available for the given Sender Service. | | `sender manager internal queue size: 0` | Displays the items available in the internal sender queue.
> ℹ️ This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders. | | `Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)` | Displays the number of events from the last time and following the given example, the following conclusions can be obtained:
- 44 events were sent to Devo since the collector started. - The last checkpoint timestamp was `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` ``` 2023-11-10T09:57:53.856 INFO InputProcess::MainThread -> [GC] global: 39.1% -> 39.1%, process: RSS(68.84MiB -> 68.84MiB), VMS(503.30MiB -> 503.30MiB) 2023-11-10T09:58:53.862 INFO OutputProcess::MainThread -> [GC] global: 39.1% -> 39.1%, process: RSS(49.12MiB -> 49.12MiB), VMS(928.57MiB -> 928.57MiB) ``` > ℹ️ 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.0.0` | 11/8/2023 | [initial release] | Released the first version of the Trellix Helix collector. | `Recommended version` |