Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

Overview

Automox cross-platform solution which simplifies and automates critical patching, software updates, security configurations, and custom scripting across a diversity of endpoints. It helps them easily act in real-time to drive greater strategic value and security outcomes for their business.

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

api_key

Credential api_key

organization_id

Credential organization_id

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

Devo collector features

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

Software package by device id

This service ingests all the packets of a certain device identified by an id.

/packages

software_packages_by_device_id

itops.automox.api.package

v1.0.0

All packages for all devices

This service ingests all packets from all registered devices.

/packages

all_packages_for_all_devices

itops.automox.api.package

v1.0.0

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

Vendor setup

There are some requirements to run this collector. You will need to:

Follow these steps:

Accepted authentication methods

Authentication Method

Username

Password

api_key

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.

All packages for all devices

 Verify data collection

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component

Description

Setup

The setup module is in charge of authenticating the service and managing the token expiration when needed.

Puller

The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

2023-01-23T11:24:19.182	INFO InputProcess::MainThread -> InputThread(automox_data_puller,12345) - Starting thread (execution_period=60s)
2023-01-23T11:24:19.182	INFO InputProcess::MainThread -> ServiceThread(automox_data_puller,12345,all_packages_for_all_devices,predefined) - Starting thread (execution_period=60s)
2023-01-23T11:24:19.183	INFO InputProcess::MainThread -> AutomoxDataPullerSetup(automox_collector,automox_data_puller#12345,all_packages_for_all_devices#predefined) -> Starting thread
2023-01-23T11:24:19.183	INFO InputProcess::MainThread -> AutomoxAllPackagesForAllDevicesDataPuller(automox_data_puller,12345,all_packages_for_all_devices,predefined) - Starting thread
2023-01-23T11:24:19.183 WARNING InputProcess::AutomoxAllPackagesForAllDevicesDataPuller(automox_data_puller,12345,all_packages_for_all_devices,predefined) -> Waiting until setup will be executed
2023-01-23T11:24:19.184	INFO InputProcess::AutomoxDataPullerSetup(automox_collector,automox_data_puller#12345,all_packages_for_all_devices#predefined) -> Setup for module <AutomoxAllPackagesForAllDevicesDataPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

Note that the PrePull action is executed only one time before the first run of the Pull action.

INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Pull Started
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):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: 327.207.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 2; Number of events received: 1000; Number of duplicated events filtered out: 0; Number of events generated and sent: 1000; Average of events per second: 347.990.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 500
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 3; Number of events received: 1500; Number of duplicated events filtered out: 0; Number of events generated and sent: 1500; Average of events per second: 352.534.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 259
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Number of events sent to Devo: 259
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 4; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 313.086.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/orgs/104944/packages
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Total number of events: 0
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> No data is present on page.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 5; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 260.893.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 5; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 260.881.
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> The data is up to date!
INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Data collection completed. Elapsed time: 6.747 seconds. Waiting for 53.253 second(s) until the next one

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

INFO InputProcess::AutomoxSoftwarePackagesForAllDevices(automox,12345,all_packages_for_all_devices,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1679983458939):Number of requests made: 5; Number of events received: 1759; Number of duplicated events filtered out: 0; Number of events generated and sent: 1759; Average of events per second: 260.881.

The value @devo_pulling_id is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that Pull action in Devo’s search window.

 Restart the persistance

This service does not implement persistence.

 Troubleshooting

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error type

Error ID

Error message

Cause

Solution

SetupError

100

The remote data is not pullable with the given credentials. Check the error traces for details.

Not able to establish connection/ pull data due to incorrect credentials or account expired.

Re-check if the entered credentials are correct, and that the access token is expired or not

PullError

300

Error occurred while retrieving data from Automox server.

Invalid Api key OR Organization IDare passed.

Re-enter correct  Api key/Organization ID .

 

PullError

301

After multiple  retries still getting the too many requests error.

Automox only support 100 authenticated requests per second.

Re-run the collector 

after some time.

PullError

302

"Error in the request query : ___ .

Cause for this error will be you have enter invalid values in service parameters.

Check whether the parameters for that service are correct or not.

PullError

303

Api key OR Organization ID are incorrect. status code: 401. Error message: ___.

Incorrect Api key/Organization ID entered

Re-enter correct  Api key/Organization ID .

PullError

304

Your Organization's subscription does not allow access to this feature.

The subscription for your Organization's could have expired or it might not have access to API functions.

Check your subscription status through the Automox portal.

PullError

305

Api key is incorrect. status code: 401. Error message: ___.

API key that you enter is expired.

Use the Automox portal to get a new API key, then provide it to the collector..

PullError

306

The resource requested is not found OR check the Organization ID. Resource Url: ___.

There are two reasons:

1.The Organization’s ID is incorrect.

2.Entity not found for that particular query.

Check the Automox site to check whether there any data for that query.

PullError

307

Some thing is wrong with the query. Please provide the correct value in config.yaml file.

Enter invalid value in config.yaml file for that service.

Check whether the parameters for that service are correct or not.

PullError

308

Currently server is unavailable to process our request.

Automox Server is not able to fulfil the request for current service.

Re-run the collector 

after some time.

PullError

309

Unexpected error occurred at the Automox server.

Cause for this error will be written in the Error message on the console.

As there are number of causes for this error, check on the console as the reason is described and take action accordingly.

SetupError

100

The remote data is not pullable with the given credentials. Check the error traces for details.

Not able to establish connection/ pull data due to incorrect credentials or account expired.

Re-check if the entered credentials are correct, and that the access token is expired or not

PullError

300

Error occurred while retrieving data from Automox server.

Invalid Api key OR Organization IDare passed.

Re-enter correct  Api key/Organization ID .

 

PullError

301

After multiple  retries still getting the too many requests error.

Automox only support 100 authenticated requests per second.

Re-run the collector 

after some time.

PullError

302

"Error in the request query : ___ .

Cause for this error will be you have enter invalid values in service parameters.

Check whether the parameters for that service are correct or not.

PullError

303

Api key OR Organization ID are incorrect. status code: 401. Error message: ___.

Incorrect Api key/Organization ID entered

Re-enter correct  Api key/Organization ID .

PullError

304

Your Organization's subscription does not allow access to this feature.

The subscription for your Organization's could have expired or it might not have access to API functions.

Check your subscription status through the Automox portal.

PullError

305

Api key is incorrect. status code: 401. Error message: ___.

API key that you enter is expired.

Use the Automox portal to get a new API key, then provide it to the collector..

PullError

306

The resource requested is not found OR check the Organization ID. Resource Url: ___.

There are two reasons:

1.The Organization’s ID is incorrect.

2.Entity not found for that particular query.

Check the Automox site to check whether there any data for that query.

PullError

307

Some thing is wrong with the query. Please provide the correct value in config.yaml file.

Enter invalid value in config.yaml file for that service.

Check whether the parameters for that service are correct or not.

PullError

308

Currently server is unavailable to process our request.

Automox Server is not able to fulfil the request for current service.

Re-run the collector 

after some time.

PullError

309

Unexpected error occurred at the Automox server.

Cause for this error will be written in the Error message on the console.

As there are number of causes for this error, check on the console as the reason is described and take action accordingly.

Software packages by device id

 Verify data collection

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component

Description

Setup

The setup module is in charge of authenticating the service and managing the token expiration when needed.

Puller

The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

2023-01-23T11:24:19.182	INFO InputProcess::MainThread -> InputThread(automox_data_puller,12345) - Starting thread (execution_period=60s)
2023-01-23T11:24:19.182	INFO InputProcess::MainThread -> ServiceThread(automox_data_puller,12345,all_packages_for_all_devices,predefined) - Starting thread (execution_period=60s)
2023-01-23T11:24:19.183	INFO InputProcess::MainThread -> AutomoxDataPullerSetup(automox_collector,automox_data_puller#12345,all_packages_for_all_devices#predefined) -> Starting thread
2023-01-23T11:24:19.183	INFO InputProcess::MainThread -> AutomoxAllPackagesForAllDevicesDataPuller(automox_data_puller,12345,all_packages_for_all_devices,predefined) - Starting thread
2023-01-23T11:24:19.183 WARNING InputProcess::AutomoxAllPackagesForAllDevicesDataPuller(automox_data_puller,12345,all_packages_for_all_devices,predefined) -> Waiting until setup will be executed
2023-01-23T11:24:19.184	INFO InputProcess::AutomoxDataPullerSetup(automox_collector,automox_data_puller#12345,all_packages_for_all_devices#predefined) -> Setup for module <AutomoxAllPackagesForAllDevicesDataPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

Note that the PrePull action is executed only one time before the first run of the Pull action.

INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Pull Started
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/servers/2436430/packages
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Total number of events: 25
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Number of events sent to Devo: 25
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679982801715):Number of requests made: 1; Number of events received: 25; Number of duplicated events filtered out: 0; Number of events generated and sent: 25; Average of events per second: 22.583.2023-03-28T07:53:23.770    INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Response received from Automox server Resource Url: https://console.automox.com/api/servers/2436430/packages
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Total number of events: 0
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> No data is present on page.
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1679982801715):Number of requests made: 2; Number of events received: 25; Number of duplicated events filtered out: 0; Number of events generated and sent: 25; Average of events per second: 12.210.
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1679982801715):Number of requests made: 2; Number of events received: 25; Number of duplicated events filtered out: 0; Number of events generated and sent: 25; Average of events per second: 12.208.
INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,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:

