/
Rapid7 insightvm Cloud Collector
Document toolboxDocument toolbox

Rapid7 insightvm Cloud Collector

Owned by MD Tausif, created
Last updated: Jan 10, 2025
20 min read
[ 1 Devo collector features ] [ 2 Data sources ] [ 3 Accepted authentication methods ] [ 4 Minimum configuration required for basic pulling ] [ 5 Run the collector ] [ 6 Collector services detail ] [ 7 Collector operations ] [ 8 Change log ]

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

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

Vulnerabilities

Get a list of Vulnerabilities .

integration/vulnerabilities

vulnerabilities

vuln.rapid7.insightvm_cloud.vulnerability

v1.0.0

Assets

Get a list of Assets.

integration/assets

assets

vuln.rapid7.insightvm_cloud.asset

Sites

Get a list of sites.

integration/sites

sites

vuln.rapid7.insightvm_cloud.site

Scans

Get a list of Scans.

integration/scan

scans

vuln.rapid7.insightvm_cloud.scan

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

Accepted authentication methods

api_key

status:required

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 running the collector section for details.

Setting

Details

Setting

Details

api_key

The API Keyis your unique identifier for Rapid7 InsightVm Cloud.

region

The region is your region or Rapid7 InsightVm Cloud.

api_version

The API Version is the version of the api for Rapid7 InsightVm Cloud

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 services detail

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

