We use a piece of software called Collector Server to host and manage all our available collectors. To enable the collector for a customer: In the Collector Server GUI, access the domain in which you want this instance to be created Click Add Collector and find the one you wish to add. In the Version field, select the latest value. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain). 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 . In the Parameters section, establish the Collector Parameters as follows below:
Editing the JSON configuration Code Block |
---|
{
"inputs": {
"cloudflare_graphql_analytics": {
"id": <ID>,
"enabled": <INPUT_STATUS>,
"requests_per_second": <REQUESTS_PER_SECONDS>,
"credentials": {
"api_token": "<API_TOKEN>",
"api_key": "<API_KEY>",
"user_email": "<USER_EMAIL>"
},
"services": {
"cloudflare_firewall_events_adaptive": {
"pulling_delay_in_seconds": <PULLING_DELAY_OVERRIDE>,
"base_tag": "<BASE_TAG_OVERRIDE>",
"zones": {
"zone_1": {
"zone_name": "<ZONE_NAME>",
"zone_id": "<ZONE_ID>",
"initial_start_time_in_utc": "<YYYY-MM-DD HH:mm:ss>"
}
}
}
}
},
"cloudflare_api": {
"id": <ID>,
"enabled": true,
"credentials": {
"api_token": "<API_TOKEN>",
"api_key": "<API_KEY>",
"user_email": "<USER@EMAIL>"
},
"services": {
"cloudflare_audit": {
"pulling_delay_in_seconds": <PULLING_DELAY_OVERRIDE>,
"base_tag": "<BASE_TAG_OVERRIDE>",
"entities": {
"entity_1": {
"entity_type": "<ENTITY_TYPE>",
"entity_name": "<ENTITY_NAME>",
"entity_id": "<ENTITY_ID>",
"limit_per_page": <LIMIT_PER_PAGE>,
"initial_start_time_in_utc": "<YYYY-MM-DD HH:mm:ss>"
}
}
}
}
}
}
} |
Info |
---|
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 |
---|
input_id
| int
| Mandatory
| Minimum length: 1 Maximum 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. | requests_per_second
| int
| Optional
| Minimum value: 1 | Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec. This parameter can be left blank, removed or commented. | api_token
| str
| Mandatory
| Any | API Token generated from the User Profile 'API Tokens' page. 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). | base_tag
| str
| Optional
| A Devo tag | Base tag used to send collected data to Devo. If defined, this property overrides default base_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. Note |
---|
Updating this value will produce the loss of all persisted state and current pipelines. |
|
Rw tab |
---|
title | On-premise collector |
---|
|
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. StructureThe following directory structure should be created for being used when running the collector: Code Block |
---|
<any_directory>
└── devo-collectors/
└── <product_name>/
├── certs/
│ ├── chain.crt
│ ├── <your_domain>.key
│ └── <your_domain>.crt
├── state/
└── config/
└── config.yaml |
Note |
---|
Replace <product_name> with the proper value. |
Devo credentialsIn 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. Note |
---|
Replace <product_name> with the proper value. |
Editing the config.yaml file Code Block |
---|
globals:
debug: true
id: <COLLECTOR_ID>
name: <COLLECTOR_NAME>
persistence:
type: filesystem
config:
directory_name: state
multiprocessing: <MULTIPROCESSING_MODE>
outputs:
devo_1:
type: devo_platform
config:
address: <DEVO_ADDRESS>
port: 443
type: SSL
chain: <CHAIN_FILENAME>
cert: <DOMAIN_FILENAME>
key: <KEY_FILENAME>
inputs:
cloudflare_graphql_analytics:
id: <ID>
enabled: true
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>
base_tag: <BASE_TAG>
zones:
zone_1:
zone_name: <ZONE_NAME>
zone_id: <ZONE_ID>
initial_start_time_in_utc: "<YYYY-MM-DD HH:mm:ss>"
cloudflare_api:
id: <ID>
enabled: false
credentials:
api_token: <API_TOKEN>
api_key: <API_KEY>
user_email: <USER_EMAIL>
services:
cloudflare_audit:
pulling_delay_in_seconds: <PULLING_DELAY_IN_SECONDS>
base_tag: <BASE_TAG_OVERRIDE>
entities:
organization_1:
entity_type: <ENTITY_TYPE>
entity_name: <ENTITY_NAME>
entity_id: <ENTITY_ID>
limit_per_page: <LIMIT_PER_PAGE>
initial_start_time_in_utc: "<YYYY-MM-DD HH:mm:ss>" |
Info |
---|
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 |
---|
collector_id
| int
| Mandatory
| Minimum length: 1 Maximum length: 5 | Use this param to give a 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. | multiprocessing_mode
| bool
| Mandatory
| false / true | If the value is true, the collector will run using a multiprocessing architecture. If the value is false, the collector will use only one CPU. | 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_id
| int
| Mandatory
| Minimum length: 1 Maximum 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. | requests_per_second
| int
| Optional
| Minimum value: 1 | Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec. Info |
---|
This parameter can be left blank, removed or commented. |
| api_token
| str
| Mandatory
| Any | API Token generated from the User Profile 'API Tokens' page. 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). | base_tag
| str
| Optional
| A Devo tag | Base tag used to send collected data to Devo. If defined, this property overrides default base_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. Note |
---|
Updating this value will produce the loss of all persisted state and current pipelines. |
|
Firewall Adaptative Events service parametersFirewall 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 |
Audit events service parametersAudit 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 Maximun value: 1000 | How many results to return per request page. By default 100 . |
Download the Docker imageThe 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: Use the following command to add the Docker image to the system: Code Block |
---|
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: DockerExecute the following command on the root directory <any_directory>/devo-collectors/<product_name>/ Code Block |
---|
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> |
Note |
---|
Replace <product_name> , <image_name> and <version> with the proper values. |
Docker ComposeThe 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. Code Block |
---|
version: '3'
services:
collector-cloudflare:
image: docker.devo.internal/collector/cloudflare<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: Code Block |
---|
IMAGE_VERSION=<version> docker-compose up -d |
Note |
---|
Replace <product_name> , <image_name> and <version> with the proper values. | 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 and we will guide you through the configuration |