Airlock enables you to easily create and manage secure whitelists in dynamically changing computing environments.
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
audit
Get all the audit events
logging/exechistories
audit_logs
endpoint.airlock.allowlist.audit
v1.0.0
For more information on how the events are parsed, visit our page.
Flattening preprocessing
Data source
Collector service
Optional
Flattening details
audit
audits
yes
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
api_key
The api key for Airlock Digital.
See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.
Accepted authentication methods
Authentication method
api_key
credentials
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.
audit_logs
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:
2024-04-23T05:22:17.756 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-04-23T05:22:17.757 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-04-23T05:22:17.757 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-04-23T05:22:17.757 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_2) -> Starting thread (every 300 seconds)
2024-04-23T05:22:17.758 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_2) -> Starting thread
2024-04-23T05:22:17.759 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-04-23T05:22:17.759 INFO InputProcess::MainThread -> Running overriding rules
2024-04-23T05:22:17.759 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-04-23T05:22:17.759 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-04-23T05:22:17.760 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-04-23T05:22:17.760 INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-04-23T05:22:17.760 INFO InputProcess::MainThread -> Running custom validation rules
2024-04-23T05:22:17.760 INFO InputProcess::MainThread -> Creating API client.
2024-04-23T05:22:17.761 INFO InputProcess::MainThread -> Created request client: <agent.modules.airlock_digital.commons.airlock_digital_client.AirLockDigitalClient object at 0x7f49302beeb0>
2024-04-23T05:22:17.761 INFO InputProcess::MainThread -> AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) Finalizing the execution of init_variables()
2024-04-23T05:22:17.765 INFO InputProcess::MainThread -> InputThread(airlock_digital,16534) - Starting thread (execution_period=60s)
2024-04-23T05:22:17.765 INFO InputProcess::MainThread -> ServiceThread(airlock_digital,16534,audit_logs,predefined) - Starting thread (execution_period=60s)
2024-04-23T05:22:17.765 INFO InputProcess::MainThread -> AirlockDigitalPullerSetup(airlock_digital_collector,airlock_digital#16534,audit_logs#predefined) -> Starting thread
2024-04-23T05:22:17.766 INFO InputProcess::MainThread -> AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) - Starting thread
2024-04-23T05:22:17.767 WARNING InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Waiting until setup will be executed
2024-04-23T05:22:17.801 INFO OutputProcess::MainThread -> [GC] global: 56.1% -> 56.2%, process: RSS(41.84MiB -> 42.09MiB), VMS(928.03MiB -> 928.03MiB)
2024-04-23T05:22:17.810 INFO InputProcess::MainThread -> [GC] global: 56.2% -> 56.2%, process: RSS(40.99MiB -> 40.99MiB), VMS(495.76MiB -> 495.76MiB)
2024-04-23T05:22:18.344 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/nikhilgoyal/devo-collector-airlock-digital/certs/chain.crt", "cert_path": "/home/nikhilgoyal/devo-collector-airlock-digital/certs/int-if-integrations-india.crt", "key_path": "/home/nikhilgoyal/devo-collector-airlock-digital/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-APAC-0050", session_id: "139952364898912"
2024-04-23T05:22:18.643 INFO InputProcess::AirlockDigitalPullerSetup(airlock_digital_collector,airlock_digital#16534,audit_logs#predefined) -> Setup for module <AirlockDigitalPuller> 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-04-23T05:22:18.778 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Pull Started
2024-04-23T05:22:18.779 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Retrieving audit_logs event(s) from checkpoint:
2024-04-23T05:22:19.686 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Retrieved 1 audit_logs event(s)
2024-04-23T05:22:19.690 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Updating the persistence
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
2024-04-23T05:22:19.690 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1713829938768):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 1.097.
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 persistence
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 simply restarting the collector. It is to be noted that the API uses checkpoint as a reference to fetch data, which is been used in persistence internally but there is no way to reset it using the checkpoint.
Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.
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
Error occurred while validating api key from the Airlock Digital server.
API Key or base url is not correct.
Make sure that the base url and the API key are correct.
PullError
300
HTTP Error occurred while retrieving events from Airlock Digital server
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 Airlock Digital 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.
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:
2024-04-23T09:35:50.790 INFO OutputProcess::MainThread -> Process started
2024-04-23T09:35:50.796 INFO MainProcess::MainThread -> Started all object from "MainProcess" process
2024-04-23T09:35:50.796 INFO InputProcess::MainThread -> Process Started
2024-04-23T09:35:50.916 INFO InputProcess::MainThread -> AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) Starting the execution of init_variables()
2024-04-23T09:35:50.917 INFO InputProcess::MainThread -> Validating service metadata
2024-04-23T09:35:50.923 INFO InputProcess::MainThread -> Validating defined module definition
2024-04-23T09:35:50.925 INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2024-04-23T09:35:50.926 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_2) -> Starting thread (every 300 seconds)
2024-04-23T09:35:50.927 INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_2) -> Starting thread
2024-04-23T09:35:50.928 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-04-23T09:35:50.929 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-04-23T09:35:50.929 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_2) -> Starting thread (every 300 seconds)
2024-04-23T09:35:50.930 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_2) -> Starting thread
2024-04-23T09:35:50.930 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-04-23T09:35:50.931 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-04-23T09:35:50.932 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-04-23T09:35:50.932 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-04-23T09:35:50.932 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_2) -> Starting thread (every 300 seconds)
2024-04-23T09:35:50.933 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_2) -> Starting thread
2024-04-23T09:35:50.934 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-04-23T09:35:50.934 INFO InputProcess::MainThread -> Validating common input config
2024-04-23T09:35:50.934 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-04-23T09:35:50.937 INFO InputProcess::MainThread -> Validating service input config
2024-04-23T09:35:50.939 INFO InputProcess::MainThread -> Running overriding rules
2024-04-23T09:35:50.940 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-04-23T09:35:50.940 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-04-23T09:35:50.940 INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-04-23T09:35:50.940 INFO InputProcess::MainThread -> Running custom validation rules
2024-04-23T09:35:50.941 INFO InputProcess::MainThread -> Creating API client.
2024-04-23T09:35:50.941 INFO InputProcess::MainThread -> Created request client: <agent.modules.airlock_digital.commons.airlock_digital_client.AirLockDigitalClient object at 0x7fcfdde52ca0>
2024-04-23T09:35:50.941 INFO InputProcess::MainThread -> AirlockDigitalPuller(airlock_digital,16534,audit_logs,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-04-23T09:36:49.750 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1713845152952):Number of requests made: 62; Number of events received: 928; Number of duplicated events filtered out: 0; Number of events generated and sent: 928; Average of events per second: 16.340.
2024-04-23T09:36:49.751 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Retrieving audit_logs event(s) from checkpoint: 662733d830fd6a1bc33b592c
2024-04-23T09:36:50.654 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Retrieved 0 audit_logs event(s)
2024-04-23T09:36:50.656 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Updating the persistence
2024-04-23T09:36:50.657 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1713845152952):Number of requests made: 63; Number of events received: 928; Number of duplicated events filtered out: 0; Number of events generated and sent: 928; Average of events per second: 16.084.
2024-04-23T09:36:50.657 INFO InputProcess::AirlockDigitalPuller(airlock_digital,16534,audit_logs,predefined) -> Retrieving audit_logs event(s) from checkpoint: 662733d830fd6a1bc33b592c
2024-04-23T09:36:51.015 INFO InputProcess::InputStatsThread -> Input metrics sent: 3
2024-04-23T09:36:51.017 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 289, total_bytes: 215435 (60.083796 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: 0, messages sent since "2024-02-16 06:55:03.484110+00:00": 0 (elapsed 0.000 seconds)
Displays 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 2024-02-16 06:55:03.484110+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.
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
