- Created by Juan Tomás Alonso Nieto on Jun 04, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
Overview
-
Devo collector features
Feature | Details |
---|---|
Allow parallel downloading ( |
|
Running environments |
|
Populated Devo events |
|
Flattening preprocessing |
|
Data sources
Data source | Description | API endpoint | Collector service name | Devo table | Available from release |
---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
For more information on how the events are parsed, visit our page.
Flattening preprocessing
Data source | Collector service | Optional | Flattening details |
---|---|---|---|
|
|
| not required |
|
|
| not 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 setting sections for details.
Setting | Details |
---|---|
| The username for Qualys FIM API. |
| The password for Qualys FIM API. |
| The token endpoint for to get the access token. (Ex:- |
| The auth url for Qualys FIM API |
See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.
Accepted authentication methods
Authentication method | Username | password |
---|---|---|
| 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 services detail
This section is intended to explain how to proceed with specific actions for services.
fim_incidents
Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.
This service has the following components:
Component | Description |
---|---|
Setup | The setup module is in charge of authenticating the service and managing the token expiration when needed. |
Puller | The setup module is in charge of pulling the data in a organized way and delivering the events via SDK. |
Setup output
A successful run has the following output messages for the setup module:
2024-05-30T17:12:26.992 INFO OutputProcess::MainThread -> Process started 2024-05-30T17:12:26.994 INFO MainProcess::MainThread -> Started all object from "MainProcess" process 2024-05-30T17:12:26.994 INFO InputProcess::MainThread -> Process Started 2024-05-30T17:12:27.015 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) Starting the execution of init_variables() 2024-05-30T17:12:27.015 INFO InputProcess::MainThread -> Validating service metadata 2024-05-30T17:12:27.016 INFO InputProcess::MainThread -> Validating defined module definition 2024-05-30T17:12:27.019 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread 2024-05-30T17:12:27.019 INFO InputProcess::MainThread -> Validating common input config 2024-05-30T17:12:27.019 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T17:12:27.019 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread 2024-05-30T17:12:27.019 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2024-05-30T17:12:27.020 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T17:12:27.020 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread 2024-05-30T17:12:27.020 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T17:12:27.020 INFO InputProcess::MainThread -> Validating service input config 2024-05-30T17:12:27.020 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2024-05-30T17:12:27.020 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T17:12:27.021 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T17:12:27.021 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T17:12:27.021 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T17:12:27.021 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread 2024-05-30T17:12:27.021 INFO InputProcess::MainThread -> Running overriding rules 2024-05-30T17:12:27.021 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-05-30T17:12:27.021 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead. 2024-05-30T17:12:27.021 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-05-30T17:12:27.021 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T17:12:27.021 INFO InputProcess::MainThread -> Running custom validation rules 2024-05-30T17:12:27.021 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) Finalizing the execution of init_variables() 2024-05-30T17:12:27.023 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) Starting the execution of init_variables() 2024-05-30T17:12:27.023 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T17:12:27.023 INFO InputProcess::MainThread -> Validating service metadata 2024-05-30T17:12:27.024 INFO InputProcess::MainThread -> Validating defined module definition 2024-05-30T17:12:27.026 INFO InputProcess::MainThread -> Validating common input config 2024-05-30T17:12:27.027 INFO InputProcess::MainThread -> Validating service input config 2024-05-30T17:12:27.028 INFO InputProcess::MainThread -> Running overriding rules 2024-05-30T17:12:27.028 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-05-30T17:12:27.028 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead. 2024-05-30T17:12:27.028 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-05-30T17:12:27.028 INFO InputProcess::MainThread -> Running custom validation rules 2024-05-30T17:12:27.028 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) Finalizing the execution of init_variables() 2024-05-30T17:12:27.029 INFO InputProcess::MainThread -> InputThread(qualys_fim,123123) - Starting thread (execution_period=60s) 2024-05-30T17:12:27.029 INFO InputProcess::MainThread -> ServiceThread(qualys_fim,123123,fim_events,predefined) - Starting thread (execution_period=60s) 2024-05-30T17:12:27.029 INFO InputProcess::MainThread -> QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Starting thread 2024-05-30T17:12:27.030 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) - Starting thread 2024-05-30T17:12:27.030 WARNING InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Waiting until setup will be executed 2024-05-30T17:12:27.030 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> First run of the collector. Generating new access token. 2024-05-30T17:12:27.030 WARNING InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> The token/header/authentication has not been created yet 2024-05-30T17:12:27.032 INFO InputProcess::MainThread -> ServiceThread(qualys_fim,123123,fim_incidents,predefined) - Starting thread (execution_period=60s) 2024-05-30T17:12:27.032 INFO InputProcess::MainThread -> QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_incidents#predefined) -> Starting thread 2024-05-30T17:12:27.032 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) - Starting thread 2024-05-30T17:12:27.032 WARNING InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) -> Waiting until setup will be executed 2024-05-30T17:12:27.032 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_incidents#predefined) -> First run of the collector. Generating new access token. 2024-05-30T17:12:27.033 WARNING InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_incidents#predefined) -> The token/header/authentication has not been created yet 2024-05-30T17:12:27.035 INFO OutputProcess::MainThread -> [GC] global: 32.3% -> 32.3%, process: RSS(41.68MiB -> 42.68MiB), VMS(928.46MiB -> 928.46MiB) 2024-05-30T17:12:27.046 INFO InputProcess::MainThread -> [GC] global: 32.3% -> 32.4%, process: RSS(41.70MiB -> 41.70MiB), VMS(712.45MiB -> 712.45MiB) 2024-05-30T17:12:28.308 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-qualys-fim/certs/chain.crt", "cert_path": "/home/md_tausif/gitlab/devo-collector-qualys-fim/certs/int-if-integrations-india.crt", "key_path": "/home/md_tausif/gitlab/devo-collector-qualys-fim/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "139771304509792" 2024-05-30T17:12:36.214 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Token is valid. Skipping the generation of new access token 2024-05-30T17:12:36.215 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Token is valid. Skipping the generation of new access token 2024-05-30T17:12:36.215 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Setup for module <QualysFimBasePuller> has been successfully executed
Puller output
A successful initial run has the following output messages for the puller module:
Note that the PrePull
action is executed only one time before the first run of the Pull
action.
2024-05-30T17:12:45.058 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) -> Pull Started 2024-05-30T17:12:45.058 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) -> Fetching data From : 2024-01-03 10:00:00+00:00 To : 2024-01-05 10:00:00+00:00 2024-05-30T17:12:47.053 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) -> Sent 2 fim_incidents events to Devo. 2024-05-30T17:12:47.053 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1717069365052):Number of requests made: 1; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 1.002.
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
2024-05-30T17:12:47.053 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_incidents,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1717069365052):Number of requests made: 1; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 1.002.
The value @devo_pulling_id
is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that Pull
action in Devo’s search window.
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:
Edit the configuration file.
Change the value of the
start_time_in_utc
parameter to a different one.Save the changes.
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.
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 |
---|---|---|---|---|
| 100 | Error occurred while requesting from the Qualys server. Error | Error pccurred on the qualys server | you’ll get error message. Kindly reach the developer with the message |
101 | The tokens provided are incorrect. Please specify the correct credentials | tokens (username, password) is invalid or incorrect | Please provide the correct tokens (username , password) | |
102 | The provided tokens are valid but they do not have the permission to get data | No permission for provided credentials to get the data | Please get the required permission to fetch the data from the vendor. | |
103 | Unexpected HTTP error occurred at the Qualys server. status cod | Unexpected HTTP error | Contact team in this case | |
| 300 | HTTP Error occurred while retrieving events from Qualys | This error happens when the collector tries to fetch the data from API. | In this error you will find the HTTP error code as well as the summary and details. |
| 301 | Some error occurred while retrieving events from Qualys server. | Some exceptions occurred while making the API request. | Reach out to the developer with the exact error message. |
fim_alerts
Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.
This service has the following components:
Component | Description |
---|---|
Setup | The setup module is in charge of authenticating the service and managing the token expiration when needed. |
Puller | The setup module is in charge of pulling the data in a organized way and delivering the events via SDK. |
Setup output
A successful run has the following output messages for the setup module:
2024-05-30T13:40:57.069 INFO InputProcess::MainThread -> Process Started 2024-05-30T13:40:57.089 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) Starting the execution of init_variables() 2024-05-30T13:40:57.089 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread 2024-05-30T13:40:57.089 INFO InputProcess::MainThread -> Validating service metadata 2024-05-30T13:40:57.089 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T13:40:57.089 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread 2024-05-30T13:40:57.089 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T13:40:57.090 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread 2024-05-30T13:40:57.090 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread 2024-05-30T13:40:57.090 INFO InputProcess::MainThread -> Validating defined module definition 2024-05-30T13:40:57.090 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.091 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.092 INFO InputProcess::MainThread -> Validating common input config 2024-05-30T13:40:57.093 INFO InputProcess::MainThread -> Validating service input config 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Running overriding rules 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead. 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Running custom validation rules 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) Finalizing the execution of init_variables() 2024-05-30T13:40:57.096 INFO InputProcess::MainThread -> InputThread(qualys_fim,123123) - Starting thread (execution_period=60s) 2024-05-30T13:40:57.096 INFO InputProcess::MainThread -> ServiceThread(qualys_fim,123123,fim_events,predefined) - Starting thread (execution_period=60s) 2024-05-30T13:40:57.097 INFO InputProcess::MainThread -> QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Starting thread 2024-05-30T13:40:57.097 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) - Starting thread 2024-05-30T13:40:57.097 WARNING InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Waiting until setup will be executed 2024-05-30T13:40:57.097 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> First run of the collector. Generating new access token. 2024-05-30T13:40:57.097 WARNING InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> The token/header/authentication has not been created yet 2024-05-30T13:40:57.103 INFO OutputProcess::MainThread -> [GC] global: 33.9% -> 34.0%, process: RSS(41.66MiB -> 42.91MiB), VMS(928.46MiB -> 928.46MiB) 2024-05-30T13:40:57.111 INFO InputProcess::MainThread -> [GC] global: 34.0% -> 34.0%, process: RSS(41.69MiB -> 41.69MiB), VMS(496.19MiB -> 496.19MiB) 2024-05-30T13:40:57.546 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-qualys-fim/certs/chain.crt", "cert_path": "/home/md_tausif/gitlab/devo-collector-qualys-fim/certs/int-if-integrations-india.crt", "key_path": "/home/md_tausif/gitlab/devo-collector-qualys-fim/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "136120709088016" 2024-05-30T13:41:11.112 WARNING InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Waiting until setup will be executed 2024-05-30T13:41:11.240 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Token is valid. Skipping the generation of new access token 2024-05-30T13:41:11.241 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Token is valid. Skipping the generation of new access token 2024-05-30T13:41:11.241 INFO InputProcess::QualysFimBasePullerSetup(qualys_fim_collector,qualys_fim#123123,fim_events#predefined) -> Setup for module <QualysFimBasePuller> has been successfully executed
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-05-30T13:41:12.120 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Pull Started 2024-05-30T13:41:12.121 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Fetching data From : 2024-01-06 10:00:00+00:00 To : 2024-01-08 10:00:00+00:00 2024-05-30T13:41:57.114 INFO InputProcess::InputStatsThread -> Input metrics sent: 3 2024-05-30T13:41:57.115 INFO InputProcess::MainThread -> [GC] global: 33.9% -> 33.9%, process: RSS(44.69MiB -> 44.69MiB), VMS(496.44MiB -> 496.44MiB) 2024-05-30T13:41:57.115 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 37, total_bytes: 25816 (60.024367 seconds) 2024-05-30T13:41:57.921 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Consumed messages: 37 messages (60.831169 seconds) => 0 msg/sec 2024-05-30T13:42:57.115 INFO InputProcess::InputStatsThread -> Input metrics sent: 3 2024-05-30T13:42:57.116 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 4, total_bytes: 3122 (60.00149 seconds) 2024-05-30T13:42:57.117 INFO OutputProcess::MainThread -> [GC] global: 33.9% -> 33.9%, process: RSS(44.16MiB -> 44.16MiB), VMS(928.46MiB -> 928.46MiB) 2024-05-30T13:43:57.116 INFO InputProcess::InputStatsThread -> Input metrics sent: 3 2024-05-30T13:43:57.118 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 3, total_bytes: 2482 (60.001445 seconds) 2024-05-30T13:43:57.137 INFO InputProcess::MainThread -> [GC] global: 34.0% -> 34.0%, process: RSS(46.19MiB -> 46.19MiB), VMS(496.44MiB -> 496.44MiB) 2024-05-30T13:43:58.003 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Consumed messages: 7 messages (120.081674 seconds) => 0 msg/sec 2024-05-30T13:44:13.694 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> Consumed messages: 1, total_bytes: 840 (196.604585 seconds) 2024-05-30T13:44:13.696 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Sent 1000 fim_events events to Devo. 2024-05-30T13:44:13.696 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1717056672114):Number of requests made: 1; Number of events received: 1000; Number of duplicated events filtered out: 0; Number of events generated and sent: 1000; Average of events per second: 5.507.
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
2024-05-30T13:44:13.696 INFO InputProcess::QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1717056672114):Number of requests made: 1; Number of events received: 24168; Number of duplicated events filtered out: 0; Number of events generated and sent: 24168; Average of events per second: 1130.494.
The value @devo_pulling_id
is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that Pull
action in Devo’s search window.
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:
Edit the configuration file.
Change the value of the
start_time_in_utc
parameter to a different one.Save the changes.
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.
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 |
---|---|---|---|---|
| 100 | Error occurred while requesting from the Qualys server. Error message: | Error occurred on the qualys server | you’ll get error message. Kindly reach the developer with the message |
101 | The tokens provided are incorrect. Please specify the correct credentials | Tokens (username, password) is invalid or incorrect | Please provide the correct tokens (username , password) | |
102 | The provided tokens are valid but they do not have the permission to get data | No permission for provided credentials to get the data | Please get the required permission to fetch the data from the vendor. | |
103 | Unexpected HTTP error occurred at the Qualys server. {status code} | Unexpected HTTP error | Contact team in this case | |
| 300 | HTTP Error occurred while retrieving events from Qualys | This error happens when the collector tries to fetch the data from API. | In this error you will find the HTTP error code as well as the summary and details. |
301 | Some error occurred while retrieving events from Qualys server. Error details: | Some exceptions occurred while making the API request. | Reach out to the developer with the exact error message. |
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-05-30T13:40:57.065 INFO MainProcess::MainThread -> Initialized all object from "MainProcess" process 2024-05-30T13:40:57.065 INFO MainProcess::MainThread -> OutputProcess - Starting thread (executing_period=120s) 2024-05-30T13:40:57.067 INFO MainProcess::MainThread -> InputProcess - Starting thread (executing_period=120s) 2024-05-30T13:40:57.067 INFO OutputProcess::MainThread -> Process started 2024-05-30T13:40:57.069 INFO MainProcess::MainThread -> Started all object from "MainProcess" process 2024-05-30T13:40:57.069 INFO InputProcess::MainThread -> Process Started 2024-05-30T13:40:57.089 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,predefined) Starting the execution of init_variables() 2024-05-30T13:40:57.089 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread 2024-05-30T13:40:57.089 INFO InputProcess::MainThread -> Validating service metadata 2024-05-30T13:40:57.089 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T13:40:57.089 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread 2024-05-30T13:40:57.089 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T13:40:57.090 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread 2024-05-30T13:40:57.090 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds) 2024-05-30T13:40:57.090 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread 2024-05-30T13:40:57.090 INFO InputProcess::MainThread -> Validating defined module definition 2024-05-30T13:40:57.090 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.091 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence. 2024-05-30T13:40:57.092 INFO InputProcess::MainThread -> Validating common input config 2024-05-30T13:40:57.093 INFO InputProcess::MainThread -> Validating service input config 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Running overriding rules 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead. 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> Running custom validation rules 2024-05-30T13:40:57.095 INFO InputProcess::MainThread -> QualysFimBasePuller(qualys_fim,123123,fim_events,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-02-16T12:30:03.484 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Number of available senders: 1, sender manager internal queue size: 0 2024-02-16T12:30:03.485 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> enqueued_elapsed_times_in_seconds_stats: {} 2024-02-16T12:30:03.485 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False} 2024-02-16T12:30:03.485 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Lookup - Total number of messages sent: 0, messages sent since "2024-02-16 06:55:03.484110+00:00": 0 (elapsed 0.000 seconds) 2024-02-16T12:30:03.535 INFO InputProcess::InputStatsThread -> Input metrics sent: 3 2024-02-16T12:30:03.536 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 9, total_bytes: 6919 (60.001823 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 |
---|---|
| In charge of delivering internal metrics to Devo such as logging traces or metrics. |
| 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 |
---|---|
| Displays the number of concurrent senders available for the given Sender Service. |
| 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. |
| Displays the number of events from the last time and following the given example, the following conclusions can be obtained:
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-05-30T17:18:27.087 INFO OutputProcess::MainThread -> [GC] global: 32.7% -> 32.7%, process: RSS(44.05MiB -> 44.05MiB), VMS(928.46MiB -> 928.46MiB) 2024-05-30T17:23:27.140 INFO InputProcess::MainThread -> [GC] global: 32.1% -> 32.1%, process: RSS(46.57MiB -> 46.57MiB), VMS(784.46MiB -> 784.46MiB)
Differences between RSS
and VMS
memory usage:
RSS
is the Resident Set Size, which is the actual physical memory the process is usingVMS
is the Virtual Memory Size which is the virtual memory that process is using
Change log
Release | Released on | Release type | Details | Recommendations |
---|---|---|---|---|
| FIRST RELEASE | Released the first version of the Qualys FIM collector. |
| |
| BUG FIX | Token expiration issue |
|
- No labels