Page Comparison

Table of Contents

minLevel	2
maxLevel	2
type	flat

...

For more information on how the events are parsed, visit our page ← LINK TO THE PARSER ARTICLE IF EXISTS

Flattening preprocessing

Data source	Collector service	Optional	Flattening details
logs_search	logs_search	yes	not required

...

Accepted authentication methods

Authentication method	secret_id	secret_key
API Key authentication	REQUIRED	REQUIRED

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

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: not_used
  name: tencent_cloud_collector
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_1:
    type: devo_platform
    config:
      address: <your-ingestion-endpoint>
      port: 443
      type: SSL
      chain: chain.crt
      cert: <your_domain>.crt
      key: <your_domain>.key
inputs:
  tencent_cloud:
  id: <short_unique_id>
  enabled: true
  credentials:
    secret_id: <secret_id_value>
    secret_key: <secret_key_value>
    endpoint: <endpoint_value>
    region: <region_value>
  services:
    logs_search:
      initial_start_time_in_utc: <initial_start_time_in_utc_value>
      topic_ids: <topics_array>
      logset_id: <logset_id_value>

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
<short_unique_id>	int	Mandatory	Minimum Length 5	Use this param 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.

<secret_id_value>	str	Mandatory	Minimum Length 1	secret id for Tencent Cloud
<secret_key_value>	str	Mandatory	Minimum Length 1	secret key for Tencent Cloud
<endpoint_value>	str	Mandatory	Minimum Length 1	endpoint for tencent cloud
<region_value>	str	Mandatory	Minimum Length 1	region for tencent cloud
<initial_start_time_in_utc_value>	str	Mandatory	UTC format/ `Not more than 30 days old` from current date	Start date to pull data from the date specified
<topics_array>	array	Mandatory	Minimum Length 1	Array containing topics ids to be fetched
<logset_id_value>	str	Mandatory	Minimum Length 1	logset id to be fetched

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-tencent_cloud_if-docker-image-1.0.0.tgz`-`	`0e4b6487daa3ace733125eea729f87c2c48e5717183a189d7c45d7a09c714241`

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. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.

Editing JSON Config

config.json

Code Block

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "tencent_cloud": {
      "id": "<short_unique_id>",
      "enabled": true,
      "credentials": {
        "secret_id": "<secret_id_value>",
        "secret_key": "<secret_key_value>",
        "endpoint": "<endpoint_value>",
        "region": "<region_value>"
      },
      "services": {
        "logs_search": {
          "initial_start_time_in_utc": "<initial_start_time_in_utc_value>",
          "topic_ids": "<topics_array>",
          "logset_id": "<logset_id_value>"
        }
      }
    }
  }
}

The following table outlines the parameters available for configuring the collector. Each parameter is categorized by its necessity (mandatory or optional), data type, acceptable values or formats, and a brief description.

Parameter	Data type	Type	Value range / Format	Details
<short_unique_id>	int	Mandatory	Minimum Length 5	Use this param 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.

<secret_id_value>	str	Mandatory	Minimum Length 1	secret id for Tencent Cloud
<secret_key_value>	str	Mandatory	Minimum Length 1	secret key for Tencent Cloud
<endpoint_value>	str	Mandatory	Minimum Length 1	endpoint for tencent cloud
<region_value>	str	Mandatory	Minimum Length 1	region for tencent cloud
<initial_start_time_in_utc_value>	str	Mandatory	UTC format/ `Not more than 30 days old` from current date	Start date to pull data from the date specified
<topics_array>	array	Mandatory	Minimum Length 1	Array containing topics ids to be fetched
<logset_id_value>	str	Mandatory	Minimum Length 1	logset id to be fetched

...

Versions Compared

Old Version 1

New Version 2

Key

Flattening preprocessing

Accepted authentication methods

Run the collector

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose

Editing JSON Config