INFO InputProcess::AutomoxSoftwarePackagesByDeviceId(automox,12345,software_packages_by_device_id,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1679982801715):Number of requests made: 2; Number of events received: 25; Number of duplicated events filtered out: 0; Number of events generated and sent: 25; Average of events per second: 12.208.

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.same pull action. You can use it to get the exact events downloaded in that Pull action in Devo’s search window.

 Restart the persistance

This service does not implement persistence.

 Troubleshooting

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error type

Error ID

Error message

Cause

Solution

SetupError

100

The remote data is not pullable with the given credentials. Check the error traces for details.

Not able to establish connection/ pull data due to incorrect credentials or account expired.

Re-check if the entered credentials are correct, and that the access token is expired or not

PullError

300

Error occurred while retrieving data from Automox server.

Invalid Api key OR Organization IDare passed.

Re-enter correct  Api key/Organization ID .

 

PullError

301

After multiple  retries still getting the too many requests error.

Automox only support 100 authenticated requests per second.

Re-run the collector 

after some time.

PullError

302

"Error in the request query : ___ .

Cause for this error will be you have enter invalid values in service parameters.

Check whether the parameters for that service are correct or not.

PullError

303

Api key OR Organization ID are incorrect. status code: 401. Error message: ___.

Incorrect Api key/Organization ID entered

