---
title: "Thinkst Canary collector"
canonical: "https://docs.devo.com/space/latest/365887496/Thinkst%20Canary%20collector"
format: markdown
---
> Macro (toc)

## Overview

Thinkst Canary detects security breaches. Users can order, configure, and deploy their Canary Tokens throughout their network. Canary tokens are a powerful tool to help you detect attackers on your devices (“birds”). There can be virtual, hardware, or cloud-based tokens. With the ability to order, configure, and deploy your tokens throughout your network, you can create realistic simulations of Windows file servers, routers, and Linux webservers. 

These Canary tokens run in the background, waiting for intruders to engage with them. Once an attacker encounters a Canary token, the services on offer are designed to solicit further investigation, which in turn triggers an alert to notify you of the incident. In short, Canary tokens can help you detect attackers before they cause serious damage to your network.

## Devo collector features

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

## Data sources

| **Data source** | **Description** | **API endpoint** | **Collector service name** | **Devo table** | **Available from release** |
| --- | --- | --- | --- | --- | --- |
| Incidents | Fetch all the incidents. | `/incidents` | `incidents` | `ids.thinkst_canary.canary.incident` | `v1.0` |
| Birds | Fetch a snapshot of current birds available. | `/devices/all` | `birds` | `ids.thinkst_canary.canary.bird` | `v1.0` |
| Audit trail log | Fetches all the audit logs. | `audit_trail/fetch` | `audit_trail_log` | `ids.thinkst_canary.canary.audit_trail` | `v1.0` |
| Tokens | Fetches a snapshot of current canary tokens available. | `canarytokens/paginate` | `tokens` | `ids.thinkst_canary.canary.token` | `v1.0` |

For more information on how the events are parsed, [visit our page](/wiki/spaces/latest/pages/365756464).

## Vendor setup

In order to follow this guide, you must have a Thinkst Canary account and access to your web console:

1. Log in to the Thinkst Canary console.
2. Click on the gear icon (top-right corner) and then **Global settings**.
3. Click on **API** and make sure the **Enabled** toggle is active.
4. Locate your Domain Hash and Auth Token and copy them.

