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

## Overview

Cloudflare is a **Content Delivery Network** and **DDoS** mitigation cloud service company. It primarily acts as a reverse proxy between a website's visitor and the Cloudflare customer's hosting provider.

## Data sources

| **Data source** | **Description** | **Devo table** | **API endpoint** | **Description** |
| --- | --- | --- | --- | --- |
| Cloudflare | Audit Logs | `cdn.cloudflare.audit.events` | `GET https://api.cloudflare.com/client/v4/{entity_type}/{entity_id}/audit_logs?since={start_date}&before={end_date}Z&page={page_num}&per_page={page_limit}&direction={direction}`, where:<br>- `{entity_type}` is one of the two entity types allowed: `organizations` or `accounts`.
- `{entity_id}` is the account or organization identifier
- `{start_date}` to limit the returned results to logs newer than the specified date with RFC3339 format (`YYYY-MM-DDTHH:mm:ssZ`).
- `{end_date}` to limit the returned results to logs older than the specified date with RFC3339 format (`YYYY-MM-DDTHH:mm:ssZ`).
- `{page_num}` which page of results to return.
- `{page_limit}` how many results to return per page.
- `{direction}` is the direction of the chronological sorting (allowed values are `asc` or `desc` -default). | Get audit logs for an account or an organization, filter by who made the change, which zone was the change was made on, and the timeframe of the change. |
|  | GraphQL Analytics | `cdn.cloudflare.firewall.samples` | `POST https://api.cloudflare.com/client/v4/graphql`, where the body of the request use the following template:<br>```
{
  "query": "query { 
              viewer {
                zones (filter: {zoneTag: $zone_tag}) {
                  <DATASET>(
                    filter: {
                      datetime_geq: $start_date,
                      datetime_lt: $end_date
                    },
                    limit: $limit,
                    orderBy: [datetime_ASC]
                  ) {
                    datetime
                    <FIELDS>
                  }
                }
              }
            }",
  "variables": {
    "zoneTag": "<ZONE_TAG>",
    "filter": {
      "zone_tag": "<ZONE_TAG>",
      "start_date": "<START_DATE>",
      "end_date": "<END_DATE>",
      "limit": <LIMIT>
    }
  }
}
```<br>where:<br>- `<DATASET>` is the dataset (product) name you want to query against a zone. Right now, the only dataset allowed by the collector is for Firewall Activity Log: `firewallEventsAdaptive`. Check the following URL for API available datasets: [Datasets (tables) · Cloudflare Analytics docs](https://developers.cloudflare.com/analytics/graphql-api/features/data-sets/#available-datasets)
- `<FIELDS>` list of fields you want to fetch. List of fields used for `firewallEventsAdaptive` dataset:<br>```
- action
- clientAsn
- clientASNDescription
- clientCountryName
- clientIP
- clientIPClass
- clientRefererHost
- clientRefererPath
- clientRefererQuery
- clientRefererScheme
- clientRequestHTTPHost
- clientRequestHTTPMethodName
- rayName
- clientRequestHTTPProtocol
- clientRequestPath
- clientRequestQuery
- clientRequestScheme
- edgeColoName
- edgeResponseStatus
- kind
- matchIndex
- originResponseStatus
- originatorRayName
- ruleId
- source
- userAgent
- apiGatewayMatchedEndpoint
- apiGatewayMatchedHost
- contentScanHasFailed
- contentScanNumMaliciousObj
- contentScanObjResults
- contentScanNumObj
- contentScanObjSizes
- contentScanObjTypes
- date
- datetime
- datetimeFifteenMinutes
- datetimeFiveMinutes
- datetimeHour
- datetimeMinute
- description
- httpApplicationVersion
- leakedCredentialCheckResult
- ref
- rulesetId
- sampleInterval
- wafAttackScore
- wafAttackScoreClass
- wafMlAttackScore
- wafMlSqliAttackScore
- wafMlXssAttackScore
- wafRceAttackScore
- wafSqliAttackScore
- wafXssAttackScore
- zoneVersion
```<br>- `<ZONE_TAG>` is the zone tag (or zone key/ID).
- `<START_DATE>` is the initial date for the query (inclusive).
- `<END_DATE>` is the final date for the query (exclusive).
- `<LIMIT>` to limit the results.<br>- Note: Earlier there were just 31 fields now we have added 24 fields. So, there are a total of 55 fields available now. | Query for a dataset in a specific zone and timeframe. The only dataset allowed right now by the collector is Firewall Activity Log: `firewallEventsAdaptive`.<br>The collector uses `limit`, `orderBy` and `datetime` filters for pagination. For a timeframe request, is `limit` is not reached no more request are needed. But if limit is reached, collector removes all events with the last `datetime` value from the result and performs a new timeframe request using this last `datetime` as `start_date`and the same `end_date`. As `start_date` is inclusive, all the request removed from the previous request should be returned again. In case all the events returned by the request have the same `datetime` and also the maximum limit per request is reached, the collector will add all the events and use as `start_date` the last `datetime` plus one second. Take into account that this behavior can cause losing events for the requested timeframe.<br>The collector also performs a request to check allowed limits for each dataset on service setup: [Limits · Cloudflare Analytics docs](https://developers.cloudflare.com/analytics/graphql-api/limits/)<br>> ℹ️ In a small number of cases, the analytics provided on the Cloudflare GraphQL Analytics API are based on a **sample** — a subset of the dataset. In these cases, Cloudflare Analytics returns an estimate derived from the sampled value. For example, suppose that during an attack the sampling rate is 10% and 5,000 events are sampled. Cloudflare will estimate 50,000 total events (5,000 × 10) and report this value in Analytics.
> ℹ️ 
> ℹ️ See [Sampling · Cloudflare Analytics docs](https://developers.cloudflare.com/analytics/graphql-api/sampling/) for more details. |

For more information on how the events are parsed, [visit our page](https://docs.devo.com/space/latest/94661234/cloud.cloudflare).

> ⚠️ You need to provide certain additional credentials based on whether you want to ingest Audit Logs or GraphQL Analytics events. 
> ⚠️ 
> ⚠️ For Audit logs, you need to provide the following for each entity:
> ⚠️ 
> ⚠️ `"entity_type": "<ENTITY_TYPE>",
> ⚠️ "entity_name": "<ENTITY_NAME>",
> ⚠️ "entity_id": "<ENTITY_ID>"`
> ⚠️ 
> ⚠️ For GraphQL Analytics, you need to provide us with this for each zone:
> ⚠️ 
> ⚠️ `"zone_name": "<ZONE_NAME>",`  
> ⚠️ `"zone_id": "<ZONE_ID>"`

## Vendor setup

To configure the **Cloudflare Collector Services** you need to configure one of the allowed authentication methods:

- API tokens
- API keys

| **Authentication method** | **Details** | **Configuration properties** | **Link** |
| --- | --- | --- | --- |
| API Tokens | Cloudflare recommends API Tokens as the preferred way to interact with Cloudflare APIs. You can configure the scope of tokens to limit access to account and zone resources, and you can define the Cloudflare APIs to which the token authorizes access. | The following credentials properties are needed:<br>```
credentials:
  api_token: <API_TOKEN>
``` | [Create API token · Cloudflare API docs](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) |
| API Keys | Unique to each Cloudflare user and used only for authentication. API keys do not authorize access to accounts or zones.<br>Use the Global API Key for authentication. Only use the Origin CA Key when you create origin certificates through the API. | The following credentials properties are needed:<br>```
credentials:
  api_key: <API_KEY>
  user_email: <USER_EMAIL>
``` | [Get API keys (legacy) · Cloudflare API docs](https://developers.cloudflare.com/fundamentals/api/get-started/keys/) |

## Accepted authentication methods

Depending on how did you obtain your credentials, you will have to either fill or delete the following properties on the JSON `credentials` configuration block.

| **Authentication method** | `api_token` | `api_key` | `user_email` |
| --- | --- | --- | --- |
| API Tokens | [REQUIRED] |  |  |
| API Keys |  | [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 (<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.
> 
> To enable the collector for a customer:
> 
> 1. In the **Collector Server** **GUI**, access the **domain** in which you want this instance to be created
> 2. Click **Add Collector** and find the one you wish to add.
> 3. In the **Version** field, select the latest value.
> 4. In the **Collector Name** field, set the value you prefer (this name must be unique inside the same Collector Server domain).
> 5. In the sending method select **Direct Send. Direct Send** configuration is optional for collectors that create `Table` events, but mandatory for those that create `Lookups`.
> 6. In the **Parameters** section, establish the **Collector Parameters** as follows below:
> 
> ### Editing the JSON configuration
> 
> ```
> {
>   "global_overrides": {
>     "debug": false
>   },
>   "inputs": {
>     "cloudflare_graphql_analytics": {
>       "id": "<short_unique_id>",
>       "enabled": "<input_status>",
>       "credentials": {
>         "api_token": "<api_token>",
>         "api_key": "<api_key>",
>         "user_email": "<user_email>"
>       },
>       "services": {
>         "cloudflare_firewall_events_adaptive": {
>           "zones": {
>             "zone_1": {
>               "zone_name": "<zone_name>",
>               "zone_id": "<zone_id>",
>               "initial_start_time_in_utc": "<initial_start_time_in_utc>"
>             }
>           }
>         }
>       }
>     },
>     "cloudflare_api": {
>       "id": "<short_unique_id>",
>       "enabled": true,
>       "credentials": {
>         "api_key": "<api_key>",
>         "user_email": "<user_email>",
>         "api_token": "<api_token>"
>       },
>       "services": {
>         "cloudflare_audit": {
>           "entities": {
>             "entity_1": {
>              "entity_type": "<entity_type>",
>               "entity_name": "<entity_name>",
>               "entity_id": "<entity_id>",
>               "initial_start_time_in_utc": "<initial_start_time_in_utc>"
>             }
>           }
>         }
>       }
>     }
>   }
> }
> ```
> 
> > ℹ️ 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.
> 
> Please replace the placeholders with real world values following the description table below:
> 
> | **Parameter** | **Data Type** | **Type** | **Value Range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `short_unique_id` | `int` | `Mandatory` | Minimum length: 5 | Use this param to give a unique id to this input service. |
> | `input_status` | `bool` | `Mandatory` | false / true | If the value is true, the input definition will be executed. If the value is false, the service will be ignored. |
> | `api_token` | `str` | `Mandatory` | Any | API Token generated from the [User Profile 'API Tokens' page](https://dash.cloudflare.com/profile/api-tokens). Required when API Tokens authentication method is used. |
> | `api_key` | `str` | `Mandatory` | Any | API key generated on the "My Account" page. Required when API Keys authentication method is used. |
> | `user_email` | `str` | `Mandatory` | Any | Email address associated with your account |
> | `pulling_delay_in_seconds` | `int` | `Optional` | Minimum value: 0 | Delay time, in seconds, that Cloudflare backend infrastructure takes to collect data. Default value is 0 (no delay). |
> | `override_devo_tag` | `str` | `Optional` | A [Devo tag](https://docs.devo.com/confluence/ndt/latest/devo-parsers/about-devo-tags) | `override_devo_tag` used to send collected data to Devo. If defined, this property overrides default `devo_tag` value defined for each service. |
> | `initial_start_time_in_utc` | `str` | `Optional` | A date with `YYYY-MM-DD HH:mm:ss` format | The initial date to be used when fetching data from the endpoint for the first time. Update this value if you want to reset the collector’s state and perform a new initial fetch from this date for each endpoint.<br>> ⚠️ Updating this value will produce the loss of all persisted state and current pipelines. |
> 
> 
> #### Firewall Adaptative Events service parameters
> 
> Firewall Adaptive Events service can collect events from multiple zones. Each zone must be configured inside `zones` property with any name and entry with the following properties:
> 
> | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `zone_name` | `str` | `Mandatory` | Any | Zone Name |
> | `zone_id` | `str` | `Mandatory` | Any | Zone ID / Tag |
> 
> ### Firewall Adaptive events additional service parameters
> 
> These params are configured outside of the zone property.
> 
> | **Parameter** | **Data Type** | **Type** | **Value Range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `include_all_fields` | `boolean` | `Optional` | true/false | Assigning it true will give you all the fields. By default, it will be `false` and it will return first `31` `fields`. |
> 
> ####   
>   
> Audit events service parameters
> 
> Audit Events service can collect events from multiple accounts and/or organizations. Each account/organization must be configured inside `entities` entry with name and entry with the following properties:
> 
> | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `entity_type` | `str` | `Mandatory` | `organizations` / `accounts` | Entity type. |
> | `entity_name` | `str` | `Mandatory` | Any | Entity name. |
> | `entity_id` | `str` | `Mandatory` | Any | Entity ID. |
> | `limit_per_page` | `int` | `Optional` | Minimum value: `0`<br>Maximun value: `1000` | How many results to return per request page. By default `100`. |
> 
> ###   
> Audit events additional service parameters
> 
> | **Parameter** | **Data Type** | **Type** | **Value Range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `max_page_limit` | `int` | `Optional` | Minimum value: `100`<br>Maximum value: `1000` | It limits the no. pages that can be fetched for an account based on the subscription of the account.  it’s `default` value is `100`. |
> | `include_max_page_limit` | `boolean` | `Optional` | true/false | A parameter to allow the maximum page limitation for an account.  
> For instance, if `max_page_limit` params is 100 and `include_max_page_limit` is false then `max_page_limit` params limitation will not be applicable and it will try to fetch all the pages. It’s `default` value is `true`. If turned `false` it will return all the pages. |
> 
> > 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://0532c856-0c34-4f8a-8886-469f4447a686)
> 
> > ⚠️ Replace `<product_name>` with the proper value.
> 
> ### Editing the config.yaml file
> 
> ```
> globals:
>   debug: false
>   id: not_used
>   name: cloudflare_collector
>   persistence:
>     type: filesystem
>     config:
>       directory_name: state
> 
> outputs:
>   devo_1:
>     type: devo_platform
>     config:
>       address: <devo_address>
>       port: 443
>       type: SSL
>       chain: <chain_filename>.crt
>       cert: <cert_filename>.crt
>       key: <key_filename>.key
> inputs:
>   cloudflare_graphql_analytics:
>     id: <short_unique_id>
>     enabled: <input_status>
>     credentials:
>       api_token: <api_token>
>       api_key: <api_key>
>       user_email: <user_email>
>     services:
>       cloudflare_firewall_events_adaptive:
>         pulling_delay_in_seconds: <pulling_delay_in_seconds> #optional
>         override_devo_tag: <override_devo_tag> #optional
>         include_all_fields: <include_all_fields> #optional
>         request_period_in_seconds: <request_period_in_seconds> #optional
>         zones:
>           zone_1:
>             zone_name: <zone_name>
>             zone_id: <zone_id>
>             initial_start_time_in_utc: <initial_start_time_in_utc> #optional
> 
>   cloudflare_api:
>     id: <short_unique_id>
>     enabled: <input_status>
>     credentials:
>       api_token: <api_token>
>       api_key: <api_key>
>       user_email: <user_email>
>     services:
>       cloudflare_audit:
>         pulling_delay_in_seconds: <pulling_delay_in_seconds> #optional
>         override_devo_tag: <override_devo_tag> #optional
>         include_max_page_limit: <include_max_page_limit> #optional
>         max_page_limit: <max_page_limit> #optional
>         request_period_in_seconds: <request_period_in_seconds> #optional
>         entities:
>           organization_1:
>             entity_type: <entity_type>
>             entity_name: <entity_name>
>             entity_id: <entity_id>
>             limit_per_page: <limit_per_page>  #optional
>             initial_start_time_in_utc: <initial_start_time_in_utc> #optional
> ```
> 
> > ℹ️ 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** |
> | --- | --- | --- | --- | --- |
> | `short_unique_id` | `int` | `Mandatory` | Minimum length: 5 | Use this param to give a unique id to this collector. |
> | `devo_address` | `str` | `Mandatory` | `collector-us.devo.io`  
> `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_status` | `bool` | `Mandatory` | false / true | If the value is true, the input definition will be executed. If the value is false, the service will be ignored. |
> | `api_token` | `str` | `Mandatory` | Any | API Token generated from the [User Profile 'API Tokens' page](https://dash.cloudflare.com/profile/api-tokens). Required when API Tokens authentication method is used. |
> | `api_key` | `str` | `Mandatory` | Any | API key generated on the "My Account" page. Required when API Keys authentication method is used. |
> | `user_email` | `str` | `Mandatory` | Any | Email address associated with your account |
> | `polling_delay_in_seconds` | `int` | `Optional` | Minimum value: 0 | Delay time, in seconds, that Cloudflare backend infrastructure takes to collect data. Default value is 0 (no delay). |
> | `override_devo_tag` | `str` | `Optional` | A [Devo tag](https://docs.devo.com/confluence/ndt/latest/devo-parsers/about-devo-tags) | `override_devo_tag`used to send collected data to Devo. If defined, this property overrides default `devo_tag` value defined for each service. |
> | `initial_start_time_in_utc` | `str` | `Optional` | A date with `YYYY-MM-DD HH:mm:ss` format | The initial date to be used when fetching data from the endpoint for the first time. Update this value if you want to reset the collector’s state and perform a new initial fetch from this date for each endpoint.<br>> ⚠️ Updating this value will produce the loss of all persisted state and current pipelines. |
> 
> #### Firewall Adaptative Events service parameters
> 
> Firewall Adaptive Events service can collect events from multiple zones. Each zone must be configured inside `zones` property with any name and entry with the following properties:
> 
> | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `zone_name` | `str` | `Mandatory` | Any | Zone Name |
> | `zone_id` | `str` | `Mandatory` | Any | Zone ID / Tag |
> 
> ### Firewall Adaptive events additional service parameters
> 
> These params are configured outside of the zone property.
> 
> | **Parameter** | **Data Type** | **Type** | **Value Range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `include_all_fields` | `boolean` | `Optional` | true/false | Assigning it true will give you all the fields. By default, it will be `false` and it will return first `31` `fields`. |
> 
> ####   
>   
> Audit events service parameters
> 
> Audit Events service can collect events from multiple accounts and/or organizations. Each account/organization must be configured inside `entities` entry with name and entry with the following properties:
> 
> | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `entity_type` | `str` | `Mandatory` | `organizations` / `accounts` | Entity type. |
> | `entity_name` | `str` | `Mandatory` | Any | Entity name. |
> | `entity_id` | `str` | `Mandatory` | Any | Entity ID. |
> | `limit_per_page` | `int` | `Optional` | Minimum value: `0`<br>Maximun value: `1000` | How many results to return per request page. By default `100`. |
> 
> ###   
> Audit events additional service parameters
> 
> | **Parameter** | **Data Type** | **Type** | **Value Range / Format** | **Details** |
> | --- | --- | --- | --- | --- |
> | `max_page_limit` | `int` | `Optional` | Minimum value: `100`<br>Maximum value: `1000` | It limits the no. pages that can be fetched for an account based on the subscription of the account.  it’s `default` value is `100`. |
> | `include_max_page_limit` | `boolean` | `Optional` | true/false | A parameter to allow the maximum page limitation for an account.  
> For instance, if `max_page_limit` params is 100 and `include_max_page_limit` is false then `max_page_limit` params limitation will not be applicable and it will try to fetch all the pages. It’s `default` value is `true`. If turned `false` it will return all the pages. |
> 
> ### 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-cloudflare-docker-image-1.3.0.tgz](https://drive.google.com/file/d/1Kidrn_A_7YyCdauxzWDO9R3SJIsUfiei/view?usp=drive_link) | `3b187bfed79a7683b0421e8fca101158f71f7052a1b50a84a5a8efc0798bf83a` |
> 
> 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-cloudflare \
> --userns-remap="root:devo" \
> --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 \
> devo.com/collectors/cloudflare:<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-cloudflare:
>     image: <image_name>:${IMAGE_VERSION:-latest}
>     container_name: collector-cloudflare
>     volumes:
>       - ./certs:/devo-collector/certs
>       - ./config:/devo-collector/config
>       - ./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.


# Change log 

| **Release** | **Released on** | **Release type** | **Details** | **Recommendations** |
| --- | --- | --- | --- | --- |
| `v1.3.0` | 7/14/2025 | [Bug Fixing] | **Bug fix:**<br>- DCSDK Docker base image updated from "1.4.1" to "1.5.1"
- DevoCollectorSDK Python package updated from "1.15.0" to "1.16.3"
- Fix logo | `Recommended Version` |
| `v1.3.0` | 5/12/2025 | [Bug Fixing] | **Bug fix:**<br>- Validation restriction for id to be integer is removed
- API key type is changed to string from integer
- Fixed persistence reset logic | `Update` |
| `v1.2.0` | 5/5/2025 | [IMPROVEMENT] | **Improvements**<br>- The DCSDK Docker base image has been updated from "1.3.1" to "1.4.1"
- The DevoCollectorSDK Python package (devo-collector-sdk) has been updated from "1.12.4" to "1.15.0" | `Update` |
| `v1.1.1` | 9/17/2024 | [Bug Fixing] | **Bug fix:**<br>- Some minor fixes related to the auto-update feature
- Updated the docker base image | `Update` |
| `v1.1.0` | 9/17/2024 | [IMPROVEMENT] | **Improvements:**<br>- Upgraded Docker base image to 1.3.0
- Added a flag to get 100 pages by default for cloudflare_audit input.
- Added another flag to allow to decide if they want limit on number of pages.
- Added flag to include all the fields for cloudflare_graphql_analytics input.
- Refactored the code to the new template
- **Upgraded DCSDk to version 1.24.4**
  - Fixed error related a ValueError exception not well controlled.
  - Fixed error related with loss of some values in internal messages(collector_name, collector_id and job_id)
  - Improve Controlled stop when InputProcess is killed
  - Change internal queue management for protecting against OOMK
  - Extracted ModuleThread structure from PullerAbstract
  - Improve Controlled stop when both processes fails to instantiate
  - Upgrade DevoSDK dependency to version v5.4.0
  - Fixed error in persistence system
  - Applied changes to make DCSDK compatible with MacOS
  - Added new sender for relay in house + TLS
  - Added persistence functionality for gzip sending buffer
  - Added Automatic activation of gzip sending
  - Improved behaviour when persistence fails
  - Upgraded DevoSDK dependency
  - Fixed console log encoding
  - Restructured python classes
  - Improved behaviour with non-utf8 characters
  - Decreased default size value for internal queues (Redis limitation, from 1GiB to 256MiB)
  - New persistence format/structure (compression in some cases)
  - Removed dmsg execution (It was invalid for docker execution)
  - Added extra check for not valid message timestamps
  - Added extra check for improve the controlled stop
  - Changed default number for connection retries (now 7)
  - Fix for Devo connection retries
  - Updated DevoSDK to v5.1.10
  - Fix for SyslogSender related to UTF-8
  - Enhance 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
  - Fixed error in pyproject.toml related to project scripts endpoint
  - Updated DevoSDK to v5.1.7
  - Introduced pyproject.toml
  - Added requirements-dev.txt
  - Added input metrics
  - Modified output metrics
  - Updated DevoSDK to v5.1.6
  - Standardized exception messages for traceability
  - Added more detail in queue statistics | `Update` |