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 the json file | Code Block |
|---|
{
"global_overrides": {
"debug": false
},
"inputs": {
"proofpoint_tap": {
"id": "<short_unique_id>",
"enabled": true,
"credentials": {
"username": "<username_value>",
"password": "<password_value>"
},
"services": {
"clicksBlocked": {
"start_time_in_utc_format": "<start_time_in_utc_format>"
},
"clicksPermitted": {
"start_time_in_utc_format": "<start_time_in_utc_format>"
},
"messagesBlocked": {
"start_time_in_utc_format": "<start_time_in_utc_format>"
},
"messagesDelivered": {
"start_time_in_utc_format": "<start_time_in_utc_format>"
},
"campaigns": {
"start_time_in_utc_format": "<start_time_in_utc_format>",
"forensics": true
},
"threats": {
"start_time_in_utc_format": "<start_time_in_utc_format>",
"forensics": true,
"include_campaign_forensics": true
},
"people_topclicks": {
"start_time_in_utc_format": "<start_time_in_utc_format>"
},
"people_vap": {
"start_time_in_utc_format": "<start_time_in_utc_format>"
}
}
}
}
} |
Parameter | Data type | Type | Value range / Format | Details |
|---|
<short_unique_id>
| int
| Mandatory
| Minimum Lenght 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. |
| <input_status>
| bool
| Mandatory
| false / true
| Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored. | <username_value>
| str
| Mandatory
| Minimum Length 1
| Provide the value of username used for authentication | <password_value>
| str
| Mandatory
| Minimum Length 1
| Provide the value of password used for authentication | <start_time_in_utc_format>
| str
| Mandatory
| Minimum Length 1
%Y-%m-%dT%H:%M:%SZ
| This configuration allows you to set a custom date as the beginning of the period to download. This allows the events but it can’t be more than 7 days in the past. | request_period_in_seconds
| int
| Optional
| Minimum Length 1
| This configuration allows us to set the “seconds” after which next pull cycle to be made. Allowed limit of number of api requests is 1800 per day so we have kept 600 seconds as a default value. | <override_tag_value>
| str
| Optional
| A devo tag | This parameter allows to define a custom devo tag. |
| 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. StructureThe 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 credentialsIn 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: <collector_id_value>
name: <collector_name_value>
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_us_1:
type: devo_platform
config:
address: <devo_address>
port: 443
type: SSL
chain: <chain_filename>
cert: <cert_filename>
key: <key_filename>
inputs:
proofpoint_tap:
id: <short_unique_id>
enabled: true
credentials:
username: <username_value>
password: <password_value>
services:
clicksBlocked:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
clicksPermitted:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
messagesBlocked:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
messagesDelivered:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
threats:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
forensics: true
include_campaign_forensics: true
campaigns:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
forensics: true
people_topclicks:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z
people_vap:
start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00Z |
| 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 Lenght 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. |
| <input_status>
| bool
| Mandatory
| false / true
| Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored. | <username_value>
| str
| Mandatory
| Minimum Length 1
| Provide the value of username used for authentication | <password_value>
| str
| Mandatory
| Minimum Length 1
| Provide the value of password used for authentication | <start_time_in_utc_format>
| str
| Mandatory
| Minimum Length 1
%Y-%m-%dT%H:%M:%SZ
| This configuration allows you to set a custom date as the beginning of the period to download. This allows the events but it can’t be more than 7 days in the past. | request_period_in_seconds
| int
| Optional
| Minimum Length 1
| This configuration allows us to set the “seconds” after which next pull cycle to be made. Allowed limit of number of api requests is 1800 per day so we have kept 600 seconds as a default value. | <override_tag_value>
| str
| Optional
| A devo tag | This parameter allows to define a custom devo tag. |
Download the Docker imageThe 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: | 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: DockerExecute 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 ComposeThe 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. |
| 
