Content Comparison

...

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

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:

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

{
  "inputs": {
    "mulesoft_input": {
      "id": "<input_id>",
      │"enabled": <input_status>,
  ├── chain.crt   "credentials": {
    │   ├── <your_domain>.key
"client_id": "<client_id>",
       │   └── <your_domain>.crt"client_secret": "<client_secret>"
      },
 ├── state/       "services": {
 └── config/      "mulesoft_client_api": {
      └──   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.

Image Removed

Editing the config.yaml file

globals:
  debug: <debug>
  id: <collector_id>
  name: mulesoft.collector
  persistence: "last_configuration_timestamp": "<last_configuration_timestamp>",
          "endpoints": {
       type: filesystem     config"audit": {
     directory_name: state outputs:   devo_1:     type"initial_lookback_period": devo_platform"<initial_lookback_period>"
    config:       address: <address>}
      port: 443   }
   type: SSL    }
  chain: <chain_filenam>.crt   }
   cert: <cert_filename>.crt }
      key: <key_filename>.key
inputs:
  mulesoft_input:
    id: <input_id>
    enabled: <input_status>
    pageSize: 1000
    credentials:
      client_id: <client_id>
      client_secret: <client_secret>
    services:
      mulesoft_client_api:
        last_configuration_timestamp: <timestamp> # change this if you want to get your state changed!
        endpoints:
          audit:
            initial_lookback_period: 0s

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

Parameter

Data Type

Type

Value Range / Format

Details

collector_id

int

Mandatory

Minimum length: 1
Maximum length: 5

Unique id for this collector.

devo_address

str

Mandatory

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

Identify the Devo Cloud where the events will be sent.

chain_filename

str

Mandatory

Any

Identify the chain.cert file downloaded from your Devo domain. Usually, this file's name is chain.crt

cert_filename

str

Mandatory

Any

Identify the file.cert downloaded from your Devo domain.

key_filename

str

Mandatory

Any

Identify the file.key downloaded from your Devo domain.

input_id

int

Mandatory

Minimum length: 1
Maximum length: 5

Unique id for this input service.

input_status

bool

Mandatory

false / true

If the value is true, the input definition will be executed. If the value is false, the service will be ignored.

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.

client_id

str

Mandatory

Any

Client_id for making endpoint requests.

client_secret

str

Mandatory

Any

Client_secret for making endpoint requests.

last_configuration_timestamp

str

Mandatory

string date with this format
YYYY-MM-DDTHH:mm:ssZ

Timestamp to start collecting data in the past.

initial_lookback_period

str

Optional

Timedelta format

Period of time to look back from the timestamp stated. Default value is 0 seconds.

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-mulesoft_if-docker-image-1.1.0

ca1c90a240d35ecf4311002b81f3c72f8c277e5e32068268299ee0b7272ed53b

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

{
  "inputs": {
    "mulesoft_input": {
      "id": "<input_id>",
      "enabled": <input_status>,
      "credentials": {
        "client_id": "<client_id>",
        "client_secret": "<client_secret>"
      },
      "services": {
        "mulesoft_client_api": {
          "last_configuration_timestamp": "<last_configuration_timestamp>",
          "endpoints": {
            "audit": {
              "initial_lookback_period": "<initial_lookback_period>"
            }
          }
        }
      }
    }
  }
}

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

Parameter

Data type

Type

Value range / Format

Details

input_id

int

Mandatory

Minimum length: 1
Maximum length: 5

Use this param to give a unique id to this input service.

input_status

bool

Mandatory

false / true

If the value is true, the input definition will be executed. If the value is false, the service will be ignored.

client_id

str

Mandatory

Any

Client_id for making endpoint requests.

client_secret

str

Mandatory

Any

Client_secret for making endpoint requests.

last_configuration_timestamp

str

Mandatory

string date with this format
YYYY-MM-DDTHH:mm:ssZ

Timestamp to start collecting data in the past. ex: 2025-01-01T01:01:43Z.

initial_lookback_period

str

Optional

Timedelta format

}
}

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.

Image Added

Editing the config.yaml file

globals:
  debug: <debug>
  id: <collector_id>
  name: mulesoft.collector
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_1:
    type: devo_platform
    config:
      address: <address>
      port: 443
      type: SSL
      chain: <chain_filenam>.crt
      cert: <cert_filename>.crt
      key: <key_filename>.key
inputs:
  mulesoft_input:
    id: <input_id>
    enabled: <input_status>
    pageSize: 1000
    credentials:
      client_id: <client_id>
      client_secret: <client_secret>
    services:
      mulesoft_client_api:
        last_configuration_timestamp: <timestamp> # change this if you want to get your state changed!
        endpoints:
          audit:
            initial_lookback_period: 0s

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

Collector services detail

...