Page Comparison

...

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:

Rw ui tabs macro
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. Structure The 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 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 RemovedImage Added Note Replace <product_name> with the proper value. Editing the config.yaml file Code Block globals: debug: false id: not_ used name: Cyble_Collectorduo 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: cyble_visionduo: id: <input<short_idunique_value>id> enabled: true credentials: overrideintegration_base_urlkey: <override<integration_basekey_url_value> credentials secret_key: <secret_key_value> api_keyhostname: <api<hostname_key_value> services: alertsadministrator: overriderequests_taglimits: <override_tag_value> start_time_in_utc: <start_time_in_utc_value> obfuscation_data: [<obfuscation_data_values>]# API documents recommend not more than 1 request per minute - iocsperiod: 1m overridenumber_baseof_lookup_namerequests: <override_lookup_name_value>2 startrequest_timeperiod_in_utc: <start_time_in_utc_value> Replace the placeholders with your required values following the description table below:
Parameter	Data type	Type	Value range / Format	Details
debug_status	bool	mandatory	true / false	If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning, and error logging levels will be printed.
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.
start_time_in_utc_value	str	optional	UTC datetime string having datetime string format %-Y-%m-%d %H-%M-%S (e.g., “2000-01-01 00:00:01”)	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. Info This parameter should be removed if it is not used.
obfuscation_data_values	array<object>	optional	The objects in the array look like this: Code Block obfuscation_data: - name: - credentials - "*"     value: "**********"	Each object represents the necessary configuration to obfuscate messages before these are sent to Devo. Info This parameter can be removed or commented.
override_lookup_name_value	str	optional	minimum length: 3	An optional lookup name to use for the IOCs lookup service. By default the collector uses cyble_vision_iocs. Info This parameter can be removed or commented.
Collector Docker image	SHA-256 hash
collector-cyble_vision_it-docker-image-1.0.0.tgz	d42a485a1bc536d6a5478086db4fdf9e4327d0bd966895a271fac45e58069d69

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

seconds: 60
        start_datetime_utc: <start_datetime_utc_value>
        override_base_tag: <override_base_tag_value>
      authentication:
        requests_limits:
        # API documents recommend not more than 1 request per minute
        - period: 1m
          number_of_requests: 2
        request_period_in_seconds: 60
        start_datetime_utc: <start_datetime_utc_value>
        override_tag: <override_base_tag_value>
      telephony:
        requests_limits:
        # API documents recommend not more than 1 request per minute
        - period: 1m
          number_of_requests: 2
        request_period_in_seconds: 60
        start_datetime_utc: <start_datetime_utc_value>
        override_tag: <override_base_tag_value>

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": {
    "duo": {
      "id": "<short_unique_id>",
      "enabled": true,
      "credentials": {
        "integration_key": "<integration_key_value>",
        "secret_key": "<secret_key_value>",
        "hostname": "<hostname_value>"
      },
      "services": {
        "administrator": {
          "requests_limits": [
            {
              "period": "1m",
              "number_of_requests": 2
            }
          ],
          "request_period_in_seconds": 60,
          "start_datetime_utc": "<start_datetime_utc_value>",
          "override_base_tag": "<override_base_tag_value>"
        },
        "authentication": {
          "requests_limits": [
            {
              "period": "1m",
              "number_of_requests": 2
            }
          ],
          "request_period_in_seconds": 60,
          "start_datetime_utc": "<start_datetime_utc_value>",
          "override_tag": "<override_tag_value>"
        },
        "telephony": {
          "requests_limits": [
            {
              "period": "1m",
              "number_of_requests": 2
            }
          ],
          "request_period_in_seconds": 60,
          "start_datetime_utc": "<start_datetime_utc_value>",
          "override_tag": "<override_tag_value>"
        }
      }
    }
  }
}

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

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

For all the services

Devo categorization and destination

Please check the section Data Source Description to learn about the target tables for each service.

Restart the persistence

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

1. Edit the configuration file.

2. Change the value of the start_datetime_utc_value to a different one.

3. Save the changes.

4. Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

Troubleshooting

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Configuration errors

Collector operations

Verify collector operations

This is for the standalone mode only. You can check the information in the following sections to verify the correct collector operation.

Initialization

The initialization module validates the given configuration and runs the setup, the input (pulling logic), and output (delivering logic) services. A successful run has the following output messages for the initializer module:

2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config-test-local.yaml", "job_config_loc": null, "collector_config_loc": null}
2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Using the default location for "job_config_loc" file: "/etc/devo/job/job_config.json"
2023-01-10T15:22:57.147 INFO MainProcess::MainThread -> "\etc\devo\job" does not exists
2023-01-10T15:22:57.147 INFO MainProcess::MainThread -> Using the default location for "collector_config_loc" file: "/etc/devo/collector/collector_config.json"
2023-01-10T15:22:57.148 INFO MainProcess::MainThread -> "\etc\devo\collector" does not exists
2023-01-10T15:22:57.148 INFO MainProcess::MainThread -> Results of validation of config files parameters: {"config": "C:\git\collectors2\devo-collector-<name>\config\config.yaml", "config_validated": True, "job_config_loc": "/etc/devo/job/job_config.json", "job_config_loc_default": True, "job_config_loc_validated": False, "collector_config_loc": "/etc/devo/collector/collector_config.json", "collector_config_loc_default": True, "collector_config_loc_validated": False}
2023-01-10T15:22:57.171 WARNING MainProcess::MainThread -> [WARNING] Illegal global setting has been ignored -> multiprocessing: False

Event delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all the events are injected by the pullers and delivering them using the selected compatible delivery method. A successful run has the following output messages for the initializer module:

2023-01-10T15:23:00.788    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2023-01-10T15:23:00.789    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2023-01-10T15:23:00.790    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2023-01-10T15:23:00.842    INFO OutputProcess::MainThread -> global_status: {"output_process": {"process_id": 18804, "process_status": "running", "thread_counter": 21, "thread_names": ["MainThread", "pydevd.Writer", "pydevd.Reader", "pydevd.CommandThread", "pydevd.CheckAliveThread", "DevoSender(standard_senders,devo_sender_0)", "DevoSenderManagerMonitor(standard_senders,devo_1)", "DevoSenderManager(standard_senders,manager,devo_1)", "OutputStandardConsumer(standard_senders_consumer_0)",

Sender services

The Integrations Factory Collector SDK has 3 different sender services depending on the event type to deliver (internal, standard, and lookup). This collector uses the following Sender Services:

Sender statistics

Each service displays its performance statistics that allow checking how many events have been delivered to Devo by type:

Check memory usage

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

• The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.

• The global pressure of the available memory is displayed in the global value.

• All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

  INFO InputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(34.50MiB -> 34.08MiB), VMS(410.52MiB -> 410.02MiB)
  INFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB -> 705.28MiB)

Change log