--- title: "Flashpoint collector" canonical: "https://docs.devo.com/space/latest/774799388/Flashpoint%20collector" format: markdown --- > Macro (toc) ## Overview Flashpoint delivers actionable intelligence that empowers organization of all sizes to take rapid, decisive actions to protect against threats. The company's technology, advanced data collections, and human-powered analysis uniquely enable teams to mitigate threats related to cyber security, fraud, insider threats, corporate and physical security, executive protection, and third-party risk. ## Devo collector features | **Feature** | **Details** | | --- | --- | | Allow parallel downloading (`multipod`) | `not allowed` | | Running environments | - `collector server` - `on-premise` | | Populated Devo events | - `table` - `lookups` | | Flattening preprocessing | `yes` | | Allowed source events obfuscation | Possible but not implemented | ## Data sources | | | | | | | | --- | --- | --- | --- | --- | --- | | **Data source** | **Description** | **API endpoint** | **Collector service name** | **Devo table** | **Available from release** | | Indicators | Flashpoint indicators enables access to indicators of compromise (IoCs) and technical data across Flashpoint datasets and those included in Finished Intelligence Reports. | `https://fp.tools/api/v4` | `flashpoint_indicator` | Devo lookup:
`Threatintel_Flashpoint_Intelligence_{Type}` | v0.0 | | Alerts | Flashpoint Alerts grants access to your alerting data. The three types of data that can be retrieved are alerts, keywords, and keyword classes. | `https://fp.tools/api/alerting/v1` | `flashpoint_alert` | `threatintel.flashpoint.intelligence.alerts` | v0.0 | For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/270991361). ## Flattening preprocessing In order to improve data exploitation and enrichment, this collector applies some flattening actions to the collected data before delivering to Devo. | | | | | | --- | --- | --- | --- | | **Data source** | **Collector service** | **Optional** | **Flattening details** | | Indicators | `flashpoint_indicator` | no | The indicators are flatten to be compatible with the lookup sender, the indicators dictionary is flatten to one deep level dictionary following this structure:
`Deep_1.Deep_2.Key` | ## Vendor setup Access to `https://fp.tools/api/v4` must be granted to the collector In order to retrieve the data, the collectors need an API key. Your API token is available on `fp.tools` by clicking on your profile icon on the top right and selecting the Manage API Tokens option from the dropdown. To create a token, click the **Generate Token** button. Then, use the provided token in the code examples. If you don't see an option to create the API token, contact the Flashpoint customer success team. ## 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 setting sections for details. | | | | --- | --- | | **Setting** | **Details** | | `bearer_token_base64` | The API necessary for the collector to pull data. | | lookups | The dictionary of indicators we want to pull, we need at least one indicator, the name of the dictionary must match the name of the indicator as shown in the official Flashpoint documentation, Example:
``` "lookups": [ { "domain": { "lookup_key": "", "lookup_status": "New" } } ] ``` | | `lookup_key` | This will be the lookup key, it must be a key from the original dictionary data, take into account that the original data was flatten so any second or deeper keys will have the following structure:
`key_deep_1.key_deep_2.key_deep_3` | | `lookup_status` | This indicates if the lookup is new (or should be overwritten) or if it will be modified.
- `New` → creates or overwrites lookup. - `Created` → modifies lookup. | ## Accepted authentication methods | | | | --- | --- | | **Authentication method** | **Token** | | API key | [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 to the **domain** in which you want this instance to be created in, click on **Add Collector** and search for “**Mimecast Collector - Integrations Factory**”, then click on the result. > 2. In the **Version** field, select the latest value. > 3. In the **Collector Name** field, set the value you prefer (this name must be unique inside the same Collector Server domain). > 4. In the **Parameters** section, establish the **Collector Parameters** as follows below: > > ### Editing the JSON configuration > > ``` > "inputs": { > "flashpoint_indicator": { > "id": "", > "enabled": true, > "credentials": { > "bearer_token_base64": "" > }, > "services": { > "indicators": { > "lookup_name": "_{Type}", > "start_time": "0000-00-00T00:00:00.000Z", > "lookups": [ > { > "endpoint_name_1": { > "lookup_name": "", > "lookup_key": "", > "lookup_status": "New" > } > }, { > "endpoint_name_2": { > "lookup_name": "", > "lookup_key": "", > "lookup_status": "New" > } > } > ] > } > } > }, > "flashpoint_alert": { > "id": "", > "enabled": true, > "requests_per_second": 5, > "credentials": { > "bearer_token_base64": "" > }, > "services": { > "alerts": { > "tag": "", > "start_time": "0000-00-00T00:00:00.000Z" > } > } > } > } > } > ``` > > | | | | | | > | --- | --- | --- | --- | --- | > | **Parameter** | **Data type** | **Type** | **Value range / Format** | **Details** | > | `flashpoint_indicator` | `Inputs` | `Optional` | | Service that Will pull indicator from the Flashpoint API and send these events to Devo as lookups. | > | `id` | `String` | `Mandatory` | | Alphanumeric id for the input (Same inputs with the same id share states, keep the id unique to avoid unexpected behaviour) | > | `Enable` | `String` | `Mandatory` | - `true` > - `false` | Enable or disable the input. | > | `bearer_token_base64` | `String` | `Mandatory` | | API Key. | > | `lookup_name` | `String` | `Optional` | | General name for lookups, if `endpoint_name_1`.`lookup_name` is not configured this name will be used instead, if this is not configured then default will be used `Threatintel_Flashpoint_Intelligence_{Type}` | > | `start_time` | `Timestamp` | `Optional` | | Initial pulling time, if not configure the initial time would be the moment the collector is created. | > | `indicators.lookups` | `Dictionary` | `Mandatory` | | is a list of dictionaries, each dictionary is an indicator, in the documentation **Flashpoint-API-Technical-Indicators **is the full list of indicators (Example:`domain`, `md5`, `sha1`, `sha256`), the name of the dictionary must match the name of the indicator in the documentation. | > | `indicators`.`endpoint_name_1`.`lookup_name` | `String` | `Optional` | | The name of the lookup in Devo, if not configured `indicators`.`lookup_name` will be used or default `Threatintel_Flashpoint_Intelligence_{Type}`. | > | `indicators`.`endpoint_name_1`.`lookup_key` | `String` | `Mandatory` | | The name of the field that will act as key for the lookup | > | `indicators`.`endpoint_name_1`.`lookup_status` | `String` | `Mandatory` | - `New` > - `Created` | Keep this a `New` unless the lookup exist and don't want to overwrite the information, in that case change to `Created`. | > | `indicators.endpoint_name_1`.`lookup_headers` | `List` | `Optional` | | List with the name of the variables, keep in mind that the amount of variable must match the amount of variables in the events, some events don’t have the same amount of variables and this is handle by the code, use this only if you are sure of the amount of variables and positions. | > | `indicators.endpoint_name_1`.`lookup_field_types` | `List` | `Optional` | | List with the types of the variables, keep in mind that the amount of variable must match the amount of variables in the events, some events don’t have the same amount of variables and this is handle by the code, use this only if you are sure of the amount of variables and positions. | > | `flashpoint_alert` | `Inputs` | `Optional` | | Will pull alerts from the Flashpoint API and send these events to Devo in the indicated table (`threatintel.flashpoint.intelligence.alerts` by default). | > | `id` | `String` | `Mandatory` | | Alphanumeric id for the input (Same inputs with the same id share states, keep the id unique to avoid unexpected behaviour) | > | `Enable` | `String` | `Mandatory` | - `true` > - `false` | Enable or disable the input. | > | `bearer_token_base64` | `String` | `Mandatory` | | API Key. | > | `tag` | `String` | `Optional` | | Devo table where the alerts go, default `threatintel.flashpoint.intelligence.alerts`. | > > > 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](#). > > ![image-20240813-095143.png](media://204ab863-a706-4978-8941-2235d56fb411) > > > ⚠️ Replace `` with the proper value. > > ### Editing the config.yaml file > > ``` > globals: > debug: false > id: not_used > name: example_collector > persistence: > type: filesystem > config: > directory_name: state > > outputs: > devo_us_1: > type: devo_platform > config: > address: collector-us.devo.io > port: 443 > type: SSL > chain: chain.crt > cert: .crt > key: .crt > > inputs: > flashpoint_indicator: > id: > enabled: true > credentials: > bearer_token_base64: "" > services: > indicators: > lookup_name: Flashpoint_Intelligence_{Type} > start_time: 0000-00-00T00:00:00Z > lookups: > - domain: > lookup_name: Threatintel_Flashpoint_Intelligence_Domain > lookup_key: 'fpid' > lookup_status: "New" > - md5: > lookup_name: Threatintel_Flashpoint_Intelligence_MD5 > lookup_key: 'fpid' > lookup_status: "New" > - sha1: > lookup_name: Threatintel_Flashpoint_Intelligence_SHA1 > lookup_key: 'fpid' > lookup_status: "New" > - sha256: > lookup_name: Threatintel_Flashpoint_Intelligence_SHA256 > lookup_key: 'fpid' > lookup_status: "New" > - ip-src: > lookup_name: Threatintel_Flashpoint_Intelligence_Ip-dst > lookup_key: 'fpid' > lookup_status: "New" > > flashpoint_alert: > id: > enabled: true > requests_per_second: 5 > credentials: > bearer_token_base64: "api_token" > services: > alerts: > tag: my.app.flashpoint.alerts > start_time: 0000-00-00T00:00:00Z > ``` > > > ℹ️ 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** | > | `flashpoint_indicator` | `Inputs` | `Optional` | | Service that Will pull indicator from the Flashpoint API and send these events to Devo as lookups. | > | `id` | `String` | `Mandatory` | | Alphanumeric id for the input (Same inputs with the same id share states, keep the id unique to avoid unexpected behaviour) | > | `Enable` | `String` | `Mandatory` | - `true` > - `false` | Enable or disable the input. | > | `bearer_token_base64` | `String` | `Mandatory` | | API Key. | > | `lookup_name` | `String` | `Optional` | | General name for lookups, if `endpoint_name_1`.`lookup_name` is not configured this name will be used instead, if this is not configured then default will be used `Threatintel_Flashpoint_Intelligence_{Type}` | > | `start_time` | `Timestamp` | `Optional` | | Initial pulling time, if not configure the initial time would be the moment the collector is created. | > | `indicators.lookups` | `Dictionary` | `Mandatory` | | is a list of dictionaries, each dictionary is an indicator, in the documentation **Flashpoint-API-Technical-Indicators **is the full list of indicators (Example:`domain`, `md5`, `sha1`, `sha256`), the name of the dictionary must match the name of the indicator in the documentation. | > | `indicators`.`endpoint_name_1`.`lookup_name` | `String` | `Optional` | | The name of the lookup in Devo, if not configured `indicators`.`lookup_name` will be used or default `Threatintel_Flashpoint_Intelligence_{Type}`. | > | `indicators`.`endpoint_name_1`.`lookup_key` | `String` | `Mandatory` | | The name of the field that will act as key for the lookup | > | `indicators`.`endpoint_name_1`.`lookup_status` | `String` | `Mandatory` | - `New` > - `Created` | Keep this a `New` unless the lookup exist and don't want to overwrite the information, in that case change to `Created`. | > | `indicators.endpoint_name_1`.`lookup_headers` | `List` | `Optional` | | List with the name of the variables, keep in mind that the amount of variable must match the amount of variables in the events, some events don’t have the same amount of variables and this is handle by the code, use this only if you are sure of the amount of variables and positions. | > | `indicators.endpoint_name_1`.`lookup_field_types` | `List` | `Optional` | | List with the types of the variables, keep in mind that the amount of variable must match the amount of variables in the events, some events don’t have the same amount of variables and this is handle by the code, use this only if you are sure of the amount of variables and positions. | > | `flashpoint_alert` | `Inputs` | `Optional` | | Will pull alerts from the Flashpoint API and send these events to Devo in the indicated table (`threatintel.flashpoint.intelligence.alerts` by default). | > | `id` | `String` | `Mandatory` | | Alphanumeric id for the input (Same inputs with the same id share states, keep the id unique to avoid unexpected behaviour) | > | `Enable` | `String` | `Mandatory` | - `true` > - `false` | Enable or disable the input. | > | `bearer_token_base64` | `String` | `Mandatory` | | API Key. | > | `tag` | `String` | `Optional` | | Devo table where the alerts go, default `threatintel.flashpoint.intelligence.alerts`. | > > ### 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-flashpoint-intelligence-collector-ps-docker-image-1.2.0](https://drive.google.com/file/d/1snBSWZdR2Jr7iNUYrSaW2nYYJNEnQT4a/view?usp=drive_link) | `8fde0ed6d3643378bb7a10b01457c03ab43c8cb09a1edfbcce0f9dd0e932b627` | > > 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. ### Devo categorization and destination For the `flashpoint_indicator` input, if `indicators.endpoint_name_1.lookup_name` is set then this is the name that the lookup will have, in case it's not set then `indicators.lookup_name` if set will be used, in case it’s not then the default value will be used `Threatintel_Flashpoint_Intelligence_{Type}`. For the `flashpoint_alert` input, if tag is set then events will be sent there in case it’s not the default value will be used `threatintel.flashpoint.intelligence.alerts`. ### 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` | 1 | Please provide the `bearer_token_base64` in the inputs. | No `bearer_token_base64` in the configuration. | Fill the `bearer_token_base64`. | | `SetupError` | 2 | Please ensure the bearer token is prepared. | The bearer token is not valid. | Provided a valid bearer token. | | `SetupError` | 102 | Api `{error_log}`. | Error calling the API. | Follow the API indications in the error log. | | `PullError` | 101 | Error in fetch_alerts `{e}`. | Error fetching alerts. | Follow the API indications in the error log. | | `PullError` | 101 | Error in fetch_indicators `{e}`. | Error fetching alerts. | Follow the API indications in the error log. | | `PullError` | 102 | Api `{error_log}`. | Error calling the API. | Follow the API indications in the error log. | ### Events service
Verify data collection #### Setup output A successful run has the following output messages for the setup module: ``` WARNING InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> Waiting until setup will be executed INFO InputProcess::FlashpointIntelligenceIndicatorPullerSetup(example_collector,flashpoint_indicator#indicators_1234,indicators#predefined,domain) -> Setup for module has been successfully executed WARNING InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> Waiting until setup will be executedINFO InputProcess::FlashpointIntelligenceAlertPullerSetup(example_collector,flashpoint_alert#alerts_1234,alerts#predefined) -> Setup for module has been successfully executed ``` #### Puller output ``` INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) Starting the execution of pre_pull() INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> Retrieving persisted data INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> No persisted data found. The content will be initialized. INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> Latest state data in pre-pull: {'initial_start_time': '2023-02-07T00:00:00Z', 'domain': {'from_checkpoint_time': '2023-02-07T00:00:00Z', 'to_checkpoint_time': '2023-02-07T10:16:59Z', 'status': 'New'}} INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> PrePull method completed INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> Starting data collection every 300 seconds INFO InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) Starting the execution of pre_pull() INFO InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> Retrieving persisted data INFO InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> No persisted data found. The content will be initialized. INFO InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> Latest state data in pre-pull: {'initial_start_time': '2023-02-07T00:00:00Z', 'FlashpointIntelligenceAlertPuller': {'from_checkpoint_time': '2023-02-07T00:00:00Z', 'to_checkpoint_time': '2023-02-07T10:16:59Z'}} INFO InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> PrePull method completed ``` After a successful collector’s execution (that is, no error logs found), you will see the following log message: ``` INFO InputProcess::FlashpointIntelligenceIndicatorPuller(flashpoint_indicator,indicators_1234,indicators,predefined,domain) -> Pull completed for intel type #domain to Flashpoint_Intelligence_{Type}: for period 2023-02-07T00:00:00Z to 2023-02-07T10:16:59Z: events sent (3) /events retrieved (3) /number of requests (2) /elapsed time (31 sec) INFO InputProcess::FlashpointIntelligenceAlertPuller(flashpoint_alert,alerts_1234,alerts,predefined) -> Pull completed for intel type #alerts to my.app.flashpoint.alerts: for period 2023-02-07T00:00:00Z to 2023-02-07T10:16:59Z: events sent (0) /events retrieved (0) /number of requests (1) /elapsed time (32 sec) ```
Restart the persistence This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. The current version `1.0` does not support persistence restart it will be implemented in a future release.
## 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: ``` 2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config-josemi-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-trend-micro-vision-one\config\config-josemi-test-local.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 ``` ### 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: ``` 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 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) ```
## Change log | **Release** | **Released on** | **Release type** | **Details** | **Recommendations** | | --- | --- | --- | --- | --- | | `v1.1.0` | 8/14/2023 | [IMPROVEMENTs] | Update DCSDK from 1.6.0 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 - 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 - 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 | `Recommended version` | | `v1.0.0` | 1/30/2023 | [new feature] | **New features:**
- Initial release that includes the following data sources from Flashpoint API: - `Indicators` - `Alerts` | `Upgrade` |