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. | 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: not_used
name: <collector_name>
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:
cisco_umbrella::
id: <short_unique_id>
enabled: true
credentials:
aws_access_key: <aws_access_key_value>,
aws_access_secre: <aws_access_secret_value>
services:
service_name::
log_type: <log_type_value>
prefix_s3_name: <prefix_s3_name_value>
bucket: <bucket_value>
region_name: <regin_name_value>
customer_bucket: <customer_bucket_value>
request_period_in_seconds: <request_period_in_seconds_value>
override_tag: <override_tag_value>
start_time_in_utc: <start_time_in_utc_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 | Details | collector_name
| str | Mandatory | Minimum length: 1 | Use this param to give a name to this collector. | devo_address
| str | Mandatory | collector-us.devo.io collector-eu.devo.io | Use this parameter to identify the Devo Cloud where the events will be sent. | chain_filename
| str | Mandatory | minimum length: 4 maximum length: 20 | Use this parameter 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 parameter to identify the file.cert downloaded from your Devo domain. | key_filename
| str | Mandatory | minimum length: 4 maximum length: 20 | Use this parameter 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 an 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. | aws_access_key_value
| str | Mandatory | Minimum length: 1 | The AWS Access key for the AWS account. | aws_access_secret_value
| str | Mandatory | Minimum length: 1 | The AWS Access secret for the AWS account. | override_tag_value
| str | Optional | Devo tag-friendly string (no special characters, spaces, etc.) For more information see Devo Tags. | An optional tag that allows users to override the service default tags. This parameter can be removed or commented. | start_time_utc_value
| str | Optional | UTC datetime string having datetime string format %Y-%m-%d-%H-%M (e.g., “2023-07-11-01-23”) | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events. If the parameter is removed the collector starts from now - 15 minutes. This parameter should be removed if it is not used. | request_period_in_seconds_value
| int | Optional | minimum value: 900 | Period in seconds used between each data pulling. This value will overwrite the default value (900 seconds). This parameter can be removed or commented. | service_name
| str | Mandatory | Minimum length: 1 | It is a personalized service, the name can be anyone. Example: dnslogs, iplogs, firewalllogs, etc. | log_type_value
| str | Mandatory | One of these values: dnslogs
iplogs
proxylogs
firewalllogs
auditlogs
intrusionlogs
dlplogs
| This parameter indicates the type of log to be ingested from the S3 bucket. | prefix_s3_name_value
| str | Optional* | Minimum length: 1 | The prefix_s3_name parameter is used together with bucket and region_name parameters. The parameter can be removed if a customer-managed bucket is used. This parameter can be removed or commented. | bucket_value
| str | Optional* | Minimum length: 1 | The prefix_s3_name parameter is used together with bucket and region_name parameters. The parameter can be removed if a customer-managed bucket is used. This parameter can be removed or commented. | region_name_value
| str | Optional* | Minimum length: 1 | The prefix_s3_name parameter is used together with bucket and region_name parameters. The parameter can be removed if a customer-managed bucket is used. This parameter can be removed or commented. | customer_bucket_value
| str | Optional* | Minimum length: 1 | The parameter can be removed if a Cisco-managed bucket is used. This parameter can be removed or commented. |
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. |
| 