2024-12-30T14:25:52.983 INFO InputProcess::MainThread -> InsightVMCloudPullerSetup(insightvm_cloud#12134,assets#predefined) -> Starting thread 2024-12-30T14:25:52.984 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) - Starting thread 2024-12-30T14:25:52.984 INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.984 INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/865a79c1b99ad39b22becc235c9732cb" 2024-12-30T14:25:52.984 WARNING InputProcess::InsightVMCloudPullerSetup(insightvm_cloud#12134,assets#predefined) -> The token/header/authentication has not been created yet 2024-12-30T14:25:52.984 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/DevoSenderManager;internal_senders;devo_1.json.gz 2024-12-30T14:25:52.985 INFO InputProcess::MainThread -> InputMetricsThread -> Started thread for updating metrics values (update_period=10.0) 2024-12-30T14:25:52.985 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.985 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/e784c94a6fe28de5937e50674407d82e" 2024-12-30T14:25:52.987 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/DevoSender;internal_senders;devo_sender_0.json.gz 2024-12-30T14:25:52.988 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.988 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/4ff7b345dc444ac050cf75f93e5dcb3b" 2024-12-30T14:25:52.988 INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/OutputInternalConsumer;internal_senders;0.json.gz 2024-12-30T14:25:52.989 INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.989 INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/10dd360c86621afd5a28a029a0dddcf6" 2024-12-30T14:25:52.989 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread 2024-12-30T14:25:52.989 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds) 2024-12-30T14:25:52.990 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread 2024-12-30T14:25:52.990 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system 2024-12-30T14:25:52.990 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system 2024-12-30T14:25:52.990 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2024-12-30T14:25:52.991 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds) 2024-12-30T14:25:52.991 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:52.991 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00 2024-12-30T14:25:52.991 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread 2024-12-30T14:25:52.991 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system 2024-12-30T14:25:52.992 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system 2024-12-30T14:25:52.992 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2024-12-30T14:25:52.992 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds) 2024-12-30T14:25:52.993 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread 2024-12-30T14:25:52.993 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:52.993 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00 2024-12-30T14:25:52.993 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system 2024-12-30T14:25:52.994 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:52.994 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00 2024-12-30T14:25:52.994 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:52.994 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00 2024-12-30T14:25:52.994 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system 2024-12-30T14:25:52.994 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:52.994 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00 2024-12-30T14:25:52.994 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:52.994 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00 2024-12-30T14:25:52.995 INFO OutputProcess::MainThread -> OutputMetricsThread -> Started thread for updating metrics values (update_period=10.0) 2024-12-30T14:25:53.009 INFO InputProcess::MainThread -> [GC] global: 32.3% -> 32.4%, process: RSS(62.12MiB -> 62.62MiB), VMS(521.70MiB -> 521.70MiB) 2024-12-30T14:25:53.012 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "vendor_requests" created: "Number of requests received from the vendor API", unit: "requests" 2024-12-30T14:25:53.012 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_incoming_received" created: "Number of messages received from the vendor API", unit: "1" 2024-12-30T14:25:53.012 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_incoming_removed" created: "Number of messages removed by the collector", unit: "1" 2024-12-30T14:25:53.012 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_incoming_filtered" created: "Number of messages filtered by the collector", unit: "1" 2024-12-30T14:25:53.013 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_standard_counter" created: "Number of messages enqueued", unit: "1" 2024-12-30T14:25:53.013 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_standard_bytes" created: "Number of bytes enqueued", unit: "1" 2024-12-30T14:25:53.013 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_lookup_counter" created: "Number of messages enqueued", unit: "1" 2024-12-30T14:25:53.013 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_lookup_bytes" created: "Number of messages enqueued", unit: "1" 2024-12-30T14:25:53.013 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_internal_counter" created: "Number of messages enqueued in the queue", unit: "1" 2024-12-30T14:25:53.014 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_internal_bytes" created: "Number of messages enqueued in the queue", unit: "1" 2024-12-30T14:25:53.014 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Gauge "module_global_status" created: "Global status of current module", unit: "1" 2024-12-30T14:25:53.021 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_sent_counter" created: "Number of messages sent to the defined output", unit: "1" 2024-12-30T14:25:53.022 INFO OutputProcess::MainThread -> [GC] global: 32.4% -> 32.4%, process: RSS(61.73MiB -> 62.61MiB), VMS(1.07GiB -> 1.07GiB) 2024-12-30T14:25:53.022 INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_sent_bytes" created: "Number of bytes sent to the defined output", unit: "1" 2024-12-30T14:25:53.740 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(internal_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/certs/chain.crt", "cert_path": "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/certs/int-if-integrations-india.crt", "key_path": "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "137264546097760" 2024-12-30T14:25:53.740 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-12-30T14:25:55.171 INFO InputProcess::InsightVMCloudPullerSetup(insightvm_cloud#12134,assets#predefined) -> Setup for module <InsightVMCloudPuller> has been successfully executed

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.

Component

Description

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 an organized way and delivering the events via SDK.

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.

2024-12-30T13:26:49.390 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,scans#predefined) -> Pull Started 2024-12-30T13:26:49.390 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,scans#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1735545289387):Number of requests made: 1; Number of events received: 100; Number of duplicated events filtered out: 0; Number of events generated and sent: 100; Average of events per second: 209.336. 2024-12-30T13:26:49.390 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,scans#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1735545289387):Number of requests made: 1; Number of events received: 100; Number of duplicated events filtered out: 0; Number of events generated and sent: 100; Average of events per second: 209.336. 2024-12-30T13:26:49.390 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,scans#predefined) -> The data is up to date!

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2024-12-30T13:26:49.390 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,scans#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1735545289387):Number of requests made: 1; Number of events received: 100; Number of duplicated events filtered out: 0; Number of events generated and sent: 100; Average of events per second: 209.336.

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

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 an organized way and delivering the events via SDK.

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.

2024-12-30T14:21:58.779 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,vulnerabilities#predefined) -> Pull Started 2024-12-30T14:22:00.885 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,vulnerabilities#predefined) -> Retrieved 500 elements in vulnerabilities service for page: 0. 2024-12-30T14:22:00.897 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,vulnerabilities#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1735548718776):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 236.154. 2024-12-30T14:22:00.898 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,vulnerabilities#predefined) -> Detected 3 vulnerabilities pages, starting pagination loop 2024-12-30T14:22:00.907 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,vulnerabilities#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1735548718776):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 236.154.

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2024-12-30T14:22:00.907 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,vulnerabilities#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1735548718776):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 236.154.

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

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 an organized way and delivering the events via SDK.

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.

2024-10-22T14:30:30.701 INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> Pull Started 2024-10-22T14:30:33.663 INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630696):Number of requests made: 3; Number of events received: 30; Number of duplicated events filtered out: 0; Number of events generated and sent: 30; Average of events per second: 10.130. 2024-10-22T14:30:33.663 INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> Sent 10 events to Devo for account: <account> and domain: <domain>

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2024-10-22T14:30:33.663 INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630696):Number of requests made: 3; Number of events received: 30; Number of duplicated events filtered out: 0; Number of events generated and sent: 30; Average of events per second: 10.130.

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

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 an organized way and delivering the events via SDK.

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.

2024-12-30T14:25:56.017 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> Pull Started 2024-12-30T14:26:10.327 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> Retrieved 500 elements in assets service for page: 0. 2024-12-30T14:26:10.338 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1735548956014):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 34.914. 2024-12-30T14:26:10.339 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> Detected 1 assets pages, starting pagination loop 2024-12-30T14:26:10.338 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1735548956014):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 34.914.
2024-12-30T14:26:10.338 INFO InputProcess::InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1735548956014):Number of requests made: 1; Number of events received: 500; Number of duplicated events filtered out: 0; Number of events generated and sent: 500; Average of events per second: 34.914.

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 request_period_in_seconds 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.

Error Type

Error Id

Error Message

Cause

Solution

Error Type

Error Id

Error Message

Cause

Solution

SetupError

100

HTTP Error occurred while retrieving events from insightVMCloud server: summary: {e}, details: {details_str}