Re-enter correct  Api key/Organization ID .

PullError

304

Your Organization's subscription does not allow access to this feature.

The subscription for your Organization's could have expired or it might not have access to API functions.

Check your subscription status through the Automox portal.

PullError

305

Api key is incorrect. status code: 401. Error message: ___.

API key that you enter is expired.

Use the Automox portal to get a new API key, then provide it to the collector..

PullError

306

The resource requested is not found OR check the Organization ID. Resource Url: ___.

There are two reasons:

1.The Organization’s ID is incorrect.

2.Entity not found for that particular query.

Check the Automox site to check whether there any data for that query.

PullError

307

Some thing is wrong with the query. Please provide the correct value in config.yaml file.

Enter invalid value in config.yaml file for that service.

Check whether the parameters for that service are correct or not.

PullError

308

Currently server is unavailable to process our request.

Automox Server is not able to fulfil the request for current service.

Re-run the collector 

after some time.

PullError

309

Unexpected error occurred at the Automox server.

Cause for this error will be written in the Error message on the console.

As there are number of causes for this error, check on the console as the reason is described and take action accordingly.

SetupError

100

The remote data is not pullable with the given credentials. Check the error traces for details.

Not able to establish connection/ pull data due to incorrect credentials or account expired.

Re-check if the entered credentials are correct, and that the access token is expired or not

PullError

300

Error occurred while retrieving data from Automox server.

Invalid Api key OR Organization IDare passed.

Re-enter correct  Api key/Organization ID .

 

PullError

301

After multiple  retries still getting the too many requests error.

Automox only support 100 authenticated requests per second.

Re-run the collector 

after some time.

PullError

302

"Error in the request query : ___ .

Cause for this error will be you have enter invalid values in service parameters.

Check whether the parameters for that service are correct or not.

PullError

303

Api key OR Organization ID are incorrect. status code: 401. Error message: ___.

Incorrect Api key/Organization ID entered

Re-enter correct  Api key/Organization ID .

PullError

304

Your Organization's subscription does not allow access to this feature.

The subscription for your Organization's could have expired or it might not have access to API functions.

Check your subscription status through the Automox portal.

PullError

305