Learn more in the <u>[official guide](https://help.canary.tools/hc/en-gb/articles/360012727537-How-does-the-API-work-)</u>.

## 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` | You domain’s API URL (format: `https://{domain_hash}.canary.tools/api/v1`). |
| `auth_token` | The token obtained from your Thinkst Canary’s console for authentication. |

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

## Accepted authentication methods

|  |  |
| --- | --- |
| **Authentication method** | **Token** |
| `Auth token` | 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 (<u>Cloud collector</u>), or deploy and host the collector in your own machine using a Docker image (<u>On-premise collector</u>).

> 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:
> 
> ```
> <any_directory>
> └── devo-collectors/
>     └── <product_name>/
>         ├── certs/
>         │   ├── chain.crt
>         │   ├── <your_domain>.key
>         │   └── <your_domain>.crt
>         ├── state/
>         └── config/ 
>             └── config.yaml 
> ```
> 
> > ⚠️ Replace `<product_name>` 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 `<product_name>/certs/`. Learn more about security credentials in Devo [here](#).
> 
> ![image](media://8a5de273-a128-46ae-9ab8-edf77b1c0d87)
> 
> > ⚠️ Replace `<product_name>` with the proper value.
> 
> ### Editing the config.yaml file
> 
> ```
> globals:
>   debug: <debug_value>
>   id: not_used
>   name: thinkst_canary_collector
>   persistence:
>     type: filesystem
>     config:
>       directory_name: state
> outputs:
>   devo_1:
>     type: devo_platform
>     config:
>       address: collector-<region>.devo.io
>       port: 443
>       type: SSL
>       chain: <some_chain.crt>
>       cert: <some_certificate.crt>
>       key: <some_key.key>
>   console_1:
>     type: console
> inputs:
>   thinkst:
>     id: <input_id>
>     enabled: true
>     base_url: <base_url_value>
>     credentials:
>       auth_token: <auth_token_value>
>     services:
>       birds:
>         override_tag: <override_tag_value>
>         request_limits:
>           - period: <period_value>
>             number_of_requests: <number_of_requests_value>
>         request_period_in_seconds: <request_period_in_seconds_value>
>       audit_trail_log:
>         date_from: <date_from_value>
>         override_limit: <override_limit_value>
>         override_tag: <override_tag_value>
>         request_limits:
>           - period: <period_value>
>             number_of_requests: <number_of_requests_value>
>         request_period_in_seconds: <request_period_in_seconds_value>
>       incidents:
>         datetime_from: <datetime_from_value>
>         override_limit: <override_limit_value>
>         override_tag: <override_tag_value>
>         request_limits:
>           - period: <period_value>
>             number_of_requests: <number_of_requests_value>
>         request_period_in_seconds: <request_period_in_seconds_value>
>       tokens:
>         override_limit: <override_limit_value>
>         override_tag: <override_tag_value>
>         request_limits:
>           - period: <period_value>
>             number_of_requests: <number_of_requests_value>
>         request_period_in_seconds: <request_period_in_seconds_value>
> ```
> 
> > ℹ️ 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** | **Details** |
> | `input_id` | `str` | Mandatory | Minimum length: 1<br>Maximum length: 5 | Use this parameter to give a unique ID to this input service.<br>> ⚠️ This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision. |
> | `base_url_value` | `str` | Mandatory | Minimum length: 1<br>Format: `https://{domain_hash}.canary.tools/api/v1` | Your domain’s API URL. |
> | `auth_token` | `str` | Mandatory | Minimum length: 1 | The token obtained from your Thinkst Canary’s console. |
> | `date_from_value` | `str` | Mandatory | Format: YYYY-MM-DD<br>Future dates not allowed | The starting date from which the audit logs are fetched. |
> | `datetime_from_value` | `str` | Mandatory | Format: YYYY-MM-DD mm:hh:ss UTC+000<br>Future dates not allowed | The starting datetime (timezone-aware) from which the incidents are filtered out in the first execution. |
> | `number_of_requests_value` | `int` | Optional | Minimum value: 1 | For each request limitter, this parameter indicates the maximum amount of requests allowed in the period_value period.<br>> ℹ️ This parameter can be removed or commented. |
> | `period_value` | `str` | Optional | A period expression: 30m, 1h, 12h, 1d… | For each request limitter, this parameter indicates the period in which the number_of_requests_value number is accumulated until it reaches the specified maximum value.<br>> ℹ️ This parameter can be removed or commented. |
> | `request_period_in_seconds_value` | `int` | Optional | Minimum value:<br>1. 1 for audit and incidents services.
> 2. 3600 for birds and tokens services.<br>Maximum value: 604800. | Period in seconds used between each data pulling. This value will overwrite the default value (300 seconds).<br>> ℹ️ This parameter can be removed or commented. |
> 
> ### 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-thinkst_canary_collector_if-docker-image-1.2.0](https://drive.google.com/file/d/13qOb78sm1EHAqcFhgZ4sL6-vRfiubLZ2/view?usp=drive_link) | `154b8c5b60e397b7b801c7f1063f5fd3810e5c19e8860951687b12317a8ae981` |
> 
> Use the following command to add the Docker image to the system:
> 
> ```
> gunzip -c <image_file>-<version>.tgz | docker load
> ```
> 
> > ⚠️ Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `<image_file>` and `<version>` with a proper value.
> 
> The Docker image can be deployed on the following services:
> 
> #### Docker
> 
> Execute the following command on the root directory `<any_directory>/devo-collectors/<product_name>/`
> 
> ```
> docker run 
> --name collector-<product_name> 
> --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 
> <image_name>:<version>
> ```
> 
> > ⚠️ Replace `<product_name>`, `<image_name>` and `<version>` 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 `<any_directory>/devo-collectors/<product_name>/` directory.
> 
> ```
> version: '3'
> services:
>   collector-<product_name>:
>     image: <image_name>:${IMAGE_VERSION:-latest}
>     container_name: collector-<product_name>
>     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 `<any_directory>/devo-collectors/<product_name>/` directory:
> 
> ```
> IMAGE_VERSION=<version> docker-compose up -d
> ```
> 
> > ⚠️ Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

## Collector services detail

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

### Events service

<details>
<summary>Verify data collection</summary>

#### Internal services’ implementation

In the table below we can see an overview of how each service was implemented:

|  |  |
| --- | --- |
| **Service name** | **Implementation details** |
| `birds` | This service obtains the full list of birds (devices) and sends all the retrieved events in Devo in a “snapshot” fashion. This is the reason we limit the maximum frequency of this service to at least one hour. |
| `audit_trail_log` | This service uses an endpoint that allows filtering by the start and end date (up to the day), but it does not offer a sorting mechanism. To circumvent this limitation and send all the events in an ordered fashion, we do the following:<br>1. Establish a range of days between the date_from parameter and the day before the current one to chonologically fetch the logs day by day.
  1. All the logs from one single day are sorted before these are sent to Devo.
  2. We keep track of the last “visited day” whose logs were fetched and sent.
2. We obtain the logs for the current day, filtering out those that were already obtained.
  1. We keep track of the last fetched and sent log to only send consequent ones.
  2. Once the day finishes, it will be treated as in the previous step. |
| `incidents` | The endpoint that this service uses, instead of allowing to filter by dates, uses a numeric ID that facilitates following the sequence of events ingested. The service starts from the beginning of the sequence until the last updated ID (included in every response). During the first pulling execution, however, we filter out those events that are previous to the `datetime_from` (timezone-aware) parameter. |
| `tokens` | This service obtains a paginated list of tokens and sends all the retrieved events in Devo in a “snapshot” fashion. This is the reason we limit the maximum frequency of this service to at least one hour. |

#### Setup output

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

```
INFO MainThread -> [SETUP] ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Puller Setup Started
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> We do not have a token. Getting a new one from the server.
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Attempting to get OAuth2 token from ThreatQuotient server....
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Attempting to get from client_id ThreatQuotient server....
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Successfully received a client_id token from (...)/assets/js/config.js
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Successfully received JWT token from (...) which expires in 3599 seconds
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Puller Setup Terminated
INFO ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Setup for module "ThreatQuotientDataPuller" has been successfully executed
```

#### Puller output

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

```
2023-08-03T11:01:04.307 WARNING InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Waiting until setup will be executed
2023-08-03T11:01:06.318    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) Starting the execution of pre_pull()
2023-08-03T11:01:06.319    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Reading persisted data
2023-08-03T11:01:06.324    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Data retrieved from the persistence: None
2023-08-03T11:01:06.324 WARNING InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Persistence will be overridden due to the retrieved state is empty
2023-08-03T11:01:06.325    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Running the persistence upgrade steps
2023-08-03T11:01:06.325    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Running the persistence corrections steps
2023-08-03T11:01:06.325    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Running the persistence corrections steps
2023-08-03T11:01:06.326 WARNING InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'max_updated_id': 0, 'max_time': None, 'datetime_from_config': '2023-04-01 12:00:00 UTC+0000'}
2023-08-03T11:01:06.332    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Updating the persistence
2023-08-03T11:01:06.335 WARNING InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Persistence has been updated successfully
2023-08-03T11:01:06.335    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) Finalizing the execution of pre_pull()
2023-08-03T11:01:06.336    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Starting data collection every 60 seconds
2023-08-03T11:01:06.337    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Pull Started
2023-08-03T11:01:10.055    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1691053266318):Number of requests made: 1; Number of events received: 50; Number of duplicated events filtered out: 37; Number of events generated and sent: 13; Average of events per second: 3.497.
2023-08-03T11:01:24.968    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1691053266318):Number of requests made: 2; Number of events received: 100; Number of duplicated events filtered out: 87; Number of events generated and sent: 13; Average of events per second: 0.698.
2023-08-03T11:01:25.531    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1691053266318):Number of requests made: 3; Number of events received: 105; Number of duplicated events filtered out: 92; Number of events generated and sent: 13; Average of events per second: 0.677.
2023-08-03T11:01:25.533    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1691053266318):Number of requests made: 3; Number of events received: 105; Number of duplicated events filtered out: 92; Number of events generated and sent: 13; Average of events per second: 0.677.
2023-08-03T11:01:25.534    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1691053266318):Number of requests made: 3; Number of events received: 105; Number of duplicated events filtered out: 92; Number of events generated and sent: 13; Average of events per second: 0.677.
2023-08-03T11:01:25.534    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> The data is up to date!
2023-08-03T11:01:25.535    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Data collection completed. Elapsed time: 19.217 seconds. Waiting for 40.783 second(s) until the next one
2023-08-03T11:02:06.322    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Pull Started
2023-08-03T11:02:06.551    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1691053326321):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
2023-08-03T11:02:06.558    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1691053326321):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
2023-08-03T11:02:06.560    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1691053326321):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
2023-08-03T11:02:06.561    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> The data is up to date!
2023-08-03T11:02:06.561    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) -> Data collection completed. Elapsed time: 0.240 seconds. Waiting for 59.760 second(s) until the next one
```

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

```
2023-03-30T16:36:45.759    INFO InputProcess::ThinkstCanaryIncidentPuller(thinkst,12345,incidents_puller,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1680174320435):Number of requests made: 2; Number of events received: 91; Number of duplicated events filtered out: 0; Number of events generated and sent: 91; Average of events per second: 1.067.
```
</details>

<details>
<summary>Restart the persistence</summary>

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 `date_from`/`datetime_from` 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. Note that this persistence reset only works for the `audit_trail_log` and `incidents` services (`birds` and `tokens` are "snapshot" services, without state).
</details>

<details>
<summary>Troubleshooting</summary>

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** |
| InitVariableError | 10 | Ping endpoint not found in module globals in collector_definitons.yaml | There is an internal error with the collector. | Please, contact Devo support. |
| InitVariableError | 11 | datetime_format not found in module globals for service: {service_name} | There is an internal error with the collector. | Please, contact Devo support. |
| InitVariableError | 12 | Start date from config: {start_date} is greater than current date for service: {service_name} | The value provided in date_from/datetime_from parameters is a future date. | Please provide a date/datetime that is before the current date. Note that the datetime_from parameter in the incidents service is timezone-aware. |
| InitVariableError | 13 | date_format not found in module globals for service: {self.service_name} | There is an internal error with the collector. | Please, contact Devo support. |
| PullError | 308 | Auth token expired. Confirm from Thinkst Canary that the token is still valid. | Auth token expired. Confirm from Thinkst Canary that the token is still valid. | Login to canary console and confirm if you are using the correct auth token. |
| PullError | 311, 312, 313, 320, 321 | <Error Message will be received from Thinkst> |  | Follow the instructions in the error message |
</details>

## Collector operations

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

<details>
<summary>Verify collector operations</summary>

### 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-01-10T15:22:57.146    INFO MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config-josemi-test-local.yaml", "job_config_loc": null, "collector_config_loc": null}
2023-01-10T15:22:57.146    INFO MainProcess::MainThread -> Using the default location for "job_config_loc" file: "/etc/devo/job/job_config.json"
2023-01-10T15:22:57.147    INFO MainProcess::MainThread -> "\etc\devo\job" does not exists
2023-01-10T15:22:57.147    INFO MainProcess::MainThread -> Using the default location for "collector_config_loc" file: "/etc/devo/collector/collector_config.json"
2023-01-10T15:22:57.148    INFO MainProcess::MainThread -> "\etc\devo\collector" does not exists
2023-01-10T15:22:57.148    INFO MainProcess::MainThread -> Results of validation of config files parameters: {"config": "C:\git\collectors2\devo-collector-trend-micro-vision-one\config\config-josemi-test-local.yaml", "config_validated": True, "job_config_loc": "/etc/devo/job/job_config.json", "job_config_loc_default": True, "job_config_loc_validated": False, "collector_config_loc": "/etc/devo/collector/collector_config.json", "collector_config_loc_default": True, "collector_config_loc_validated": False}
2023-01-10T15:22:57.171 WARNING MainProcess::MainThread -> [WARNING] Illegal global setting has been ignored -> multiprocessing: False
```