You will get the status code with error msg. Summary and details

Ensure that the collector has the necessary permissions and proper credentials to access the Rapid7 InsightVm Cloud API and contact the developer with exact error message

101

Some error occurred while retrieving events from insightVMCloud server. Error details : {e}

Error on the Insightvm server.

Contact the developer with exact error message.

PullError

300

HTTP Error occurred while retrieving events from insightVMCloud server. summary: {e} details: "{details_str}

You will get the status code with error msg.

This is an internal issue. Contact with Devo Support team.

301

Some error occurred while retrieving events from insightVMCloud server. Error details: {e}

You will get the error detail.

Kindly reach out to the developer

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:

2024-12-30T14:25:52.933 INFO MainProcess::MainThread -> Initialized all object from "MainProcess" process 2024-12-30T14:25:52.933 INFO MainProcess::MainThread -> OutputProcess - Starting thread (executing_period=120s) 2024-12-30T14:25:52.935 INFO MainProcess::MainThread -> InputProcess - Starting thread (executing_period=120s) 2024-12-30T14:25:52.937 INFO OutputProcess::MainThread -> Process started (pid=21311, ppid=21281, multiprocessing.start_method="fork") 2024-12-30T14:25:52.937 INFO MainProcess::MainThread -> [METRIC] Metric consumer started 2024-12-30T14:25:52.937 INFO MainProcess::WebServiceThread -> Starting WebServiceThread, ip-port: 0.0.0.0:3000 2024-12-30T14:25:52.938 INFO MainProcess::MainThread -> Started all objects from "MainProcess" process 2024-12-30T14:25:52.939 INFO InputProcess::MainThread -> Process started (pid=21315, ppid=21281, multiprocessing.start_method="fork") 2024-12-30T14:25:52.972 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/insightvm_cloud;12134;assets;predefined;InsightVMCloudPuller.json 2024-12-30T14:25:52.973 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.973 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/DevoSenderManager;standard_senders;devo_1.json.gz 2024-12-30T14:25:52.973 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 2), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/f40d701e79e78963c2d9737801b68f48" 2024-12-30T14:25:52.973 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/52be228bb11c71a4c5b77cf5e024ca74" 2024-12-30T14:25:52.974 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] Checking if old persisted data must be removed 2024-12-30T14:25:52.974 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists (Version 2), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/f40d701e79e78963c2d9737801b68f48" 2024-12-30T14:25:52.974 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/52be228bb11c71a4c5b77cf5e024ca74" 2024-12-30T14:25:52.974 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.974 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/5bdbabbd30e1988d6e2b0b74b6ec3289" 2024-12-30T14:25:52.974 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#predefined) Starting the execution of init_variables() 2024-12-30T14:25:52.975 INFO InputProcess::MainThread -> Validating service metadata 2024-12-30T14:25:52.976 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/DevoSender;standard_senders;devo_sender_0.json.gz 2024-12-30T14:25:52.976 INFO InputProcess::MainThread -> Validating defined module definition 2024-12-30T14:25:52.977 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.977 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/b1ee30ea2c4b3be1eb50c8b2ca80d8d8" 2024-12-30T14:25:52.978 INFO OutputProcess::MainThread -> OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/OutputStandardConsumer;standard_senders;0.json.gz 2024-12-30T14:25:52.978 INFO OutputProcess::MainThread -> OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.978 INFO OutputProcess::MainThread -> OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/de28663278a264d05d531fbc1db51a93" 2024-12-30T14:25:52.979 INFO InputProcess::MainThread -> Validating common input config 2024-12-30T14:25:52.979 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/DevoSenderManager;lookup_senders;devo_1.json.gz 2024-12-30T14:25:52.980 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated 2024-12-30T14:25:52.980 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/a28c135f3fc69ece87d8fc2fdb029e8c" 2024-12-30T14:25:52.980 INFO InputProcess::MainThread -> Validating service input config 2024-12-30T14:25:52.981 INFO InputProcess::MainThread -> Running overriding rules 2024-12-30T14:25:52.981 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-rapid7-insightvm-cloud/state/not_used/DevoSender;lookup_senders;devo_sender_0.json.gz 2024-12-30T14:25:52.981 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-12-30T14:25:52.982 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead. 2024-12-30T14:25:52.982 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-12-30T14:25:52.982 INFO InputProcess::MainThread -> Running custom validation rules 2024-12-30T14:25:52.982 INFO InputProcess::MainThread -> Creating API client. 2024-12-30T14:25:52.982 INFO InputProcess::MainThread -> Created request client: <agent.modules.rapid7_insightvm_cloud.commons.insightvm_cloud_client.InsightVMCloudClient object at 0x7cd760b6e160> 2024-12-30T14:25:52.982 INFO InputProcess::MainThread -> InsightVMCloudPuller(insightvm_cloud#12134,assets#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:

2024-09-06T15:32:47.810 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> Number of available senders: 1, sender manager internal queue size: 0 2024-09-06T15:32:47.810 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> enqueued_elapsed_times_in_seconds_stats: {} 2024-09-06T15:32:47.810 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False} 2024-09-06T15:32:47.811 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> Lookup - Total number of messages sent: 0, messages sent since "2024-09-06 09:57:47.810025+00:00": 0 (elapsed 0.000 seconds)

