Page Comparison

We use a piece of software called Collector Server to host and manage all our available collectors.

To enable the collector for a customer:

1. In the Collector Server GUI, access the domain in which you want this instance to be created

2. Click Add Collector and find the one you wish to add.

3. In the Version field, select the latest value.

4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).

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

6. In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "atlassian": {
      "id": "jira_1",
      "enabled": true,
      "requests_per_second": 5,
      "credentials": {
        "username": "<username>",
        "api_key": "<api_key>"
      },
      "commons": {
        "verify_ssl": true,
        "url": "https://<domain>.atlassian.net"
      },
      "services": {
        "jira_audit": {
          "initial_start_time_in_utc": "YYYY-MM-DDTHH:mm:ssZ"
        },
        "confluence_audit": {
          "initial_start_time_in_utc": "YYYY-MM-DDTHH:mm:ssZ"
        }
      }
    }
  }
}

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

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:

<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── config/ 
            └── config.yaml 

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.

Editing the config.yaml file

globals:
  debug: false
  id: not_used
  name: salesfoce_collector
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_1:
    type: devo_platform
    config:
      address: collector-us.devo.io
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename> 
inputs:
  atlassian:
    id: 12345
    enabled: true
    requests_per_second: 5
    credentials:
      username: <username>
      api_key: <api_key>
    commons:
      verify_ssl: true
      url: https://<domain>.atlassian.net
    services:
      jira_audit:
        initial_start_time_in_utc: 2000-00-00T00:00:00Z
      confluence_audit:
        initial_start_time_in_utc: 2000-00-00T00:00:00Z

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

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:

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

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

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

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>

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.

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:

IMAGE_VERSION=<version> docker-compose up -d

We use a piece of software called Collector Server to host and manage all our available collectors.

To enable the collector for a customer:

1. In the Collector Server GUI, access the domain in which you want this instance to be created

2. Click Add Collector and find the one you wish to add.

3. In the Version field, select the latest value.

4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).

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

6. In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "atlassian": {
      "id": "jira_1",
      "enabled": true,
      "requests_per_second": 5,
      "credentials": {
        "username": "<username>",
        "api_key": "<api_key>"
      },
      "commons": {
        "verify_ssl": true,
        "url": "https://<domain>.atlassian.net"
      },
      "services": {
        "jira_audit": {
          "initial_start_time_in_utc": "YYYY-MM-DDTHH:mm:ssZ"
        },
        "confluence_audit": {
          "initial_start_time_in_utc": "YYYY-MM-DDTHH:mm:ssZ"
        }
      }
    }
  }
}

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