Trellix Data Loss Prevention (DLP) delivers unprecedented protection for sensitive and proprietary information from the keyboard to the cloud.
Devo collector features
Feature
Details
Allow parallel downloading (multipod)
not allowed
Running environments
collector server
Populated Devo events
table
Flattening preprocessing
no
Data sources
Data source
Description
API endpoint
Collector service name
Devo table
Available from release
incident
Get all the incident event type.
/dpim/v2/incident
dpim_incident
dlp.trellix.dpim.incident
v1.0.0
For more information on how the events are parsed, visit our page.
Flattening preprocessing
Data source
Collector service
Optional
Flattening details
incident
dpim_incident
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 Trellix API.
username
The username to generate the auth token for authentication.
password
The username to generate the auth token for authentication.
The auth token timeout specified in Trellix DLP official documentation is 300 seconds, but we are using it as 280 seconds as the token expires around that time.
Accepted authentication methods
Authentication method
api_key
username
password
Bearer auth token
REQUIRED
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.
dpim incident
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-07-12T12:37:20.608 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-07-12T12:37:20.608 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-07-12T12:37:20.608 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_2) -> Starting thread (every 300 seconds)
2024-07-12T12:37:20.608 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_2) -> Starting thread
2024-07-12T12:37:20.608 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-07-12T12:37:20.609 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_2) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_2) -> Nothing retrieved from the persistence.
2024-07-12T12:37:20.610 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-07-12T12:37:20.610 INFO InputProcess::MainThread -> Running overriding rules
2024-07-12T12:37:20.611 INFO InputProcess::MainThread -> Overriding rule #1 - service key <override_tag> with value <my.app.trellix.dlp> overrides definition key <tag> with value <None> when the first is not <None>
2024-07-12T12:37:20.611 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-07-12T12:37:20.611 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-07-12T12:37:20.611 INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-07-12T12:37:20.611 INFO InputProcess::MainThread -> Running custom validation rules
2024-07-12T12:37:20.615 INFO InputProcess::MainThread -> TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) Finalizing the execution of init_variables()
2024-07-12T12:37:20.617 INFO InputProcess::MainThread -> InputThread(trellix_dlp,65768) - Starting thread (execution_period=60s)
2024-07-12T12:37:20.617 INFO InputProcess::MainThread -> ServiceThread(trellix_dlp,65768,incidents,predefined) - Starting thread (execution_period=60s)
2024-07-12T12:37:20.617 INFO InputProcess::MainThread -> TrellixDLPPullerSetup(trellix_dlp_collector,trellix_dlp#65768,incidents#predefined) -> Starting thread
2024-07-12T12:37:20.618 WARNING InputProcess::TrellixDLPPullerSetup(trellix_dlp_collector,trellix_dlp#65768,incidents#predefined) -> The token/header/authentication has not been created yet
2024-07-12T12:37:20.620 INFO InputProcess::MainThread -> TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) - Starting thread
2024-07-12T12:37:20.621 WARNING InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> Waiting until setup will be executed
2024-07-12T12:37:20.640 INFO OutputProcess::MainThread -> [GC] global: 93.4% -> 93.5%, process: RSS(41.10MiB -> 41.97MiB), VMS(926.02MiB -> 926.02MiB)
2024-07-12T12:37:20.645 INFO InputProcess::MainThread -> [GC] global: 93.5% -> 93.5%, process: RSS(40.12MiB -> 40.12MiB), VMS(422.00MiB -> 422.00MiB)
2024-07-12T12:37:21.052 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/pulkit/devo/collectors/devo-collector-trellix-dlp/certs/chain.crt", "cert_path": "/home/pulkit/devo/collectors/devo-collector-trellix-dlp/certs/int-if-integrations-india.crt", "key_path": "/home/pulkit/devo/collectors/devo-collector-trellix-dlp/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-APAC-0049", session_id: "128927996684944"
2024-07-12T12:37:29.632 INFO InputProcess::TrellixDLPPullerSetup(trellix_dlp_collector,trellix_dlp#65768,incidents#predefined) -> Token is valid. Skipping the generation of new auth token
2024-07-12T12:37:29.633 INFO InputProcess::TrellixDLPPullerSetup(trellix_dlp_collector,trellix_dlp#65768,incidents#predefined) -> Token is valid. Skipping the generation of new auth token
2024-07-12T12:37:29.633 INFO InputProcess::TrellixDLPPullerSetup(trellix_dlp_collector,trellix_dlp#65768,incidents#predefined) -> Setup for module <TrellixDLPPuller> has been successfully executed
2024-07-12T12:37:30.631 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) Starting the execution of pre_pull()
2024-07-12T12:37:30.631 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> Reading persisted data
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-07-12T12:37:30.638 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> Pull Started
2024-07-12T12:37:30.639 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> Fetching data From : 2024-01-29T00:00:00.000Z
2024-07-12T12:37:35.855 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> Sent 372 incidents events to Devo.
2024-07-12T12:37:35.855 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1720768050631):Number of requests made: 1; Number of events received: 372; Number of duplicated events filtered out: 0; Number of events generated and sent: 372; Average of events per second: 71.308.
2024-07-12T12:37:36.206 INFO OutputProcess::DevoSender(standard_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(standard_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/home/pulkit/devo/collectors/devo-collector-trellix-dlp/certs/chain.crt", "cert_path": "/home/pulkit/devo/collectors/devo-collector-trellix-dlp/certs/int-if-integrations-india.crt", "key_path": "/home/pulkit/devo/collectors/devo-collector-trellix-dlp/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-APAC-0049", session_id: "128927986295952"
2024-07-12T12:37:41.589 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> Sent 500 incidents events to Devo.
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
2024-07-12T12:37:41.589 INFO InputProcess::TrellixDLPPuller(trellix_dlp,65768,incidents,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1720768050631):Number of requests made: 2; Number of events received: 872; Number of duplicated events filtered out: 0; Number of events generated and sent: 872; Average of events per second: 79.628.
Restart the persistance
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 initial_start_time_in_utc_value 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.
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
InitVariablesError
1
initial_start_time_in_utc is not set as per the datetime_format : {datetime_format}
The date in config is not as per required format
Ensure the date format is correct.
InitVariablesError
2
Date {initial_start_time_str} is in the future
The date in config is greater than current time
Ensure the datetime is less than current time
SetupError
100
HTTP Error occurred while generating auth token from trellix server
Wrong credentials
Check the credentials and ensure that the collector has the necessary permissions to access the Trellix API.
SetupError
101
Some error occurred while generating auth token from trellix server. Error details: {e}
Generate auth token api failed
Contact the developer with exact error message.
SetupError
102
Unable to generate auth token with status code as {response.status_code}
Generate auth token api failed
Contact the developer with exact error message.
SetupError
103
HTTP Error occurred while fetching apim incident from trellix server
Trellix API call is failing
Check the credentials and ensure that the collector has the necessary permissions to access the Trellix API.
PullError
300
HTTP Error occurred while fetching apim incident from trellix server
Trellix API call is failing
Check the credentials and ensure that the collector has the necessary permissions to access the Trellix API.
PullError
301
Some error occurred while fetching apim incident from trellix server. Error details: {e}
Trellix API call is failing
Contact the developer with exact error message.
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