By default, these information traces will be displayed every 10 minutes.

Sender services

The Integrations Factory Collector SDK has 3 different sender 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

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: 0, messages sent since "2024-09-06 09:57:47.810025+00:00": 0 (elapsed 0.000 seconds

Displays the number of events from the last time the collector executed the pull logic. Following the given example, the following conclusions can be obtained:

  • 0 events were sent to Devo since the collector started.

  • The last checkpoint timestamp was 2024-09-06 09:57:47.810025+00:00

  • 0 events where sent to Devo between the last UTC checkpoint and now.

  • Those 0 events required 0.000 seconds to be delivered.

    By default these traces will be shown every 10 minutes.

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

2024-12-30T15:07:25.494 INFO InputProcess::MainThread -> [GC] global: 42.1% -> 42.1%, process: RSS(41.61MiB -> 41.73MiB), VMS(1.05GiB -> 1.05GiB) 2024-12-30T15:09:25.375 INFO OutputProcess::MainThread -> [GC] global: 42.4% -> 42.4%, process: RSS(44.46MiB -> 44.46MiB), VMS(929.14MiB -> 929.14MiB)

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

Change log

Release

Released on

Release type

Recommendations

Release

Released on

Release type

Recommendations

v1.1.0

Jan 6, 2025

status:Imrovements

Recommended version

Improvements

  • Updated DCSDK base docker image 1.3.1. Added Unit tests and added user_guide

  • Updated DCSDK from v1.11.1 to v1.13.1

    • Added new sender for relay in house + TLS

    • Added persistence functionality for gzip sending buffer

    • Added Automatic activation of gzip sending

    • Improved behaviour when persistence fails

    • Upgraded DevoSDK dependency

    • Fixed console log encoding

    • Restructured python classes

    • Improved behaviour with non-utf8 characters

    • Decreased default size value for internal queues (Redis limitation, from 1GiB to 256MiB)

    • New persistence format/structure (compression in some cases)

    • Removed dmesg execution (It was invalid for docker execution)

    • Added extra check for not valid message timestamps

    • Added extra check for improve the controlled stop

    • Changed default number for connection retries (now 7)

    • Fix for Devo connection retries

    • Updated DevoSDK to v5.1.10

    • Fix for SyslogSender related to UTF-8

    • Enhance of troubleshooting. Trace Standardization, Some traces has been introduced.

    • Introduced a mechanism to detect "Out of Memory killer" situation.

    • Updated DevoSDK to v5.1.9

    • Fixed some bug related to development on MacOS

    • Added an extra validation and fix when the DCSDK receives a wrong timestamp format

    • Added an optional config property for use the Syslog timestamp format in a strict way

    • Fixed error in pyproject.toml related to project scripts endpoint

    • Updated DevoSDK to v5.1.7

    • Introduced pyproject.toml

    • Added requirements-dev.txt

    • Added input metrics

    • Modified output metrics

    • Updated DevoSDK to v5.1.6

    • Standardized exception messages for traceability (Dynatrace related)

    • Added more detail in queue statistics

    • Upgrade internal dependencies

    • 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

    • Removed dmesg execution (It was invalid for docker execution)

    • DevoSDK has been updated to version 5.4.0

    • Fixed bug related to module_global_status value in message_metrics

    • PEP8 Cleanup

    • New metric endpoint (http://0.0.0.0:3000/metrics)

    • Changed some metric structure that were already sent to Devo before (devo.collector.metric.*)

    • Improved MacOS compatibility (for the development phase)

    • Updated DevoSDK to version 6.0.0

    • Puller and PullerSetup now have the same id structure

    • Changed some console log traces to DEBUG

    • Fixed bug related to rate_limiter object (the object was not properly internally released)

    • Improved Filesystem persistence behavior

    • New libraries installed:

      • uvicorn==0.31.1

      • fastapi==0.115.0

      • Updated libraries:

      • jsonschema==4.19.1 -> jsonschema==4.23.0

      • psutil==5.9.6 -> psutil==5.9.8

      • python-dateutil==2.8.2 -> python-dateutil==2.9.0.post0

      • Upgraded some internal dependencies

v1.0.0

Mar 22, 2024

status:Initial release

Updated

Related content