Page Comparison

...

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

{
  "inputs": {
    "cloudflare_graphql_analytics": {
      "id": <ID>,
      │   ├── <your_domain>.key"enabled": <INPUT_STATUS>,
        │   └── <your_domain>.crt"requests_per_second": <REQUESTS_PER_SECONDS>,
      "credentials": {
├── state/         └── config/"api_token": "<API_TOKEN>",
        "api_key": "<API_KEY>",
       └── config.yaml 

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 Removed

Editing the config.yaml file

globals:
  debug: true
  id: <COLLECTOR_ID>
  name: <COLLECTOR_NAME>
  persistence:
    type: filesystem
    config:
 "user_email": "<USER_EMAIL>"
      },
      "services": {
        "cloudflare_firewall_events_adaptive": {
          "pulling_delay_in_seconds": <PULLING_DELAY_OVERRIDE>,
      directory_name: state   multiprocessing"base_tag": <MULTIPROCESSING_MODE>"<BASE_TAG_OVERRIDE>",
  outputs:   devo_1:     type"zones": devo_platform{
    config:       address: <DEVO_ADDRESS>"zone_1": {
      port: 443       type"zone_name": SSL"<ZONE_NAME>",
      chain: <CHAIN_FILENAME>       cert"zone_id": <DOMAIN_FILENAME>"<ZONE_ID>",
        key: <KEY_FILENAME>  inputs:   cloudflare_graphql_analytics:
    id: <ID>"initial_start_time_in_utc": "<YYYY-MM-DD HH:mm:ss>"
         enabled: true  }
  credentials:       api_token: <API_TOKEN> }
      api_key: <API_KEY> }
     user_email: <USER_EMAIL> }
    services:},
      "cloudflare_firewall_events_adaptiveapi": {
       pulling_delay_in_seconds: <PULLING_DELAY_IN_SECONDS>"id": <ID>,
      "enabled": true,
 base_tag: <BASE_TAG>     "credentials": {
          zones:"api_token": "<API_TOKEN>",
          zone"api_1key": "<API_KEY>",
           zone_name: <ZONE_NAME>"user_email": "<USER@EMAIL>"
      },
      zone_id"services": <ZONE_ID>{
        "cloudflare_audit": {
   initial_start_time_in_utc: "<YYYY-MM-DD HH:mm:ss>"       "pulling_delay_in_seconds": <PULLING_DELAY_OVERRIDE>,
     cloudflare_api:     id"base_tag": <ID>"<BASE_TAG_OVERRIDE>",
    enabled: false     credentials"entities": {
     api_token: <API_TOKEN>       api_key: <API_KEY>"entity_1": {
        user_email: <USER_EMAIL>     services"entity_type": "<ENTITY_TYPE>",
     cloudflare_audit:         pulling_delay_in_seconds"entity_name": <PULLING_DELAY_IN_SECONDS>"<ENTITY_NAME>",
         base_tag: <BASE_TAG_OVERRIDE>    "entity_id": "<ENTITY_ID>",
   entities:           organization_1:
"limit_per_page": <LIMIT_PER_PAGE>,
           entity_type: <ENTITY_TYPE>  "initial_start_time_in_utc": "<YYYY-MM-DD HH:mm:ss>"
        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>"}
}

Replace Please replace the placeholders with your required real world values following the description table below:

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

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

Maximun value: 1000

How many results to return per request page. By default 100.

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:

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>

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

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

{
  "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>"
            }
          }
        }
      }
    }
  }
}

Please replace the placeholders with real world values following the description table below:

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 

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 Added

Editing the config.yaml file

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>"

Replace the placeholders with your required values following the description table below:

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:

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:

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:

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>

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