---
title: "TAXII collector"
canonical: "https://docs.devo.com/space/latest/342884358/TAXII%20collector"
format: markdown
---
> Macro (toc)
## Overview
Trusted Automated Exchange of Intelligence Information (TAXII™) is an application protocol for exchanging CTI over HTTPS. TAXII defines a RESTful API (a set of services and message exchanges) and a set of requirements for TAXII Clients and Servers.
## Devo collector features
| **Feature** | **Details** |
| --- | --- |
| Allow parallel downloading (`multipod`) | `not allowed` |
| Running environments | - `collector server`
- `on-premise` |
| Populated Devo events | `table` |
| Flattening preprocessing | `no` |
## Data sources
| **Data source** | **Description** | **API endpoint** | **Collector service name** | **Available from release** |
| --- | --- | --- | --- | --- |
| Objects and Manifests | STIX Objects data and metadata of objects | `collection.get_objects()`
`collection.get_manifests()` | `objects_and_manifests` | `v1.0.0` |
For more information on how the events are parsed, [visit our page](https://docs.devo.com/space/latest/94661194/cloud.gcp).
## Flattening preprocessing
| **Data source** | **Collector service** | **Optional** | **Flattening details** |
| --- | --- | --- | --- |
| Objects and Manifests | `objects_and_manifests` | `no` | No flattening |
## Vendor setup
Several vendors offer the TAXII protocol, this guide uses Cyware as an example. You’ll need:
- Access to Cyware TAXII server or any TAXII server with version 2.0 or 2.1
- In order to retrieve the data, we need the discovery URL for the TAXII server and the required credentials.
| **Actions** | **Screenshots** |
| --- | --- |
| Create a Cyware account. | - |
| Click on Cyware threat intel feed from the profile dropdown in the top right. |  |
| Click on **Grant access**. You will see the credentials on the next screen. Save the credentials, as they will be shown only once. |  |
## Minimum configuration required for basic pulling
> ⚠️ **Important**
> ⚠️
> ⚠️ Before using the collector, it is necessary to find out what version of the protocol the TAXII server is using. We are able to pull data from versions 2.1 and 2.0.
> ⚠️
> ⚠️ Some servers are able to offer data using both versions, using different URL. Check that there is a correspondence between the URL and the version of the protocol that the collector expects. 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** |
| --- | --- |
| `discovery_url` | the Discovery URL of the TAXII server |
| `username` | credential username |
| `password` | credential password |
| `taxii_version` | 2.0 or 2.1 |
> ℹ️ See the **Accepted authentication methods** section to verify what settings are required based on the desired authentication method.
## Accepted authentication methods
Depending on how you obtained your credentials, you will have to either fill or delete the following properties on the JSON/YAML credentials configuration block.
| **Authentication method** | **Username** | **Password** |
| --- | --- | --- |
| Username/Password | Required | Required |
## Run the collector
> Macro (rw-ui-tabs-macro)
>
> > Macro (rw-tab)
>
> In the Cloud Collector App, [create a Taxii collector instance](https://docs.devo.com/space/latest/409305131/Catalog#Create-an-instance) using this parameters template, replacing the values enclosed in `< >`.
>
> ```
> {
> "inputs": {
> "taxii_collector": {
> "id": "",
> "enabled": true,
> "requests_per_second": 5,
> "discovery_url": "",
> "taxii_version": "",
> "credentials": {
> "username": "",
> "password": ""
> "global_overrides": {
> "debug": false
> },
> },
> "services": {
> "objects_and_manifests": {
> "request_period_in_seconds": "",
> "historic_date_utc": "",
> "override_enabled_fetch_objects": "",
> "override_enabled_fetch_manifests": "",
> "override_tag_objects": "",
> "override_tag_manifests": "",
> "requests_limits": [
> {
> "period": "",
> "number_of_requests": ""
> }
> ]
> }
> }
> }
> }
> }
> ```
>
> > 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](#).
>
> 
>
> > ⚠️ Replace `` with the proper value.
>
> ### Editing the config.yaml file
>
> ```
> globals:
> debug:
> id:
> name:
> persistence:
> type: filesystem
> config:
> directory_name: state
> outputs:
> devo_1:
> type: devo_platform
> config:
> address:
> port: 443
> type: SSL
> chain:
> cert:
> key:
> inputs:
> taxii_collector:
> id:
> enabled:
> requests_per_second: 5
> discovery_url:
> taxii_version:
> credentials:
> username:
> password:
> services:
> objects_and_manifests:
> request_period_in_seconds:
> historic_date_utc: #yyyy-mm-ddThh:mm:ss.000Z. ex: 2022-09-30T19:03:54.000Z
> override_enabled_fetch_objects: #boolean
> override_enabled_fetch_manifests: #boolean
> override_tag_objects:
> override_tag_manifests:
> requests_limits:
> - period:
> number_of_requests:
> ```
>
> > ℹ️ 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** |
> | --- | --- | --- | --- | --- |
> | `debug_status` | `bool` | Mandatory | false / true | If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning and error logging levels will be printed. |
> | `collector_id` | `int` | Mandatory | Minimum length: 1
Maximum length: 5 | Use this param to give an unique id to this collector. |
> | `collector_name` | `str` | Mandatory | Minimum length: 1
Maximum length: 10 | Use this param to give a valid name to this collector. |
> | `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. |
> | `input_status` | `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. |
> | `discovery_url` | `str` | Mandatory | | Use this param to define the URL used by the collector to pull data using Taxii protocol. |
> | `taxii_version` | `float` | Mandatory | 2.0 or 2.1 | Version of the Taxii protocol that the Taxii-compliant server uses. |
> | `username` | `str` | Mandatory | Minimum length: 1 | Username for the Taxii server |
> | `Password` | `str` | Mandatory | Minimum length: 1 | Password for the Taxii server |
> | `request_period_in_seconds_value` | `int` | Optional | Minimum length: 1 | Period in seconds used between each data pulling, this value will overwrite the default value (600 seconds) |
> | `historic_time_utc` | `str` | Mandatory | UTC with format: YYYY-mm-ddTHH:MM:SS.000Z
> It must be a valid RFC3339 date-format.
> Ex:- 2024-02-28T01:09:12.000Z | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events. |
> | `override_enabled_fetch_objects` | `bool` | Optional | true/false | If true, object data is pulled from the server. If it is set as false, object data will not be pulled |
> | `override_enabled_fetch_manifests` | `bool` | Optional | true/false | If true, manifest data is pulled from the server. If it is set as false, manifest data will not be pulled |
> | `override_tag_objects` | `str` | Optional | Valid Devo tag | devo tag for objects. Default value: `my.app.taxii.objects` |
> | `override_tag_manifests` | `str` | Optional | Valid Devo tag | devo tag for manifests. Default value: `my.app.taxii.manifest` |
>
> ### 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-taxii_if-docker-image-1.1.0.tgz](https://drive.google.com/file/d/1RADNcZ7hL_cwQ9O0A-xquvAvHkbe_OMB/view?usp=sharing) | `7920f7e36ed8f3b69469c622fa27206aee20832d01d2badedf67337330dbeb59` |
>
> 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.
### Events service
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:
```
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:
> ℹ️ Note that the `PrePull` action is executed only one time before the first run of the `Pull` action.
```
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Pull Started
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Total number of collections: 41
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Polling for collection id: 1ae57e3d-810c-450c-a97f-eb60b63c896c
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Fetching objects data for collection 1ae57e3d-810c-450c-a97f-eb60b63c896c
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Fetched 0 objects for collection 1ae57e3d-810c-450c-a97f-eb60b63c896c
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Polling for collection id: 694bc05f-9568-4738-ac66-7c3fb119ff75
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Fetching objects data for collection 694bc05f-9568-4738-ac66-7c3fb119ff75
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Fetched 0 objects for collection 694bc05f-9568-4738-ac66-7c3fb119ff75
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Polling for collection id: 8eafbfb4-6213-4ff8-9de4-978aa5fdc59f
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Fetching manifests data for collection 8eafbfb4-6213-4ff8-9de4-978aa5fdc59f
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Fetched 30 manifests for collection 8eafbfb4-6213-4ff8-9de4-978aa5fdc59f
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> sent 30 manifests to Devo for collection id 8eafbfb4-6213-4ff8-9de4-978aa5fdc59f
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1669727732252):Number of requests made: 41; Number of events received: 30; Number of duplicated events filtered out: 30; Number of events generated and sent: 0; Average of events per second: 0.000.
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> The data is up to date!
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Data collection completed. Elapsed time: 29.370 seconds. Waiting for 1170.630 second(s)
```
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
```
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1669727732252):Number of requests made: 41; Number of events received: 30; Number of duplicated events filtered out: 30; Number of events generated and sent: 0; Average of events per second: 0.000.
INFO InputProcess::TaxiiPuller(taxii_collector,12345,objects_and_manifests,predefined) -> The data is up to date!
```
> ℹ️ 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 `historical_date_utc` 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** |
| --- | --- | --- | --- | --- |
| InitVariableError | 1 | Invalid value is provided for the historic_date. | historic_date_utc is mentioned in the wrong date time format. | Write the historic_date_utc in correct format
For. ex. 2022-11-15T14:32:33Z |
| InitVariableError | 2 | Time format for historic date must be "%Y-%m-%dT%H:%M:%SZ" | historic_date_utc is mentioned in the wrong date time format. | Write the historic_date_utc in correct format
For. ex. 2022-11-15T14:32:33Z |
| InitVariableError | 3 | historic datetime cannot be greater than the present UTC time | The historic datetime mentioned is of the future. | The value of historic datetime should always be lesser than current datetime |
| SetupError | 100 | The remote data is not pullable with the given credentials. Check the error traces for details | The user credentials that are used in the config does not have permissionto fetch logs | Give the user permission to access the logs. |
| PullError | 301 | The username or the password provided in the config.yaml is incorrect | The username or the password provided in the config.yaml is incorrect | Recheck the values that are provided in the config file |
| PullError | 302 | The credentials does not have required permissions to fetch data from TAXII server | Credentials does not have required permissions to fetch the data | Check if the user credentials have enough permissions to fetch the data |
| PullError | 303 | The Discovery URL provided in the config.yaml is incorrect. | The discovery url provided is incorrect | recheck if correct value of discovery url is provided in the config |
| PullError | 304 | Internal server error from TAXII server. | Something went wrong in the server | Try after some time |
## 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-02-14T18:01:36.208 INFO MainProcess::MainThread -> {"production_mode": false, "python_version": "3.8.10 (default, Nov 14 2022, 12:59:47) \n[GCC 9.4.0]", "current_directory": "/home/batman/Downloads/devo-taxii", "exists_config_dir": true, "exists_config_internal_dir": true, "exists_certs_dir": true, "exists_credentials_dir": true}
2023-02-14T18:01:36.208 INFO MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config.yaml", "job_config_loc": null, "collector_config_loc": null}
2023-02-14T18:01:36.208 INFO MainProcess::MainThread -> Using the default location for "job_config_loc" file: "/etc/devo/job/job_config.json"
2023-02-14T18:01:36.209 INFO MainProcess::MainThread -> "/etc/devo/job" does not exists
2023-02-14T18:01:36.209 INFO MainProcess::MainThread -> Using the default location for "collector_config_loc" file: "/etc/devo/collector/collector_config.json"
2023-02-14T18:01:36.209 INFO MainProcess::MainThread -> "/etc/devo/collector" does not exists
2023-02-14T18:01:36.209 INFO MainProcess::MainThread -> Results of validation of config files parameters: {"config": "/home/batman/Downloads/devo-taxii/config/config.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-02-14T18:01:36.274 INFO MainProcess::MainThread -> {"build_time": "UNKNOWN", "os_info": "Linux-5.15.0-60-generic-x86_64-with-glibc2.29", "collector_name": "taxii_collector", "collector_version": "5.1.3", "collector_owner": "integrations_factory@devo.com", "started_at": "2023-02-14T12:31:36.266420Z"}
2023-02-14T18:01:36.393 INFO MainProcess::MainThread -> [OUTPUT] OutputMultiprocessingController::__init__ Configuration -> {'devo_eu_1': {'type': 'devo_platform', 'config': {'address': 'collector-eu.devo.io', 'port': 443, 'type': 'SSL', 'chain': 'chain.crt', 'cert': 'al_sandbox.crt', 'key': 'al_sandbox.key', 'concurrent_connections': 1, 'period_sender_stats_in_seconds': 300, 'activate_final_queue': False, 'threshold_for_using_gzip_in_transport_layer': 1.1, 'compression_level': 6, 'compression_buffer_in_bytes': 51200, 'generate_metrics': False}}}
2023-02-14T18:01:36.397 INFO MainProcess::MainThread -> OutputProcess - Starting thread (executing_period=60s)
2023-02-14T18:01:36.404 INFO MainProcess::MainThread -> InputProcess - Starting thread (executing_period=60s)
2023-02-14T18:01:36.540 INFO InputProcess::MainThread -> Process Started
```
### 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-02-14T18:06:36.716 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_eu_1) -> This sender has not been used for 251.674918 seconds, it will be closed and destroyed
2023-02-14T18:06:36.718 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_eu_1) -> Number of available senders: 1, sender manager internal queue size: 0
2023-02-14T18:06:36.720 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_eu_1) -> enqueued_elapsed_times_in_seconds_stats: {}
2023-02-14T18:06:36.720 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_eu_1) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False}
2023-02-14T18:06:36.721 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_eu_1) -> Lookup - Total number of messages sent: 0, messages sent since "2023-02-14 12:31:36.627452+00:00": 0 (elapsed 0.000 seconds)
2023-02-14T18:06:36.722 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_eu_1) -> Number of available senders: 1, sender manager internal queue size: 0
2023-02-14T18:06:36.723 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_eu_1) -> enqueued_elapsed_times_in_seconds_stats: {}
2023-02-14T18:06:36.724 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_eu_1) -> Sender: DevoSender(standard_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False}
2023-02-14T18:06:36.724 INFO OutputProcess::DevoSenderManagerMonitor(standard_senders,devo_eu_1) -> Standard - Total number of messages sent: 8203, messages sent since "2023-02-14 12:31:36.589274+00:00": 8203 (elapsed 15.468 seconds)
2023-02-14T18:06:36.733 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_eu_1) -> Number of available senders: 1, sender manager internal queue size: 0
2023-02-14T18:06:36.734 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_eu_1) -> enqueued_elapsed_times_in_seconds_stats: {}
2023-02-14T18:06:36.734 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_eu_1) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
2023-02-14T18:06:36.735 INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_eu_1) -> Internal - Total number of messages sent: 56, messages sent since "2023-02-14 12:31:36.678120+00:00": 56 (elapsed 0.389 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. |
| `Total number of messages sent: 56, messages sent since "2023-02-14 12:31:36.678120+00:00": 56 (elapsed 0.389 seconds)` | Displays the number of events from the last time and following the given example, the following conclusions can be obtained:
- 56 events were sent to Devo since the collector started.
- The last checkpoint timestamp was 2023-02-14 12:31:36.678120+00:00.
- 56 events where sent to Devo between the last UTC checkpoint and now.
- Those 56 events required 0.389 seconds to be delivered. |
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-02-14T18:02:36.834 INFO InputProcess::MainThread -> [GC] global: 45.9% -> 45.9%, process: RSS(56.27MiB -> 56.27MiB), VMS(791.46MiB -> 791.46MiB)
2023-02-14T18:02:36.834 INFO OutputProcess::MainThread -> [GC] global: 45.9% -> 45.9%, process: RSS(50.07MiB -> 50.07MiB), VMS(1.19GiB -> 1.19GiB)
```
## Change log
| **Release** | **Released on** | **Release type** | **Details** | **Recommendations** |
| --- | --- | --- | --- | --- |
| `v1.1.0` | 4/15/2024 | [iMPROVEMENTS]
[bug fixes] | **Upgraded DCSDK from 1.8.0 to 1.11.1:**
- Refactored Collector Definitions to include metadata and some service specific json schemas
- Refactored Base puller to find the right collector variables
- Refactored the abstract methods, removing unused ones and updating old ones to match Template1 puller
- 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
- 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
**Bug Fixes**
- Fix the issue with Historic time utc which was causing error in API calls | `Recommended version` |
| `v1.0.0` | 6/22/2023 | [NEW FEATURE] **NEW FEATURE** | `-` | `Initial release` |