--- title: "Cylance collector" canonical: "https://docs.devo.com/space/latest/198246404/Cylance%20collector" format: markdown --- > Macro (toc) ## Configuration requirements To run this collector, there are some configurations detailed below that you need to consider. | **Configuration** | **Details** | | --- | --- | | Cylance APP | You need to run a Cylance app. | | Application ID | Once you create the App, it gives you an **Application ID**. | | Application Secret | Once you create the App, it gives you an **Application Secret**. | | Tenant ID | You can find it in your Cylance console. | > ℹ️ **More information** > ℹ️ > ℹ️ Refer to the [Vendor setup ](https://docs.devo.com/space/latest/198246404#Vendor-setup)section to know more about these configurations. ## Overview [Cylance](https://login.cylance.com/Login?from=VenueWeb) is an **AI-based Endpoint Protection Platform (EPP)** that blocks cyberattacks and provides controls for safeguarding against sophisticated threats. It protects organizations with networks where Internet access is severely restricted or not allowed (air-gapped environments). This collector facilitates the security-related communication between the virtual server that acts as the Cylance console and the local infrastructure - endpoints with CylancePROTECT agents installed - without exposing the local network to the broader internet ## Devo collector features | **Feature** | **Details** | | --- | --- | | Allow parallel downloading (`multipod`) | - `Not allowed` | | Running environments | - `Collector server` - `On-premise` | | Populated Devo events | - `Table` | | Flattening preprocessing | - `Yes` | ## Data sources | **Data source** | **Description** | **API endpoint** | **Collector service name** | **Devo table** | **Available from release** | | --- | --- | --- | --- | --- | --- | | Threats | Get information for a specific threat in a tenant. | `https://protectapi-{region-code}.cylance.com/threats/v2` | threats | `edr.blackberry.cylance.threats` | `v1.0.0` | | Users | Request a page with a list of console user resources belonging to a tenant. | `https://protectapi-{region-code}.cylance.com/users/v2` | users | `edr.blackberry.cylance.users` | `v1.0.0` | | Devices | Request a page with a list of device resources belonging to a tenant. | `https://protectapi-{region-code}.cylance.com/devices/v2` | devices | `edr.blackberry.cylance.devices` | `v1.0.0` | | Policies | Request a page with a list of console policies belonging to a tenant. | `https://protectapi-{region-code}.cylance.com/policies/v2` | policies | `edr.blackberry.cylance.policies` | `v1.0.0` | | Detections | Request a page with a list of detections belonging to a tenant. | `https://protectapi-{region-code}.cylance.com/detections/v2` | detections | `edr.blackberry.cylance.optics_detections` | `v1.0.0` | | Detection Rules | Retrieve a list of Detection rules available in a tenant. | `https://protectapi-{region-code}.cylance.com/rules/v2` | detection_rules | `edr.blackberry.cylance.optics_detections_rules` | `v1.0.0` | | Detection Exceptions | Retrieve a list of detection exception rules available in a tenant. | `https://protectapi-{region-code}.cylance.com/exceptions/v2` | detection_exceptions | `edr.blackberry.cylance.optics_detections_exceptions` | `v1.0.0` | For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/94662416). ## Flattening preprocessing | **Data source** | **Collector service** | **Optional** | **Flattening details** | | --- | --- | --- | --- | | Threats | threats | `yes` | Original structure:
``` { "ip_addresses": ["10.0.2.15"], "mac_addresses": ["08-00-27-E6-E5-59"] } ```
Result:
``` { "related_ips": 1, "ip": "10.0.2.15", "related_ip_count": 1, "related_macs": 1, "mac": "08-00-27-E6-E5-59", "related_mac_count": 1 } ``` | | Devices | devices | `yes` | Original structure:
``` { "products": [ { "name": "protect", "version": "3.0.1000", "status": "Online" } ], "policy": { "id": "f92e4b70-1c44-4898-b2f9-21207381abee", "name": "Default" }, "ip_addresses": [ "10.0.2.15" ], "mac_addresses": [ "08-00-27-E6-E5-59" ] } ```
Result:
``` { "related_ips": 1, "ip": "10.0.2.15", "related_ip_count": 1, "related_macs": 1, "mac": "08-00-27-E6-E5-59", "related_mac_count": 1, "policy_id": "f92e4b70-1c44-4898-b2f9-21207381abee", "policy_name": "Default", "product_name": "protect", "product_version": "3.0.100", "product_status": "Online", } ``` | | Policies | policies | `yes` | Original structure:
``` { "policy": [ { "name": "auto_blocking", "value": "0" }, { "value": "0", "name": "auto_uploading" } ], "logpolicy": { "log_upload": null, "maxlogsize": "100", "retentiondays": "30" } } ```
Result:
``` { "log_policy_log_upload": null, "log_policy_maxlogsize": "100", "log_policy_retentiondays": "30", "related_policys": 43, "related_policy_count": 22, "policy_name": "Default", "policy_value": "0" } ``` | | Detections | detections | `yes` | Original structure:
``` { "Detector": { "Name": "OpticsDetector", "Version": "3" }, "Device": { "CylanceId": "62fc6104-c288-440f-acfa-fa0ba7bb359f", "Name": "MSEDGEWIN10", "IpAddresses": [ "fe80::c50d:519f:96a4:e108%5", "10.0.2.15" ], "LoggedOnUsers": [ { "AccountType": "Normal", "FullName": "IEUser", "Id": "S-1-5-21-3461203602-4096304019-2269080069-1000", "User": "MSEDGEWIN10\\IEUser" } ] }, "DetectionRule": { "Name": "Internet Browser Launched Unsigned Process", "Id": "dd64897b-5cbf-4df3-beca-ec17c18add71", "PolicyGroup": "CylanceOfficialDetectionRuleset", "Version": 3, "ObjectType": "DetectionRule", "Description": "An Internet browser has spawned a new child process that is not signed", "Category": "Cylance Windows Official" } } ```
Result:
``` { "detection_rule_Name": "Internet Browser Launched Unsigned Process", "detection_rule_Id": "dd64897b-5cbf-4df3-beca-ec17c18add71", "detection_rule_PolicyGroup": "CylanceOfficialDetectionRuleset", "detection_rule_Version": 3, "detection_rule_ObjectType": "DetectionRule", "detection_rule_Description": "An Internet browser has spawned a new child process that is not signed", "detection_rule_Category": "Cylance Windows Official", "detector_Name": "OpticsDetector", "detector_Version": "3", "device_CylanceId": "62fc6104-c288-440f-acfa-fa0ba7bb359f", "device_Name": "MSEDGEWIN10", "device_IpAddresses": [ "fe80::c50d:519f:96a4:e108%5", "10.0.2.15" ], "device_LoggedOnUsers": [ { "AccountType": "Normal", "FullName": "IEUser", "Id": "S-1-5-21-3461203602-4096304019-2269080069-1000", "User": "MSEDGEWIN10\\IEUser" } ], "product_Name": "CylanceOPTICS", "product_Version": "2.5.3010.1204", "related_zone_ids": 1, "zone_id": "1931D5ED09C5417E904E7EEC30844C87", } ``` | | Detection Rules | detection_rules | `yes` | Original structure:
``` { "Product": { "Name": "CylanceOPTICS" }, "Plugin": { "Name": "OpticsDetector" } } ```
Result:
``` { "product_Name": "CylanceOPTICS", "plugin_Name": "OpticsDetector" } ``` | | Detection Exceptions | detection_exceptions | `yes` | Original structure:
``` { "Product": { "Name": "CylanceOPTICS" }, "Plugin": { "Name": "OpticsDetector" }, } ```
Result:
``` { "product_Name": "CylanceOPTICS", "plugin_Name": "OpticsDetector" } ``` | ## Vendor setup There are some minimum requirements that are needed to set up the collector. In order to retrieve the data, we need to create an **application_id** and **application_secret** to authenticate the collector. 1. Log into the dashboard. 2. Register an app. Go to **Settings → Integrations** and click on **Application**. 3. Give the **read permissions** to the Application and click on **Save**. 4. Save the **Application ID** and **Application secret**. Note: The Application ID and Application Secret only display once. 5. Copy the **Tenant ID** in a safe place. ## Minimum configuration required for basic pulling Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below. > ℹ️ This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check the setting sections for details. | **Setting** | **Details** | | --- | --- | | `application_id` | Application ID of the application created during the setup. | | `application_secret` | Application secret created during the setup. | | `tenant_id` | Tenant ID of the application created during the setup. | > ℹ️ See the **[Accepted authentication methods](https://docs.devo.com/space/latest/198246404#Accepted-authentication-methods)** section to verify what settings are required based on the desired authentication method. ## Accepted authentication methods | **Authentication method** | **Application ID** | **Application Secret** | **Tenant ID** | | --- | --- | --- | --- | | Application Id/Application Secret/Tenant ID | [REQUIRED] | [REQUIRED] | [REQUIRED] | ## Run the collector 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). > Macro (rw-ui-tabs-macro) > > > Macro (rw-tab) > > 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": > }, > "inputs": { > "cylance_common_data_puller": { > "id": "", > "enabled": true, > "region_code": "", > "credentials": { > "application_id": "", > "application_secret": "", > "tenant_id": "" > }, > "services": { > "threats": { > "historic_date_utc": "", > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_ip_addresses": , > "override_flatten_mac_addresses": , > "override_enrich_devices": > }, > "devices": { > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_ip_addresses": , > "override_flatten_mac_addresses": , > "override_flatten_policy": , > "override_flatten_product": > }, > "policies": { > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_policies": , > "override_flatten_logpolicy": > }, > "users": { > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_zones": > }, > "detections": { > "historic_date_utc": "", > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_detection_rule": , > "override_flatten_detectors": , > "override_flatten_device": , > "override_flatten_product": , > "override_flatten_zone_ids": , > "override_ingest_AssociatedArtifacts": , > "override_ingest_ArtifactsOfInterest": > }, > "detection_rules": { > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_plugin": , > "override_flatten_product": > }, > "detection_exceptions": { > "request_period_in_seconds": , > "rate_limiter": { > "period_in_seconds": , > "requests_limit_in_units": > }, > "override_flatten_plugin": , > "override_flatten_product": > } > } > } > } > } > ``` > > > ℹ️ 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. > > Please replace the placeholders with real world values following the description table below: > > | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** | > | --- | --- | --- | --- | --- | > | `` | `int` | `Mandatory` | `YMMDD` | Use this param to give a 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. | > | `` | `bool` | `Mandatory` | `false` / `true` | This will make the collector generate (or not) log messages with the DEBUG level. | > | `` | `int` | `Mandatory` | Minimum value: `1` | The period in seconds to be used between pulling executions. | > | `` | `int` | `Optional` | `Minimum length: 1` | This parameter allows you to customize this behavior for each service. | > | `` | `int` | `Optional` | `Minimum length: 1` | This parameter allows you to customize this behavior for each service. | > | `` | `str` | `Mandatory` | `apne1, au, euc1, sae1, us` | Set the region zone for your endpoint. If set to null `North America`will be used as default value. | > | `` | `str` | `Mandatory` | `str` | Application ID of your Cylance App | > | `` | `str` | `Mandatory` | `str` | Application Secret of you Cylance App | > | `` | `str` | `Mandatory` | `str` | Your Tenant ID | > | `` | `str` | `Mandatory` | `"%Y-%m-%dT%H:%M:%S.%fZ"` | Date since the user wants to get data. If null, collector gets data from 10 days ago. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the enrich devices option is activated. Add this parameter and set it to false to avoid the enrichment process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the ingestion of Associated Artifacts option is deactivated. Add this parameter and set it to true to allow the ingestion process. | > | `` | `str` | `Optional` | `true/false` | By default, the ingestion of Artifacts of Interes option is deactivated. Add this parameter and set it to true to allow the ingestion process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > > ![Cylance_10.png](media://330f0c2f-05f2-4a3f-930d-e63da6b94b83) > > > Macro (rw-tab) > > 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: > > ``` > > └── devo-collectors/ > └── / > ├── certs/ > │ ├── chain.crt > │ ├── .key > │ └── .crt > ├── state/ > └── config/ > └── config.yaml > ``` > > > ⚠️ Replace `` 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 `/certs/`. Learn more about security credentials in Devo [here](https://devodocs.atlassian.net/wiki/spaces/latest/pages/94763701). > > ![image](media://f567bffe-b34c-4ea8-b52d-5a34f34d61a2) > > > ⚠️ Replace `` with the proper value. > > ### Editing the config.yaml file > > ``` > globals: > debug: > id: not_used > name: > persistence: > type: filesystem > config: > directory_name: state > > outputs: > devo_1: > type: devo_platform > config: > address: > port: 443 > type: SSL > chain: chain.crt > cert: .crt > key: .key > inputs: > cylance_common_data_puller: > id: > enabled: true > region_code: > credentials: > application_id: > application_secret: > tenant_id: > services: > threats: > historic_date_utc: > request_period_in_seconds: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > override_flatten_ip_addresses: > override_flatten_mac_addresses: > override_enrich_devices: > > devices: > request_period_in_seconds: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > override_flatten_ip_addresses: > override_flatten_mac_addresses: > override_flatten_policy: > override_flatten_product: > > policies: > request_period_in_seconds: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > override_flatten_policies: > override_flatten_logpolicy: > > users: > request_period_in_seconds: > override_flatten_zones: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > > detections: > historic_date_utc: > request_period_in_seconds: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > override_flatten_detection_rule: > override_flatten_detectors: > override_flatten_device: > override_flatten_product: > override_flatten_zone_ids: > override_ingest_AssociatedArtifacts: > override_ingest_ArtifactsOfInterest: > > detection_rules: > request_period_in_seconds: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > override_flatten_product: > override_flatten_plugin: > > detection_exceptions: > request_period_in_seconds: > rate_limiter: > period_in_seconds: > requests_limit_in_units: > override_flatten_plugin: > override_flatten_product: > ``` > > > ℹ️ 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** | > | --- | --- | --- | --- | --- | > | `` | `bool` | `Mandatory` | `false` / `true` | This will make the collector generate (or not) log messages with the DEBUG level. | > | `` | `str` | `Mandatory` | Minimum length: 1 > Maximum length: 10 | Use this param to give a valid name to this collector. | > | `` | `str` | `Mandatory` | `collector-us.devo.io` > `collector-eu.devo.io` | Use this param to identify the Devo Cloud where the events will be sent. | > | `` | `int` | `Mandatory` | `YMMDD` | Use this param to give a 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. | > | `` | `int` | `Mandatory` | Minimum value: `1` | The period in seconds to be used between pulling executions. | > | `` | `int` | `Optional` | `Minimum length: 1` | `This parameter allows you to customize this behavior for each service.` | > | `` | `int` | `Optional` | `Minimum length: 1` | `This parameter allows you to customize this behavior for each service.` | > | `` | `str` | `Mandatory` | `apne1, au, euc1, sae1, us` | Set the region zone for your endpoint. If leave blank `North America` will be used as default value. | > | `` | `str` | `Mandatory` | `str` | Application ID of your Cylance App | > | `` | `str` | `Mandatory` | `str` | Application Secret of you Cylance App | > | `` | `str` | `Mandatory` | `str` | Your Tenant ID | > | `` | `str` | `Mandatory` | `"%Y-%m-%dT%H:%M:%S.%fZ"` | Date since the user wants to get data. If blank collector gets data from 10 days ago. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the enrich devices option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > | `` | `str` | `Optional` | `true/false` | By default, this option is deactivated. Add this parameter and set it to true to ingest Associated Artifacts. | > | `` | `str` | `Optional` | `true/false` | By default, this option is deactivated. Add this parameter and set it to true to ingest Artifacts of Interest. | > | `` | `str` | `Optional` | `true/false` | By default, the flatten option is activated. Add this parameter and set it to false to avoid the flattening process. | > > ### 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-collector_cylance_if-docker-image-1.3.0](https://drive.google.com/file/d/1dSoRldJNqDZMA5z9WLZZVuaZuCtg9-JK/view?usp=drive_link) | `2fbe331fb7d20a3b48a3186315ecd5c6fd60d1eed1d641e1ec9c0d78753a99fa` | > > Use the following command to add the Docker image to the system: > > ``` > gunzip -c -.tgz | docker load > ``` > > > ⚠️ Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `` and `` with a proper value. > > The Docker image can be deployed on the following services: > > #### Docker > > Execute the following command on the root directory `/devo-collectors//` > > ``` > docker run > --name collector- > --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 > : > ``` > > > ⚠️ Replace ``, `` and `` with the proper values. > > #### Docker Compose > > The following Docker Compose file can be used to execute the Docker container. It must be created in the `/devo-collectors//` directory. > > ``` > version: '3' > services: > collector-: > image: :${IMAGE_VERSION:-latest} > container_name: collector- > 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 `/devo-collectors//` directory: > > ``` > IMAGE_VERSION= docker-compose up -d > ``` > > > ⚠️ Replace ``, `` and `` with the proper values. ## Collector services detail This section is intended to explain how to proceed with specific actions for services. ### Events service
Verify data collection Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console. This service has the following components: | **Component** | **Description** | | --- | --- | | Setup | The setup module is in charge of authenticating the service and managing the token expiration when needed. | | Puller | The setup module is in charge of pulling the data in a organized way and delivering the events via SDK. | #### Setup output A successful run has the following output messages for the setup module: ``` INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,devices#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,devices#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,users#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,devices#predefined) -> Setup for module has been successfully executed INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,threats#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,policies#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detections#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,users#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,threats#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,policies#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detection_rules#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detections#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,users#predefined) -> Setup for module has been successfully executed INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,threats#predefined) -> Setup for module has been successfully executed INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,policies#predefined) -> Setup for module has been successfully executed INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detection_rules#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detections#predefined) -> Setup for module has been successfully executed INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detection_rules#predefined) -> Setup for module has been successfully executed INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detection_exceptions#predefined) -> Successfully generated new access token. Token is valid till: 2022-10-10 13:02:33 INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detection_exceptions#predefined) -> Previously generated token is still valid. Skipping the generation of new access token INFO InputProcess::CylanceCommonDataPullerSetup(cylance_collector,cylance_common_data_puller#111,detection_exceptions#predefined) -> Setup for module has been successfully executed ``` #### Puller output A successful initial run has the following output messages for the puller module: > ℹ️ Note that the `PrePull` action is executed only one time before the first run of the `Pull` action. ``` INFO InputProcess::CylanceUsersDataPuller(cylance_common_data_puller,111,users,predefined) -> Pull Started INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Pull Started INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) Finalizing the execution of pre_pull() INFO InputProcess::CylanceUsersDataPuller(cylance_common_data_puller,111,users,predefined) -> Requesting Users data from page: 1 with page size: 200 WARNING InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Persistence has been updated successfully INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Starting data collection every 86400 seconds INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Requesting Devices data from page: 1 and page size: 200 INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) Finalizing the execution of pre_pull() INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Pull Started INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Starting data collection every 86400 seconds INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Requesting Detection Rules data from page: 1 with page size: 200 INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Pull Started INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Requesting Detection Exceptions data from page: 1 with page size: 200 INFO InputProcess::CylanceDevicesDataPuller(cylance_common_data_puller,111,devices,predefined) -> Total number of Devices: 5 INFO InputProcess::CylanceDevicesDataPuller(cylance_common_data_puller,111,devices,predefined) -> Requesting detailed info of Devices. This may take a while.... INFO InputProcess::CylanceUsersDataPuller(cylance_common_data_puller,111,users,predefined) -> Total number of Users: 6 INFO InputProcess::CylancePoliciesDataPuller(cylance_common_data_puller,111,policies,predefined) -> Total number of Policies: 2 INFO InputProcess::CylancePoliciesDataPuller(cylance_common_data_puller,111,policies,predefined) -> Requesting detailed info of Policies. This may take a while.... INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Total number of Detections: 101 INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Removing the duplicate detections if present... INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Requesting detailed info of Detections. This may take a while.... INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Total number of Detection Exceptions: 3 INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Requesting detailed info of Detection Exceptions. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Total number of Threats: 22 2INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Removing the duplicate threats if present... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting detailed info of Threats. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Number of Threats sent to Devo: 26 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 21; Number of events received: 10; Number of duplicated events filtered out: 0; Number of events generated and sent: 26; Average of events per second: 4.622. INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting Threats data from page: 2 and page size: 200 INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Total number of Detection Rules: 175 INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Requesting detailed info of Detection Rules. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Total number of Threats: 22 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Removing the duplicate threats if present... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting detailed info of Threats. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Number of Threats sent to Devo: 25 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 42; Number of events received: 20; Number of duplicated events filtered out: 0; Number of events generated and sent: 51; Average of events per second: 4.414. INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting Threats data from page: 3 and page size: 200 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Total number of Threats: 22 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Removing the duplicate threats if present... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting detailed info of Threats. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Number of Threats sent to Devo: 2 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> State last_polled_timestamp is updated with last fetched threat last_found INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Saved state: {'last_polled_timestamp': 1664879686.0, 'historic_date_utc': 1651345434.521, 'sha256_with_same_last_found': ['CCB9502BF8BA5BECF8B758CA04A5625C30B79E2D10D2677CC43AE4253E1288EC'], 'last_found': '2022-10-04T10:34:46', 'last_polled_timestamp_for_current_poll': 1664879686.0, '@persistence_version': 0} INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 47; Number of events received: 22; Number of duplicated events filtered out: 0; Number of events generated and sent: 53; Average of events per second: 3.667. INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> The data is up to date! INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Data collection completed. Elapsed time: 14.493 seconds. Waiting for 585.507 second(s) until the next one ``` After a successful collector’s execution (that is, no error logs found), you will see the following log message: ``` INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 47; Number of events received: 22; Number of duplicated events filtered out: 0; Number of events generated and sent: 53; Average of events per second: 3.667. ``` > ℹ️ The value `@devo_pulling_id` is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that `Pull` action in Devo’s search window.
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 `historic_date_utc` parameter 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. > ⚠️ Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.
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. | **Error type** | **Error ID** | **Error message** | **Cause** | **Solution** | | --- | --- | --- | --- | --- | | SetupError | 100 | `Error occurred while requesting access token from the Cylance server` | Cylance API not working. | See collector logs for more info. | | 101 | `access token has expired or invalid. status code: 401` | Invalid or expired token | Check credentials given in the configuration. | | 102 | `The provided credentials are valid but they do not have the permission to generate access` | Not enough permissions. | Check app permissions in your app. | | 103 | `The resource requested is not found` | Resource not found. | Make sure your configuration is properly defined. | | 104 | `Unexpected error occurred at the Cylance server` | Cylance API not working. | See collector logs for more info. | | 105 | `Error occurred while retrieving users from Cylance server` | Cylance API not working. | See collector logs for more info. | | InitVariablesError | 10 | `region code specified is not valid. Valid region codes are apne1, au, euc1, sae1. Leave blank if the region is North America` | Region code is not valid. | Change the region code for one of these:
- apne1 - au - euc1 - sae1 | | 11 | `Required setting, historic_date_utc not of expected type: str` | historic_date_utc should be string, not a number | Change config file for a valid date. | | 12 | `Invalid value is provided for the historic_date. Provide the date in %Y-%m-%d %H:%M:%S format.` | Invalid format | Change value in config with a valid format:
`%Y-%m-%d %H:%M:%S` | | 13 | `Time format for historic date must be %Y-%m-%d %H:%M:%S` | Invalid format | Change value in config with a valid format:
`%Y-%m-%d %H:%M:%S` | | 14 | `historic datetime cannot be greater than the present UTC time` | Value of the historic_date_utc is greater than current time. | Change historic_date_utc for a valid value. | | PullError | 300 | `Error occurred while retrieving threats from Cylance server.` | Cylance API not responding properly. | See collector ouput logs. | | 302 | `access token has expired or invalid. status code: 401.` | Invalid token | Go to the Cylance console and check app token. | | 302 | `The access token does not have valid permissions to perform this request.` | Enough permissions. | Go to the Cylance console and check permissions. | | 303 | `The resource requested is not found.` | Resource you are looking for is not available. | | | 304 | `Unexpected error occurred at the Cylance server.` | Unexpected Cylance API response. | Check collector logs. | | 305 | `After 3 retries still getting the too many requests error."` | You are receiving 429 status code but after wait needed time API isn’t still responding. | |
## Collector operations This section is intended to explain how to proceed with specific operations of this collector.
Verify collector operations ### Initialization The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration. A successful run has the following output messages for the initializer module: ``` INFO InputProcess::MainThread -> Validating settings from collector definitions INFO InputProcess::MainThread -> Validating settings from user configuration INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread 2INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds) INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds) INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread 2INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds) INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread ``` ### Events delivery and Devo ingestion The event delivery module is in charge of receiving the events from the internal queues where all 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: ``` INFO InputProcess::CylanceUsersDataPuller(cylance_common_data_puller,111,users,predefined) -> Pull Started INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Pull Started INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) Finalizing the execution of pre_pull() INFO InputProcess::CylanceUsersDataPuller(cylance_common_data_puller,111,users,predefined) -> Requesting Users data from page: 1 with page size: 200 WARNING InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Persistence has been updated successfully INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Starting data collection every 86400 seconds INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Requesting Devices data from page: 1 and page size: 200 INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) Finalizing the execution of pre_pull() INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Pull Started INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Starting data collection every 86400 seconds INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Requesting Detection Rules data from page: 1 with page size: 200 2INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Pull Started INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Requesting Detection Exceptions data from page: 1 with page size: 200 INFO InputProcess::CylanceDevicesDataPuller(cylance_common_data_puller,111,devices,predefined) -> Total number of Devices: 5 INFO InputProcess::CylanceDevicesDataPuller(cylance_common_data_puller,111,devices,predefined) -> Requesting detailed info of Devices. This may take a while.... INFO InputProcess::CylanceUsersDataPuller(cylance_common_data_puller,111,users,predefined) -> Total number of Users: 6 INFO InputProcess::CylancePoliciesDataPuller(cylance_common_data_puller,111,policies,predefined) -> Total number of Policies: 2 INFO InputProcess::CylancePoliciesDataPuller(cylance_common_data_puller,111,policies,predefined) -> Requesting detailed info of Policies. This may take a while.... INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Total number of Detections: 101 INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Removing the duplicate detections if present... INFO InputProcess::CylanceDetectionDataPuller(cylance_common_data_puller,111,detections,predefined) -> Requesting detailed info of Detections. This may take a while.... INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Total number of Detection Exceptions: 3 INFO InputProcess::CylanceDetectionExceptionsDataPuller(cylance_common_data_puller,111,detection_exceptions,predefined) -> Requesting detailed info of Detection Exceptions. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Total number of Threats: 22 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Removing the duplicate threats if present... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting detailed info of Threats. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Number of Threats sent to Devo: 26 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 21; Number of events received: 10; Number of duplicated events filtered out: 0; Number of events generated and sent: 26; Average of events per second: 4.622. INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting Threats data from page: 2 and page size: 200 INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Total number of Detection Rules: 175 INFO InputProcess::CylanceDetectionRulesDataPuller(cylance_common_data_puller,111,detection_rules,predefined) -> Requesting detailed info of Detection Rules. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Total number of Threats: 22 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Removing the duplicate threats if present... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting detailed info of Threats. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Number of Threats sent to Devo: 25 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 42; Number of events received: 20; Number of duplicated events filtered out: 0; Number of events generated and sent: 51; Average of events per second: 4.414. INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting Threats data from page: 3 and page size: 200 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Total number of Threats: 22 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Removing the duplicate threats if present... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Requesting detailed info of Threats. This may take a while.... INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Number of Threats sent to Devo: 2 INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> State last_polled_timestamp is updated with last fetched threat last_found INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Saved state: {'last_polled_timestamp': 1664879686.0, 'historic_date_utc': 1651345434.521, 'sha256_with_same_last_found': ['CCB9502BF8BA5BECF8B758CA04A5625C30B79E2D10D2677CC43AE4253E1288EC'], 'last_found': '2022-10-04T10:34:46', 'last_polled_timestamp_for_current_poll': 1664879686.0, '@persistence_version': 0} INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1665397954934):Number of requests made: 47; Number of events received: 22; Number of duplicated events filtered out: 0; Number of events generated and sent: 53; Average of events per second: 3.667. INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> The data is up to date! INFO InputProcess::CylanceThreatsDataPuller(cylance_common_data_puller,111,threats,predefined) -> Data collection completed. Elapsed time: 14.493 seconds. Waiting for 585.507 second(s) until the next one ``` > ℹ️ By default, these information traces will be displayed every 10 minutes. #### Sender services The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (`internal`, `standard`, and `lookup`). This collector uses the following Sender Services: | **Sender services** | **Description** | | --- | --- | | `internal_senders` | In charge of delivering internal metrics to Devo such as logging traces or metrics. | | `standard_senders` | In charge of delivering pulled events to Devo. | #### Sender statistics Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type: | **Logging trace** | **Description** | | --- | --- | | `Number of available senders: 1` | Displays the number of concurrent senders available for the given Sender Service. | | `sender manager internal queue size: 0` | Displays the items available in the internal sender queue.
> ℹ️ This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders. | | `Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)` | Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:
- 44 events were sent to Devo since the collector started. - The last checkpoint timestamp was `2022-06-28 10:39:22.511671+00:00`. - 21 events where sent to Devo between the last UTC checkpoint and now. - Those 21 events required `0.007 seconds` to be delivered.
> ℹ️ By default these traces will be shown every 10 minutes. |
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) ``` > ℹ️ Differences between `RSS` and `VMS` memory usage: > ℹ️ > ℹ️ - `RSS` is the Resident Set Size, which is the actual physical memory the process is using > ℹ️ - `VMS` is the Virtual Memory Size which is the virtual memory that process is using
Enable/disable the logging debug mode Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes. - To enable this option you just need to edit the configuration file and change the debug_status parameter from false to true and restart the collector. - To disable this option, you just need to update the configuration file and change the debug_status parameter from true to false and restart the collector. For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode.
## Change log | **Release** | **Released on** | **Release type** | **Details** | | --- | --- | --- | --- | | `v1.4.0` | 6/3/2025 | [bug fixing] | **Bug fixes**
- Reviewed and updated the time format in the URL for threat and detection services. | | [IMPROVEMENTS] | **Improvements**
- Upgraded DCSDK from 1.16.1 to 1.16.2
- Upgraded docker base image to 1.5.1 | | `v1.3.0` | 5/19/2025 | [IMPROVEMENTS] | **Improvements**
- Upgraded DCSDK from 1.10.0 to 1.16.1
- Upgraded docker base image to 1.5.0 | | `v1.2.0` | 10/27/2023 | [IMPROVEMENTS] | **Improvements**
- Upgraded DCSDK from 1.9.1. to 1.9.2 - Upgraded Dependencies | | `v1.1.0` | 8/29/2022 | [IMPROVEMENT] | **Improvements**
- Upgraded DCSDK from 1.4.2 to 1.9.1 - Store lookup instances into DevoSender to avoid creation of new instances for the same lookup - Ensure service_config is a dict into templates - Ensure special characters are properly sent to the platform - Changed log level to some messages from info to debug - Changed some wrong log messages - Upgraded some internal dependencies - Changed queue passed to setup instance constructor - New “templates” functionality - Functionality for detecting some system signals for starting the controlled stopping - Input objects sends again the internal messages to devo.collectors.out table - Upgraded DevoSDK to version 3.6.4 to fix a bug related to a connection loss with Devo - Refactored source code structure - Changed way of executing the controlled stopping - Minimized probabilities of suffering a DevoSDK bug related to “sender” to be null - Ability to validate collector setup and exit without pulling any data - Ability to store in the persistence the messages that couldn’t be sent after the collector stopped - Ability to send messages from the persistence when the collector starts and before the puller begins working - Ensure special characters are properly sent to the platform - Added a lock to enhance sender object - Added new class attrs to the `setstate` and `getstate` queue methods - Fix sending attribute value to the `setstate` and `getstate` queue methods - Added log traces when queues are full and have to wait - Added log traces of queues time waiting every minute in debug mode - Added method to calculate queue size in bytes - Block incoming events in queues when there are no space left - Send telemetry events to Devo platform - Upgraded internal Python dependency Redis to v4.5.4 - Upgraded internal Python dependency DevoSDK to v5.1.3 - Fixed obfuscation not working when messages are sent from templates - New method to figure out if a puller thread is stopping - Upgraded internal Python dependency DevoSDK to v5.0.6 - Improved logging on messages/bytes sent to Devo platform - Fixed wrong bytes size calculation for queues - New functionality to count bytes sent to Devo Platform (shown in console log) - Upgraded internal Python dependency DevoSDK to v5.0.4 - Fixed bug in persistence management process, related to persistence reset - Aligned source code typing to be aligned with Python 3.9.x - Inject environment property from user config - Obfuscation service can be now configured from user config and module definition - Obfuscation service can now obfuscate items inside arrays - Ensure special characters are properly sent to the platform - Changed log level to some messages from info to debug - Changed some wrong log messages - Upgraded some internal dependencies - Changed queue passed to setup instance constructor - Added log traces for knowing the execution environment status (debug mode) - Fixes in the current puller template version - Docker container exits with the proper error code | | `v1.0.0` | 10/3/2022 | [NEW FEATURE] | Retrieve data for Blackberry Cylance services:
- Threats - Devices - Policies - Users - Detections - Detections Rules - Detection Exceptions |