Page Comparison

...

Rw ui tabs macro

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.

Structure

The 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 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.

Note
Replace `<product_name>` with the proper value.

Editing the config.yaml file

Code Block

globals:
  debug: <debug_status>
  id: <collector_id>
  name: <collector_name>
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_us_1:
    type: devo_platform
    config:
      address: <devo_address>
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename>
inputs:
  onetrust:
    id: <input_id>
    enabled: <input_status>
    requests_per_second: <requests_per_second_value>
    credentials:
      client_id: <client_id>
      client_secret: <client_secret>
    commons:
      domain: <domain>
      add_user_details: <add_user_details>
    services:
      login_history:
        tag: <tag>>
        add_user_details: <add_user_details_boolean>
        initial_start_time_in_utc: <initial_start_time_in_utc>
      profile_activity:
        tag: <tag>
        initial_start_time_in_utc: <initial_start_time_in_utc>

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

YMMDD

Use this param to give a unique id to this input service.

Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.

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.

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.

client_id

str

Mandatory

Minimum length: 1

The OneTrust client ID.

client_secret

str

Mandatory

Minimum length: 1

The OneTrust client secret.

domain

str

Mandatory

Minimum length: 1

The OneTrust domain, as app-apac.onetrust.com

requests_per_second_value

int

Optional

Minimum length: 1

Maximun number of request to the API per second.

This parameter can be removed or commented.

initial_start_time_in_utc

str

Optional

UTC with format: YYYY-mm-ddTHH:MM:SS.sssZ

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.

This parameter can be removed or commented.

tag

str

Optional

Minimum length: 1

Allows the user to override default service tag value.

This parameter can be removed or commented.

add_user_details_boolean

bool

Optional

false / true

Enrich the login_history data with additional information about the user that logged into the system.

This parameter can be removed or commented. The default value is false, so add the value true if actually you want the data enriched.

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-onetrust_collector_if-docker-image-1.2.0	`5225ce146e574b472ad5dcbef6639b405cb79a793baca594a6a5f211922a981b`

Use the following command to add the Docker image to the system:

Code Block
gunzip -c <image_file>-<version>.tgz \| docker load

Note
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>/

Code Block

docker run 
--name collector-<product_name> 
--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 
<image_name>:<version>

Note
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.

Code Block

version: '3'
services:
  collector-<product_name>:
    image: <image_name>:${IMAGE_VERSION:-latest}
    container_name: collector-<product_name>
    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 <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.

Rw tab

title	Cloud collector

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

{
  "global_overrides": {
    "debug": <debug_status>
  },
  "inputs": {
    "onetrust": {
      "id": "<input_id>",
      "enabled": "<input_status>",
      "requests_per_second": "<requests_per_second_value>",
      "credentials": {
        "client_id": "<client_id>",
        "client_secret": "<client_secret>"
      },
      "commons": {
        "domain": "<domain>",
      },
      "services": {
        "login_history": {
          "add_user_details": "<add_user_details_boolean>",
          "initial_start_time_in_utc": "<initial_start_time_in_utc>"
        },
        "profile_activity": {
          "initial_start_time_in_utc": "<initial_start_time_in_utc>"
        }
      }
    }
  }
}

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
`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.
`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.
`client_id`	`str`	`Mandatory`	Minimum length: 1	The OneTrust client ID.
`client_secret`	`str`	`Mandatory`	Minimum length: 1	The OneTrust client secret.
`domain`	`str`	`Mandatory`	Minimum length: 1	The OneTrust domain, as `app-apac.onetrust.com`
`requests_per_second_value`	`int`	`Optional`	Minimum length: 1	Maximun number of request to the API per second. This parameter can be removed or commented.
`initial_start_time_in_utc`	`str`	`Optional`	UTC with format: `YYYY-mm-ddTHH:MM:SS.sssZ`	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. This parameter can be removed or commented.
`tag`	`str`	`Optional`	Minimum length: 1	Allows the user to override default service tag value. This parameter can be removed or commented.
`add_user_details_boolean`	`bool`	`Optional`	`false` / `true`	Enrich the login_history data with additional information about the user that logged into the system. This parameter can be removed or commented. The default value is `false`, so add the value `true` if actually you want the data enriched.

Image Added

Collector services detail

...

Versions Compared

Old Version 7

New Version Current

Key

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose

Editing the JSON configuration

Collector services detail