Api key is incorrect. status code: 401. Error message: ___.

API key that you enter is expired.

Use the Automox portal to get a new API key, then provide it to the collector..

PullError

306

The resource requested is not found OR check the Organization ID. Resource Url: ___.

There are two reasons:

1.The Organization’s ID is incorrect.

2.Entity not found for that particular query.

Check the Automox site to check whether there any data for that query.

PullError

307

Some thing is wrong with the query. Please provide the correct value in config.yaml file.

Enter invalid value in config.yaml file for that service.

Check whether the parameters for that service are correct or not.

PullError

308

Currently server is unavailable to process our request.

Automox Server is not able to fulfil the request for current service.

Re-run the collector 

after some time.

PullError

309

Unexpected error occurred at the Automox server.

Cause for this error will be written in the Error message on the console.

As there are number of causes for this error, check on the console as the reason is described and take action accordingly.

Collector operations

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

 Verify collector operations

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

A successful run has the following output messages for the initializer module:

INFO MainThread -> (CollectorMultithreadingQueue) standard_queue_multithreading -> max_size_in_messages: 10000, max_size_in_mb: 1024, max_wrap_size_in_items: 100
WARNING MainThread -> [INTERNAL LOGIC] DevoSender::_validate_kwargs_for_method__init__ -> The <address> does not appear to be an IP address and cannot be verified: collector-us.devo.io
WARNING MainThread -> [OUTPUT] OutputLookupSenders -> <threshold_for_using_gzip_in_transport_layer> setting has been modified from 1.1 to 1.0 due to this configuration increases the Lookup sender performance.
WARNING MainThread -> [INTERNAL LOGIC] DevoSender::_validate_kwargs_for_method__init__ -> The <address> does not appear to be an IP address and cannot be verified: collector-us.devo.io
INFO MainThread -> [OUTPUT] OutputMultithreadingController(threatquotient_collector) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSender(standard_senders,devo_sender_0) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 600 seconds)
INFO MainThread -> [OUTPUT] DevoSenderManager(standard_senders,manager,devo_1)(devo_1) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSender(lookup_senders,devo_sender_0) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 600 seconds)
INFO MainThread -> [OUTPUT] DevoSenderManager(lookup_senders,manager,devo_1)(devo_1) -> Starting thread
INFO MainThread -> InitVariables Started
INFO MainThread -> start_time_value initialized
INFO MainThread -> verify_host_ssl_cert initialized
INFO MainThread -> event_fetch_limit_in_items initialized
INFO MainThread -> InitVariables Terminated
INFO MainThread -> [INPUT] InputMultithreadingController(threatquotient_collector) - Starting thread (executing_period=300s)
INFO MainThread -> [INPUT] InputThread(threatquotient_collector,threatquotient_data_puller#111) - Starting thread (execution_period=600s)
INFO MainThread -> [INPUT] ServiceThread(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread (execution_period=600s)
INFO MainThread -> [SETUP] ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread
INFO MainThread -> [INPUT] ThreatQuotientDataPuller(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

A successful run has the following output messages for the initializer module:

INFO 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

internal_senders

In charge of delivering internal metrics to Devo such as logging traces or metrics.

standard_senders

In charge of delivering pulled events to Devo.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace

Description

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders.

Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)

Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:

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

  • The last checkpoint timestamp was 2022-06-28 10:39:22.511671+00:00.

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

  • Those 21 events required 0.007 seconds to be delivered.

By default these traces will be shown every 10 minutes.

 Check memory usage

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

  • The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.

  • The global pressure of the available memory is displayed in the global value.

  • All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

INFO InputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(34.50MiB -> 34.08MiB), VMS(410.52MiB -> 410.02MiB)
INFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB -> 705.28MiB)

Differences between RSS and VMS memory usage:

  • RSS is the Resident Set Size, which is the actual physical memory the process is using

  • VMS is the Virtual Memory Size which is the virtual memory that process is using

Change log for v1.x.x

Release

Released on

Release type

Details

Recommendations

v1.0.0

NEW FEATURE

New features:

Released first version of Automox collector with the following services:

  • List Software Packages for Specific Device: Retrieves the software packages for the specified device. Packages include pending updates and currently installed updates/applications.

  • List All Software Packages for All Devices: This will list all pending/installed updates, and all installed applications, for all devices in a given organization.

Recommended version

 

 

  • No labels