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: false
  id: not_used
  name: cbc_collector
  persistence:
    type: filesystem
    config:
      directory_name: state

outputs:
  devo_1:
    type: devo_platform
    config:
      address: <devo_address>
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename>
inputs:
  carbonblackcloud:
    id: <sort_unique_id>
    enabled: true
    requests_per_second: <requests_per_seconds>
    credentials:
      org_key: <org_key_value>
      aws_accesskey: <aws_access_key_value>
      aws_secretkey: <aws_secret_key_value>
    services:
      event_forwarder:
        aws_region: <aws_region>
        bucket_name: <bucket_name>
        queue_name: <queue_name>
        override_devo_tag: <override_devo_tag_value>
        kognos_categorization: <kognos_categorization_value>
        request_period_in_seconds: <request_period_in_seconds_value>
        override_files_per_request: <override_files_per_request_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

<devo_address>

str

Mandatory

collector-us.devo.io
collector-eu.devo.io

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

<chain_filename>

str

Mandatory

Minimum length: 4
Maximum length: 20

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

<key_filename>

str

Mandatory

Minimum length: 4
Maximum length: 20

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

<short_unique_id>

int

Mandatory

Minimum length: 1
Maximum length: 5

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.

<requests_per_second>

int

Optional

Minimum value: 1

Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.

Info
This parameter should be removed if it is not used.

<org_key>

str

Mandatory

Minimum length: 1

This parameter is the Carbon Black Cloud organization key.

Info
for more information see: Carbon Black Cloud: Where is the Org Key Found?

<aws_accesskey>

str

Mandatory

Minimum length: 1

The AWS access key.

Info
for more information see: Understanding and getting your AWS credentials - AWS General Reference

<aws_secretkey>

str

Mandatory

Minimum length: 1

The AWS secret key.

Info
for more information see: Understanding and getting your AWS credentials - AWS General Reference

<aws_region>

str

Mandatory

Minimum length: 1

This parameter must be a list with valid target region names to be used when collecting data, it will be created one processing thread per region.

Info
More info about available regions at Regions, Availability Zones, and Local Zones - Amazon Relational Database Service

<bucket_name>

str

Mandatory

Minimum length: 1

The AWS s3 bucket name. Examples:

docexamplebucket1
log-delivery-march-2020
my-hosted-content

<queue_name>

str

Mandatory

Minimum length: 1

The AWS SQS queue name.

<override_devo_tag_value>

str

Optional

A Devo Tag. For more information see Devo Tags.

This parameter allows to define a custom devo tag. The default value is endpoint.vmware.cbc_event_forwarder.{mapping_type}.

Info
This parameter can be removed or commented.

<kognos_categorization_value>

bool

Optional

false / true

Set this parameter to True to use the same categorization that Kognos uses. Categorizes messages into alerts and events and discards those without the type field. The default value is false.

Message destination tables with Kognos categorization:

endpoint.vmware.cbc_event_forwarder.kognos_alerts
endpoint.vmware.cbc_event_forwarder.kognos_events

Info
This parameter can be removed or commented.

<request_period_in_seconds_value>

int

Optional

Minimum value: 1

The amount (in seconds) in which the service’s collection is scheduled. The default value is 15.

Info
This parameter can be removed or commented.

<override_files_per_request_value>

int

Optional

Minimum value: 1

Maximum value: 10

This parameter indicates the number of files that are going to be taken from the queue per request. The default value is 10.

Info
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-vmware_carbonblackcloud_event_forwarder_if-docker-image-1.0.0	`c029326af6f6302b19bac9110949c41bf68fda70df4686b3973d7e6b37e0646b`

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.

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": false
  },
  "inputs": {
    "carbonblackcloud":{
      "id": "<short_unique_id>",
      "enabled": true,
      "requests_per_second": "<request_per_seconds>"
      "credentials": {
        "org_key": "<org_key_value>",
        "aws_accesskey": "<aws_access_key_value>",
        "aws_secretkey": "<aws_secret_key_value>"
      },
      "services":{
        "event_forwarder": {
          "aws_region": "<aws_region>",
          "bucket_name": "<bucket_name>",
          "queue_name": "<queue_name>",
          "override_devo_tag": "<override_devo_tag_value>",
          "kognos_categorization": "<kognos_categorization_value>",
          "request_period_in_seconds": <request_period_in_seconds_value>,
          "override_files_per_request": <override_files_per_request_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.

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

Parameter

Data Type

Type

Value Range / Format

Details

<short_unique_id>

int

Mandatory

Minimum length: 1
Maximum length: 5

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.

<requests_per_second>

int

Optional

Minimum value: 1

Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.

This parameter should be removed if it is not used.

<org_key_value>

str

Mandatory

Minimum length: 1

This parameter is the Carbon Black Cloud organization key.

For more information see: https://community.carbonblack.com/t5/Knowledge-Base/Carbon-Black-Cloud-Where-is-the-Org-Key-Found/ta-p/80970

<aws_access_key_value>

str

Mandatory

Minimum length: 1

The AWS access key.

For more information see: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html

<aws_secret_key_value>

str

Mandatory

Minimum length: 1

The AWS secret key.

For more information see: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html

<aws_region>

str

Mandatory

Minimum length: 1

This parameter must be a list with valid target region names to be used when collecting data, it will be created one processing thread per region.

More info about available regions at https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html

<bucket_name>

str

Mandatory

Minimum length: 1

The AWS s3 bucket name. Examples:

docexamplebucket1
log-delivery-march-2020
my-hosted-content

<queue_name>

str

Mandatory

Minimum length: 1

The AWS SQS queue name.

<override_devo_tag_value>

str

Optional

A Devo Tag. For more information see Devo Tags.

This parameter allows to define a custom devo tag. The default value is endpoint.vmware.cbc_event_forwarder.{mapping_type}.

This parameter can be removed or commented.

<kognos_categorization_value>

bool

Optional

false / true

Set this parameter to True to use the same categorization that Kognos uses. Categorizes messages into alerts and events and discards those without the type field. The default value is false.

Message destination tables with Kognos categorization:

endpoint.vmware.cbc_event_forwarder.kognos_alerts
endpoint.vmware.cbc_event_forwarder.kognos_events

This parameter can be removed or commented.

<request_period_in_seconds_value>

int

Optional

Minimum value: 1

The amount (in seconds) in which the service’s collection is scheduled. The default value is 15.

This parameter can be removed or commented.

<override_files_per_request_value>

int

Optional

Minimum value: 1

Maximum value: 10

This parameter indicates the number of files that are going to be taken from the queue per request. The default value is 10.

This parameter can be removed or commented.

Image Added

Collector services detail

...

Versions Compared

Old Version 9

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