Trend Micro Email Security collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Minimum configuration required for basic pulling ] [ 5 Accepted authentication methods ] [ 6 Run the collector ] [ 7 Collector services detail ] [ 8 Collector operations ] [ 9 Change log ]

Overview

Trend Micro Email Security screens out malicious senders and analyzes content to filter out spam. It examines sender authenticity and reputation and defends against malicious URLs.

The Trend Micro Email Security collector allows users to fetch policy event logs, allowed and blocked mail traffic, and user directory data.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table`
Flattening preprocessing	`yes`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
Mail Tracking Logs	Fetch mail tracking logs for all available domains	`/api/v1/log/mailtrackinglog`	`mail_tracking_logs`	`mail.trend_micro.email_security.mail_tracking`	`v1.0.0`
Policy Event Logs	Fetch policy event logs for all available domains	`/api/v1/log/policyeventlog`	`policy_event_logs`	`mail.trend_micro.email_security.policy_event`	`v1.0.0`
Directory Users	Fetch users for all domains	`/api/v1/domains/<domain>/users`	`directory_users`	`mail.trend_micro.email_security.directory_user`	`v1.0.0`

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

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

override_base_url

By default, the collector will use api.tmes.trendmicro.com. If your base URL is any other value, use this parameter to indicate the new base URL.

All available API base URLs can be found in this article.

username

The username associated with the API key.

api_key

The Trend Micro Email Security API key. See here for generation instructions.

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	Username

Authentication method	API Key	Username
`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.

Events service

Setup output

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

2023-06-28T22:10:09.542    INFO InputProcess::MainThread -> TMESPullerSetup(unknown,trend_micro_email_security#10000,directory_users#predefined) -> Starting thread
2023-06-28T22:10:10.292    INFO InputProcess::TMESPullerSetup(unknown,trend_micro_email_security#10000,directory_users#predefined) -> Successfully authenticated to the remote source.
2023-06-28T22:10:10.292    INFO InputProcess::TMESPullerSetup(unknown,trend_micro_email_security#10000,directory_users#predefined) -> Setup for module <TMESLogPuller> 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.

InputProcess::TMESDirectoryUsersPuller(trend_micro_email_security,10000,directory_users,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1688015679009):Number of requests made: 6; Number of events received: 50069; Number of duplicated events filtered out: 0; Number of events generated and sent: 50069; Average of events per second: 6754.261.
2023-06-28T22:14:46.425    INFO InputProcess::TMESDirectoryUsersPuller(trend_micro_email_security,10000,directory_users,predefined) -> The data is up to date!
2023-06-28T22:14:46.426    INFO InputProcess::TMESDirectoryUsersPuller(trend_micro_email_security,10000,directory_users,predefined) -> Data collection completed. Elapsed time: 7.417 seconds. Waiting for 3592.583 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 ThreatQuotientDataPuller(threatquotient_collector,threatquotient_data_puller#111,events#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1655983326.290848): Number of requests performed: 2; Number of events received: 52; Number of duplicated events filtered out: 0; Number of events generated and sent: 52 (from 52 unflattened events); Average of events per second: 92.99414315733.

No persistence restart is available for this service. All users available at pull time will be fetched and sent to Devo.

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

InitiVariablesError

1

Invalid start_time_in_utc: {ini_start_str}. Must be in parseable datetime format.

The configured start_time_in_utc_value is not in a valid datetime format.

Update the start_time_in_utc_value to be in an accepted datetime format.

InitiVariablesError

2

Invalid start_time_in_utc: {ini_start_str}. Must be in the past.

The configured start_time_in_utc_value is a future datetime.

Update the start_time_in_utc_value to be a past datetime.

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.

Standard - Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": 0 (elapsed 0.000 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 2023-01-10 16:09:16.116750+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

Change log

Release	Released on	Release type	Details	Recommendations

Release	Released on	Release type	Details	Recommendations
`v1.0.0`	Sep 6, 2023	INITIAL RELEASE	-	`Recommended version`