Snyk collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Vendor setup ] [ 5 Minimum configuration required for basic pulling ] [ 6 Accepted authentication methods ] [ 7 Run the collector ] [ 8 Collector operations ] [ 9 Change log ]

Overview

Snyk is a developer-first platform for securing code, dependencies, containers, IaC and cloud deployments, from code to cloud and back to code.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table`
Flattening preprocessing	`no`
Allowed source events obfuscation	`yes`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
Audit Events	Fetch all the Audit Events.	Snyk API · Apiary	`organization_audit_logs`	`sast.snyk.organization.audit`	v1.0

For more information on how the events are parsed, visit our page.

Vendor setup

In order to retrieve the data, the following details will be required from your Thinkst API.

To use this API, you must get your token from Snyk. It can be seen on https://snyk.io/account/ after you register with Snyk and login.The token should be supplied in an Authorization header with the token, preceded by token.
Each request to Snyk has to be done in the context of a Snyk organization. If no organization is specified, the user's default organization (user is identified according to the API_KEY) will be used. The organization determines the access rights, licenses policy and is the unit of billing for private projects. An organization should be given as a query parameter named org, with the public identifier given to this org. The list of organizations and their corresponding public ids can be found with the organization resource.

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

Setting	Details
`Organization ID`	Organization ID you set up
`Authentication Token`	Auth Token provided from set up

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Authentication method	API	Auth token

Authentication method	API	Auth token
Basic authentication	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).

Collector operations

This section is intended to explain how to proceed with specific operations of this collector.

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:

2024-02-02T11:21:08.075    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.045", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service input config\", \"time\": \"2024-02-02T16:21:08.045018Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
AttributeError: 'CollectorMultiprocessingQueue' object has no attribute 'max_size_in_messages'
2024-02-02T11:21:08.075    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.046", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Running overriding rules\", \"time\": \"2024-02-02T16:21:08.046346Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
2024-02-02T11:21:08.076    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.046", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating the rate limiter config given by the user\", \"time\": \"2024-02-02T16:21:08.046601Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
2024-02-02T11:21:08.076    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.046", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"<requests_limits> setting has not been defined. The generic settings will be used instead.\", \"time\": \"2024-02-02T16:21:08.046783Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
2024-02-02T11:21:08.076    INFO InputProcess::MainThread -> Validating service input config
2024-02-02T11:21:08.076    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.046", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Adding raw config to the collector store\", \"time\": \"2024-02-02T16:21:08.046946Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
2024-02-02T11:21:08.076    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.047", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Running custom validation rules\", \"time\": \"2024-02-02T16:21:08.047106Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
2024-02-02T11:21:08.077    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.047", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"ThinkstCanaryBirdsPuller(thinkst,12345,birds,predefined) Finalizing the execution of init_variables()\", \"time\": \"2024-02-02T16:21:08.047273Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"birds\", \"module_name\": \"ThinkstCanaryBirdsPuller\"}"}
2024-02-02T11:21:08.077    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.051", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"ThinkstCanaryAuditPuller(thinkst,12345,audit_trail_log,predefined) Starting the execution of init_variables()\", \"time\": \"2024-02-02T16:21:08.051362Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.077    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.051", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service metadata\", \"time\": \"2024-02-02T16:21:08.051570Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.078    INFO InputProcess::MainThread -> Running overriding rules
2024-02-02T11:21:08.078    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.053", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating defined module definition\", \"time\": \"2024-02-02T16:21:08.053176Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.078    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.057", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating common input config\", \"time\": \"2024-02-02T16:21:08.057634Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.078    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-02-02T11:21:08.078    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.058", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service input config\", \"time\": \"2024-02-02T16:21:08.058971Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.079    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-02-02T11:21:08.079    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.060", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Running overriding rules\", \"time\": \"2024-02-02T16:21:08.060588Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.079    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-02-02T11:21:08.079    INFO InputProcess::MainThread -> Running custom validation rules
2024-02-02T11:21:08.079    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.060", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating the rate limiter config given by the user\", \"time\": \"2024-02-02T16:21:08.060780Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.080    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.060", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"<requests_limits> setting has not been defined. The generic settings will be used instead.\", \"time\": \"2024-02-02T16:21:08.060948Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.080    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.061", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Adding raw config to the collector store\", \"time\": \"2024-02-02T16:21:08.061109Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.080    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.061", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Running custom validation rules\", \"time\": \"2024-02-02T16:21:08.061269Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.080    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.063", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"ThinkstCanaryAuditPuller(thinkst,12345,audit_trail_log,predefined) Finalizing the execution of init_variables()\", \"time\": \"2024-02-02T16:21:08.063397Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"audit_trail_log\", \"module_name\": \"ThinkstCanaryAuditPuller\"}"}
2024-02-02T11:21:08.080    INFO InputProcess::MainThread -> ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) Finalizing the execution of init_variables()
2024-02-02T11:21:08.081    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.067", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) Starting the execution of init_variables()\", \"time\": \"2024-02-02T16:21:08.067826Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.081    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.068", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service metadata\", \"time\": \"2024-02-02T16:21:08.068059Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.081    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.069", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating defined module definition\", \"time\": \"2024-02-02T16:21:08.069740Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.082    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.074", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating common input config\", \"time\": \"2024-02-02T16:21:08.074830Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.082    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.076", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service input config\", \"time\": \"2024-02-02T16:21:08.076506Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.083    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.078", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Running overriding rules\", \"time\": \"2024-02-02T16:21:08.078607Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.083    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.078", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating the rate limiter config given by the user\", \"time\": \"2024-02-02T16:21:08.078856Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.083    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.079", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"<requests_limits> setting has not been defined. The generic settings will be used instead.\", \"time\": \"2024-02-02T16:21:08.079078Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.083    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.079", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Adding raw config to the collector store\", \"time\": \"2024-02-02T16:21:08.079288Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.083    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.079", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Running custom validation rules\", \"time\": \"2024-02-02T16:21:08.079498Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.084    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.080", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"ThinkstCanaryIncidentPuller(thinkst,12345,incidents,predefined) Finalizing the execution of init_variables()\", \"time\": \"2024-02-02T16:21:08.080907Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"incidents\", \"module_name\": \"ThinkstCanaryIncidentPuller\"}"}
2024-02-02T11:21:08.085 WARNING InputProcess::MainThread -> A previous rate limiter with same "period_in_seconds" and "number_of requests" was already existing: "86400/1000"
2024-02-02T11:21:08.086    INFO InputProcess::MainThread -> ThinkstCanaryCanaryTokenPuller(thinkst,12345,tokens,predefined) Starting the execution of init_variables()
2024-02-02T11:21:08.086    INFO InputProcess::MainThread -> Validating service metadata
2024-02-02T11:21:08.088    INFO InputProcess::MainThread -> Validating defined module definition
2024-02-02T11:21:08.092    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.086", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"ThinkstCanaryCanaryTokenPuller(thinkst,12345,tokens,predefined) Starting the execution of init_variables()\", \"time\": \"2024-02-02T16:21:08.086092Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"tokens\", \"module_name\": \"ThinkstCanaryCanaryTokenPuller\"}"}
2024-02-02T11:21:08.092    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.086", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service metadata\", \"time\": \"2024-02-02T16:21:08.086338Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"tokens\", \"module_name\": \"ThinkstCanaryCanaryTokenPuller\"}"}
2024-02-02T11:21:08.092    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.088", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating defined module definition\", \"time\": \"2024-02-02T16:21:08.088386Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"tokens\", \"module_name\": \"ThinkstCanaryCanaryTokenPuller\"}"}
2024-02-02T11:21:08.093    INFO InputProcess::MainThread -> Validating common input config
2024-02-02T11:21:08.094    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.093", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating common input config\", \"time\": \"2024-02-02T16:21:08.093600Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"tokens\", \"module_name\": \"ThinkstCanaryCanaryTokenPuller\"}"}
2024-02-02T11:21:08.095    INFO InputProcess::MainThread -> Validating service input config
2024-02-02T11:21:08.095    INFO OutputProcess::ConsoleSender(internal_senders,console_sender_0) -> {"message_timestamp": "2024-02-02 16:21:08.095", "message_tag": "devo.collectors.out.local.info", "message_content": "{\"msg\": \"Validating service input config\", \"time\": \"2024-02-02T16:21:08.095132Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"thinkst\", \"service_name\": \"tokens\", \"module_name\": \"ThinkstCanaryCanaryTokenPuller\"}"}
2024-02-02T11:21:08.096    INFO InputProcess::MainThread -> Running overriding rules
2024-02-02T11:21:08.097    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-02-02T11:21:08.097    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-02-02T11:21:08.097    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-02-02T11:21:08.097    INFO InputProcess::MainThread -> Running custom validation rules
2024-02-02T11:21:08.097    INFO InputProcess::MainThread -> ThinkstCanaryCanaryTokenPuller(thinkst,12345,tokens,predefined) Finalizing the execution of init_variables()

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 OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Number of available senders: 1, sender manager internal queue size: 0
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> enqueued_elapsed_times_in_seconds_stats: {}
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Sender: SyslogSender(standard_senders,syslog_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Standard - Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 44 (elapsed 0.007 seconds)
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Number of available senders: 1, sender manager internal queue size: 0
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> enqueued_elapsed_times_in_seconds_stats: {}
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Sender: SyslogSender(internal_senders,syslog_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Internal - Total number of messages sent: 1, messages sent since "2022-06-28 10:39:22.516313+00:00": 1 (elapsed 0.019 seconds)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

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

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.

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)

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	Recommendations

Release

Released on

Release type

Details

Recommendations

v1.1.1

Sep 4, 2024

IMPROVEMENTS

Improvements

Updated API endpoints. Added new service group audit logs.

Recommended version

v1.0.0

Feb 5, 2024

NEW RELEASE

New features

New `audit` service.

-