Content Comparison

...

Rw ui tabs macro

Rw tab

title	Cloud collector

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.

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: false
  id: <collector_id_value>
  name: <collector_name_value>
  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:
  ibm_cloud_activity_tracker:
    id: <input_id_value>
    enabled: true
    environment: <environment_value>
    base_url: <base_url_value>
    credentials:
      service_key: <service_key_value>
    services:
      activity_tracker:
        override_tag: <override_tag_value>
        override_fetch_gap_seconds: <override_fetch_gap_seconds_value>
        start_time_in_utc: <start_time_in_utc_value>
        obfuscation_data: [<obfuscation_data_values>]

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

Parameter

Data type

Type

Value Range / Format

Details

collector_id_value

int

mandatory

minimum length: 1

maximum length: 5

Use this parameter to give a unique ID to this collector.

collector_name_value

str

mandatory

minimum length: 1

maximum length: 10

Use this parameter to give a valid name to this collector.

devo_address

str

mandatory

collector-us.devo.io

collector-eu.devo.io

Use this parameter to identify the Devo Cloud where the events will be sent.

chain_filename

str

mandatory

minimum length: 4

maximum length: 20

Use this parameter 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 parameter to identify the file.cert downloaded from your Devo domain.

key_filename

str

mandatory

minimum length: 4

maximum length: 20

Use this parameter to identify the file.key downloaded from your Devo domain.

input_id_value

int

mandatory

minimum length: 5

maximum length: 15

Use this parameter to give a 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.

environment_value

str

Optional

Minimum length: 1

This is an optional control parameter that is injected into the events and allows to differentiate the environment. For example: dev and prod.

This parameter should be removed if it is not used.

base_url_value

str

mandatory

minimum length: 1

One of: API endpoints

The IBM Cloud logging API URL for the Activity Tracker instance. Select from the following API endpoints.

service_key_value

string

mandatory

minimum length: 1

The IBM Cloud Activity Tracker service key. See Activity Tracker Service Keys for more information on how to obtain and/or configure your service key.

Please note that the IBM Cloud Activity Tracker requires a service key—not an ingestion key.

override_tag_value

str

optional

Devo tag-friendly string (no special characters, spaces, etc.) For more information see Devo Tags.

An optional tag that allows users to override the service default tags.

This parameter can be removed or commented.

override_fetch_gap_seconds_value

int

optional

minimum value: 0

An optional value that allows users to specify the query end time offset for a given poll. For example, specifying a value of 60 indicates that the collector will fetch all logs from the last event time (or start_time_in_utc_value if the first poll) up to NOW() - 60 seconds.

This threshold buffer is utilized to ensure that all log events have had time to properly ingest, index, and become searchable in the IBM Log Analysis instance.

This value will overwrite the default value (300 seconds).

This parameter can be removed or commented.

start_time_in_utc_value

str

optional

UTC datetime string having datetime string format %-Y-%m-%d %H-%M-%S (e.g., “2000-01-01 00:00:01”)

This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.

This parameter should be removed if it is not used.

obfuscation_data_values

array<object>

optional

The objects in the array look like this:

Code Block
obfuscation_data: - name: - credentials - "" value: "*********"

Each object represents the necessary configuration to obfuscate messages before these are sent to Devo.

This parameter can be removed or commented.

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-ibm_cloud_activity_tracker_if-docker-image-1.0.0	`c941662db8d01fb9d3efa2312be6a2ef8002c1ea8ad3e2ff06f24d6589167677`

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.

...

Version	Old Version 3	New Version Current
Changes made by	Virginia Camuñas Núñez	Virginia Camuñas Núñez
Saved on	Feb 14, 2025	Feb 17, 2025

Content Comparison

Versions Compared

Key

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose