To run this collector, there are some configurations detailed below that you need to consider.
Configuration
Details
Configuration
Details
Administrative access to the Trend Micro XDR portal.
You will need to have administrative access to the Trend Micro XDR portal in order to retrieve the data.
API key
Create an API key associated with an administrative user to authenticate the collector.
Refer to the Vendor setup section to know more about these configurations.
Overview
Trend Micro Vision One is a purpose-built threat defense platform that provides added value and new benefits beyond XDR solutions, allowing you to see more and respond faster. Providing deep and broad extended detection and response (XDR) capabilities that collect and automatically correlate data across multiple security layers —email, endpoints, servers, cloud workloads, and networks— Trend Micro Vision One prevents the majority of attacks with automated protection.
Create an API key associated with an administrative user to authenticate the collector.
Follow these steps to obtain an access token:
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
Setting
Details
token
The token obtained from Trend Micro Vision One for authentication.
See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.
Accepted authentication methods
Authentication method
token
Authentication method
token
token
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.
Events service
Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.
This service has the following components:
Component
Description
Component
Description
Setup
The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller
The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.
Setup output
A successful run has the following output messages for the setup module:
INFO InputProcess::MainThread -> VisionOnePullerSetup(unknown,trend_micro_vision_one#23,audit#predefined) -> Starting thread
INFO InputProcess::VisionOnePullerSetup(unknown,trend_micro_vision_one#23,audit#predefined) -> Setup for module <VisionOnePuller> has been successfully executed
Puller output
A successful initial run has the following output messages for the puller module:
INFO InputProcess::MainThread -> VisionOnePuller(trend_micro_vision_one,23,audit,predefined) - Starting thread
WARNING InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Waiting until setup will be executed
WARNING InputProcess::VisionOnePullerSetup(unknown,trend_micro_vision_one#23,audit#predefined) -> The token/header/authentication has not been created yet
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> VisionOnePuller(trend_micro_vision_one,23,audit,predefined) Starting the execution of pre_pull()
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Reading persisted data
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Data retrieved from the persistence: {'initial_start_time_in_utc': '2022-11-02T00:00:00Z', 'last_event_time_in_utc': '2022-12-16T19:03:04Z', 'last_ids': ['1c09b778f203997ab5bc6302a45c93f18d2efb78d56fc94433b1e12baf30ba80'], '@persistence_version': 1}
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Running the persistence upgrade steps
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Running the persistence corrections steps
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Running the persistence corrections steps
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Detected initial start time in UTC change: {'values_changed': {'root': {'new_value': '2022-11-03T00:00:00Z', 'old_value': '2022-11-02T00:00:00Z'}}}. Resetting state to {'initial_start_time_in_utc': '2022-11-03T00:00:00Z', 'last_event_time_in_utc': '2022-11-03T00:00:00Z', 'last_ids': [], '@persistence_version': 1}
WARNING InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: {'initial_start_time_in_utc': '2022-11-02T00:00:00Z', 'last_event_time_in_utc': '2022-12-16T19:03:04Z', 'last_ids': ['1c09b778f203997ab5bc6302a45c93f18d2efb78d56fc94433b1e12baf30ba80'], '@persistence_version': 1}. New content: {'initial_start_time_in_utc': '2022-11-03T00:00:00Z', 'last_event_time_in_utc': '2022-11-03T00:00:00Z', 'last_ids': [], '@persistence_version': 1}
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Updating the persistence
WARNING InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Persistence has been updated successfully
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> VisionOnePuller(trend_micro_vision_one,23,audit,predefined) Finalizing the execution of pre_pull()
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Starting data collection every 60 seconds
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Pull Started
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Retrieving/sending audit events having loggedDateTime between 2022-11-03T00:00:00+00:00 and 2023-01-10T14:23:04.419818+00:00 via get_audit_logs_batch method
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Updating the persistence
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673360584419):Number of requests made: 1; Number of events received: 20; Number of duplicated events filtered out: 0; Number of events generated and sent: 20; Average of events per second: 16.337.
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Retrieving/sending audit events having loggedDateTime between 2022-12-16T19:03:04+00:00 and 2023-01-10T14:23:04.419818+00:00 via get_audit_logs_batch method
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673360584419):Number of requests made: 2; Number of events received: 20; Number of duplicated events filtered out: 0; Number of events generated and sent: 20; Average of events per second: 8.182.
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673360584419):Number of requests made: 2; Number of events received: 20; Number of duplicated events filtered out: 0; Number of events generated and sent: 20; Average of events per second: 8.174.
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> The data is up to date!
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Data collection completed. Elapsed time: 2.488 seconds. Waiting for 57.512 second(s) until the next one
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Pull Started
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> is_data_up_to_date: starts a new pull cycle
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Retrieving/sending audit events having loggedDateTime between 2022-12-16T19:03:04+00:00 and 2023-01-10T14:24:04.426632+00:00 via get_audit_logs_batch method
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1673360644426):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673360644426):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> The data is up to date!
INFO InputProcess::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Data collection completed. Elapsed time: 1.176 seconds. Waiting for 58.824 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::VisionOnePuller(trend_micro_vision_one,23,audit,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1673360584419):Number of requests made: 2; Number of events received: 20; Number of duplicated events filtered out: 0; Number of events generated and sent: 20; Average of events per second: 8.174.
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 historical_date_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.
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
Error type
Error ID
Error message
Cause
Solution
SetupError
101
Client fetch method [...] is not valid
The client_fetch_method is not valid.
Contact support, this is a problem in the internal collector definitions.
102
HTTP Error while making request to Vision One API:
The API returns an 401 or 403 error, likely the access token is not valid.
Make sure that the token is valid, generate a new one in Trend Micro if needed.
Remember: Access token has an expiration date
103
Error while making request to Vision One API: [...]
Other error accessing the API. For instance, there is a network issue.
The solution depends of the specific error message.
InitVariablesError
1
Error while fetching collector variables: [..]
One of required parameters is absent or a parameter has an incorrect type
Add the parameter or correct the type.
2
Error validating collector variables: [...]
One of the parameters has the correct type but it is not correct.
For instance, a date is not a valid date, or a number is out of its range.
Correct the parameter in the configuration file.
3
Error while creating client: [..]
Other error inizializing the collector.
Solution depends on specific 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:
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:
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
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
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.
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.
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
