Versions Compared

Version Old Version 17 New Version 18
Changes made by

Borja Moro Moreno

Borja Moro Moreno

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 14
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorbrackets
printabletrue

1. Running the Generic Collector: available methods

  • Cloud Collector → this method runs the collector as a service (Cloud Collector App).

  • Docker container → this method runs the collector on-premise (standalone mode).

2. Running the collector using Cloud Collector

The Cloud Collector is an application that allows you to run sets of collectors grouped by Devo domain destinations. To have an instance of this data collector running, follow these steps:

  1. Access the Cloud Collector App.

  2. Go to the Catalog to see the list of all the available integrations for your Devo domain.

  3. Click on Create instance for the integration you want to instantiate and fill in the details.

    1. Collector Name: set the desired value (it must be unique within the current Devo domain).

    2. Version: select the latest value available.

    3. Collector parameters: copy-paste the config template of the corresponding integration (click the expandable below to see the list of integrations and then click the desired one to access its config).

  4. Click on the Create Instance button at the bottom right when you finish.

rw-
Expand
titleFind the JSON config file for your integration here
rw-ui-children
Child pages (Children Display)
depth1
allChildrentrue
style
sortAndReverse
first0

3. Running the collector on-premise (Docker container)

This data collector can be run on any machine with the Docker service available because it should be executed as a Docker container. The following sections explain how to prepare the required setup.

3.1. Collector directory structure

Code Block
<any_directory>
└── devo-collectors/
    └── devo-<integration>-collector-<number>/
          ├── certs/
          │   ├── chain.crt
          │   ├── <your_domain>.key
          │   └── <your_domain>.crt
          └── config/
              └── config-generic.yaml
Info

The reason for having <integration> and <number> placeholders is to make it possible to have several integrations and several instances of integrations inside the devo-collectors directory.

3.2. Getting Devo certificates

To send data securely to the Devo platform, you will need to download X.509 Certificates from your Devo Domain. Download "Certificate", "Private Key" and "Chain" and save it on <any_directory>/devo-collectors/devo-<integration>-collector-<number>/certs/:

image-20241106-143015.png
Info

For more information about how to get the Devo certificates, please visit Devo Docs.

3.3. Editing config-generic.yaml file

Copy-paste the config template of the corresponding integration (click the expandable below to see the list of integrations and then click the desired one to access its config).

Expand
titleFind the YAML config file for your integration here
Child pages (Children Display)
depth1
allChildrentrue
style
sortAndReverse
first0

3.4. Downloading the Docker image

The collector should be deployed as a Docker container. Download the Docker image from the corresponding integration as a .tgz file (click the expandable below to see the list of integrations and then click the desired one to see access its docker image):

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

Code Block
gunzip -c collector-generic-docker-image-<version>.tgz | docker load
Info

Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <version> with the corresponding value. Once the Docker image is imported, it will show the real name of the Docker image (including version info).

Expand
titleFind the DOCKER IMAGE for your integration here
Child pages (Children Display)
depth1
allChildrentrue
style
sortAndReverse
first0

3.5. Deploying the collector: available services

3.5.1. Docker

Execute the following command on the root directory <any_directory>/devo-collectors/devo-<integration>-collector-<number>/

Code Block
docker run \
--name devo-<integration>-collector-<number> \
--volume $PWD/certs:/devo-collector/certs \
--volume $PWD/config:/devo-collector/config \
--volume $PWD/state:/devo-collector/state \
--env CONFIG_FILE=config-generic.yaml \
--rm -it devo.com/collectors/generic-collector:<version>
Note

Replace <version> with the corresponding value.

3.5.2. Docker-Compose

The content of the docker-compose-yaml file below can be used to execute the Docker container, and it should be created inside the <any_directory>/devo-collectors/devo-<integration>-collector-<number>/ directory:

Code Block
version: '3'
services:
  devo-generic-collector:
    build:
      context: .
      dockerfile: Dockerfile
    image: devo.com/collectors/generic_collector:${IMAGE_VERSION:-latest}
    container_name: <integration>-collector-<number>
    volumes:
      - ./certs:/devo-collector/certs
      - ./config:/devo-collector/config
      - ./state:/devo-collector/state
    environment:
      - CONFIG_FILE=${CONFIG_FILE:-config-generic.yaml}

To run the container using docker-compose execute the following command from the <any_directory>/devo-collectors/devo-<integration>-collector-<number>/ directory:

Code Block
$ IMAGE_VERSION=<version> docker-compose up -d
Note

Replace <version> with the corresponding value.