### 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-01-10T15:23:00.788    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2023-01-10T15:23:00.789    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2023-01-10T15:23:00.790    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2023-01-10T15:23:00.842    INFO OutputProcess::MainThread -> global_status: {"output_process": {"process_id": 18804, "process_status": "running", "thread_counter": 21, "thread_names": ["MainThread", "pydevd.Writer", "pydevd.Reader", "pydevd.CommandThread", "pydevd.CheckAliveThread", "DevoSender(standard_senders,devo_sender_0)", "DevoSenderManagerMonitor(standard_senders,devo_1)", "DevoSenderManager(standard_senders,manager,devo_1)", "OutputStandardConsumer(standard_senders_consumer_0)", 
```

> ℹ️ 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. |
| `Standard - Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": 0 (elapsed 0.000 seconds` | Displays the number of events from the last time and following the given example, the following conclusions can be obtained:<br>- 44 events were sent to Devo since the collector started.
- The last checkpoint timestamp was `2023-01-10 16:09:16.116750+00:00`.
- 21 events where sent to Devo between the last UTC checkpoint and now.
- Those 21 events required `0.007 seconds` to be delivered. |
</details>

<details>
<summary>Check memory usage</summary>

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
</details>

## Change log

| **Release** | **Released on** | **Release type** | **Recommendations** |
| --- | --- | --- | --- |
| `v1.2.0` | 9/25/2024 | [BUG FIX]  
[IMPROVEMENTS] | `Recommended version` |
|  |
| `v1.1.0` | 2/2/2024 | [BUG FIX]  
[IMPROVEMENTS] | `Upgrade` |
|  |
| `v1.0.0` | 8/8/2023 | [INITIAL RELEASE] | `Initial version` |
|  |