The Collector Server is a managed platform that allows running sets of different collectors grouped by Devo domain destinations. To run an instance of this data collector, the next steps must be followed: In the Collector Server GUI, access the domain where you want to create this instance, click Add Collector, search for “Cortex XDR - Integrations Factory”, then click on the result. 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 Parameters section, establish the Collector Parameters as follows below:Collector services detail
| Info |
|---|
Please, replace the placeholders <api_key_value>, <api_key_id_value>, and <api_fqdn_value> in the next section with the values obtained in previous sections of this document, except the <short_unique_identifier> that can have the value you choose. Do not substitute the occurrences of {api_fqdn}. |
| Code Block |
|---|
{
"global_overrides": {
"debug": <debug_status>
},
"inputs": {
"cortex_xdr": {
"id": "<short_unique_id>",
"enabled": true,
"credentials": {
"api_key": "<api_key>",
"api_key_id": "<api_key_id>"
},
"services": {
"incidents": {
"api_fqdn": "<api_fqdn>",
"request_period_in_seconds" : <request_period_in_seconds>",
"start_time": "<start_time>",
"include_incident_alerts": "<include_incident_alerts>",
"override_devo_tag": "<override_devo_tag>"
"override_incident_alert_tag": "<override_incident_alert_tag>"
},
"alerts": {
"api_fqdn": "<api_fqdn>",
"request_period_in_seconds" : <request_period_in_seconds>",
"start_time": "<start_time>",
"override_devo_tag": "<override_devo_tag>"
},
"all_alerts": {
"api_fqdn": "<api_fqdn>",
"request_period_in_seconds" : <request_period_in_seconds>",
"start_time": "<start_time>",
"override_devo_tag": "<override_devo_tag>"
},
"violations": {
"api_fqdn": "<api_fqdn>",
"request_period_in_seconds" : <request_period_in_seconds>",
"start_time": "<start_time>",
"override_devo_tag": "<override_devo_tag>"
},
"audit_managements": {
"api_fqdn": "<api_fqdn>",
"request_period_in_seconds" : <request_period_in_seconds>",
"start_time": "<start_time>",
"override_devo_tag": "<override_devo_tag>"
}
}
}
}
} |
| Note |
|---|
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. |
| Info |
|---|
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 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. | <api_key>
| str
| Mandatory
| Minimum Length 1
| The API Key is your unique identifier used as the Authorization:{key}. | <api_key_id>
| str
| Mandatory
| Minimum Length 1
| The API Key ID is your unique token used to authenticate the API Key. It is used in headers as x-xdr-auth-id:{key_id} | <api_fqdn>
| str
| Mandatory
| Minimum Length 1
| The FQDN is a unique host and domain name associated with each tenant. When you generate the API Key and Key ID, you are assigned an individual FQDN. ex: https://{api-fqdn}/public_api/v1/incidents/get_incidents | <request_period_in_seconds>
| int
| Optional
| Minimum Length 1
| Period in seconds used between each data pulling, this value will overwrite the default value 60 seconds | <override_devo_tag>
| str
| Optional
| A devo tag | This parameter allows to define a custom devo tag.
ex: my.app.devo.service | <override_incident_alert_tag>
| str
| Optional
| A Incident Alert tag | This Tag is only applicable for Incidents service to override the tag of Incident alerts( Extra incident endpoint). Ex: my.app.devo.Incident_alert | <include_incident_alerts>
| boolean
| Optional
| A boolean to Include Incidents alerts | By default the value of this boolean is ‘true’. If given ‘false’ we will not be able to get incident alerts data (Extra incidents data for endpoint: v1/incidents/get_incident_extra_data). Ex : true, false | <start_time>
| str
| Optional
| start time in utc
format: %Y-%m-%dT%H:%M:%SZ | This parameter allows to get the data from provided start time. If not provided it will take current-time as time. Ex:- 2024-01-01T01:50:00Z |
| 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: cortex_xdr
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.crt
cert: <devo_domain>.crt
key: <devo_domain>.key
console_1:
type: console
inputs:
cortex_xdr:
id: <short_unique_id>
enabled: true
credentials:
api_key: <api_key>
api_key_id: <api_key_id>
services:
incidents:
api_fqdn: <api_fqdn>
request_period_in_seconds : <request_period_in_seconds> #optional
start_time: <start_time> #optional
include_incident_alerts: <include_incident_alerts> #Optional
override_devo_tag: <override_devo_tag> #optional
override_incident_alert_tag: <override_incident_alert_tag> #optional
alerts:
api_fqdn: <api_fqdn>
start_time: <start_time> # Example 2024-01-01T01:50:00Z
request_period_in_seconds: <request_period_in_seconds> #optional
override_devo_tag: <override_devo_tag> #optional
all_alerts:
api_fqdn: <api_fqdn>
start_time: <opt_start_time> # Example 2024-01-01T01:50:00Z #optional
request_period_in_seconds: <opt_request_period_in_seconds> #optional
override_devo_tag: <override_devo_tag> #optional
audit_managements:
api_fqdn: <api_fqdn>
start_time: <opt_start_time> # Example 2024-01-01T01:50:00Z #optional
request_period_in_seconds: <opt_request_period_in_seconds> #optional
override_devo_tag: <override_devo_tag> #optional
violations:
api_fqdn: <api_fqdn>
start_time: <opt_start_time> # Example 2024-01-01T01:50:00Z #optional
request_period_in_seconds: <opt_request_period_in_seconds> #optional
override_devo_tag: <override_devo_tag> #optional | | Note |
|---|
| All defined service entities will be executed by the collector. If |
| Note |
|---|
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. |
| Info |
|---|
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 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. | api_key
| str
| Mandatory
| Minimum Length 1
| The API Key is your unique identifier used as the Authorization:{key}. | api_key_id
| str
| Mandatory
| Minimum Length 1
| The API Key ID is your unique token used to authenticate the API Key. It is used in headers as x-xdr-auth-id:{key_id} while calling the API. | api_fqdn
| str
| Mandatory
| Minimum Length 1
| The {api_fqdn} FQDN is a unique host and domain name associated with each tenant. When you generate the API Key and Key ID, you are assigned an individual FQDN. ex: https://{api-fqdn}/public_api/v1/incidents/get_incidents | request_period_in_seconds
| int
| Optional
| Minimum Length 1
| Period in seconds used between each data pulling, this value will overwrite the default value 60 seconds | override_devo_tag
| str
| Optional
| A devo tag | This parameter allows to define a custom devo tag.
ex: my.app.devo.service | override_incident_alert_tag
| str
| Optional
| A Incident Alert tag | This Tag is only applicable for Incidents service to override the tag of Incident alerts ( Extra incident endpoint). Ex: my.app.devo.Incident_alert | include_incident_alerts
| boolean
| Optional
| A boolean to Include Incidents alerts | By default the value of this boolean is ‘true’. If given ‘false’ we will not be able to get incident alerts data (Extra incidents data for endpoint: v1/incidents/get_incident_extra_data). Ex : true, false | start_time
| str
| Optional
| start time in utc
format: %Y-%m-%dT%H:%M:%SZ | This parameter allows to get the data from provided start time. If not provided it will take current-time as time. Ex:- 2024-01-01T01:50:00Z |
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. |
|
