...
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 |
---|
Tabletable | 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:
{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:
Code Block |
---|
{
"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>
}
}
} |
|
where: <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
<FIELDS> list of fields you want to fetch. List of fields used for firewallEventsAdaptive dataset:
Code Block |
---|
- action
- clientAsn
- clientASNDescription
- clientCountryName
- clientIP
- clientIPClass
- clientRefererHost
- clientRefererPath
- clientRefererQuery
- clientRefererScheme
- clientRequestHTTPHost
- clientRequestHTTPMethodName
- clientRequestHTTPProtocol
- clientRequestPath
- clientRequestQuery
- clientRequestScheme
- edgeColoName
- edgeResponseStatus
- kind
- matchIndex
- originResponseStatus
- originatorRayName
- rayName
- ruleId
- source
- userAgent |
|
<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.
| Query for a dataset in a specific zone and timeframe. The only dataset allowed right now by the collector is Firewall Activity Log: firewallEventsAdaptive . 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. The collector also performs a request to check allowed limits for each dataset on service setup: Limits · Cloudflare Analytics docs Info |
---|
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 for more details. |
|
For more information on how the events are parsed, visit our page.
Vendor setup
To configure the Cloudflare Collector Services you need to configure one of the allowed authentication methods:
...
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:
Code Block |
---|
credentials:
api_token: <API_TOKEN>
|
...
Create API token · Cloudflare API docs
...
API Keys
...
Unique to each Cloudflare user and used only for authentication. API keys do not authorize access to accounts or zones.
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:
Code Block |
---|
credentials:
api_key: <API_KEY>
user_email: <USER_EMAIL>
|
...
Get API keys (legacy) · Cloudflare API docs
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
...
...
...
...
API Keys
...
...
...
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Rw ui tabs macronote |
---|
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:
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: Code Block |
---|
credentials:
api_token: <API_TOKEN> |
| Create API token · Cloudflare API docs |
API Keys | Unique to each Cloudflare user and used only for authentication. API keys do not authorize access to accounts or zones. 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: Code Block |
---|
credentials:
api_key: <API_KEY>
user_email: <USER_EMAIL> |
| Get API keys (legacy) · Cloudflare API docs |
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 | | | |
API Keys | | | |
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Rw ui tabs macro |
---|
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. Image RemovedImage Added 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 Typetype | Type | Value Range 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 Typetype | Type | Value Range 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 . | 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 |