Menlo Security Collector

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

Overview

This collector fetches logs from Menlo Security APIs.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (multipod)	not allowed
Running environments	collector server
Populated Devo events	table
Flattening preprocessing	no
Requires IP Whitelisting	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
Menlo Security API	Get all the web type logs	api/rep/v2/fetch/client_select	web	rbi.menlo.web	v1.2.0
Menlo Security API	Get all the audit type logs	api/rep/v2/fetch/client_select	audit	rbi.menlo.audit	v1.2.0
Menlo Security API	Get all the email type logs	api/rep/v2/fetch/client_select	email	rbi.menlo.email	v1.2.0
Menlo Security API	Get all the smtp type logs	api/rep/v2/fetch/client_select	smtp	rbi.menlo.smtp	v1.2.0
Menlo Security API	Get all the attachment type logs	api/rep/v2/fetch/client_select	attachment	rbi.menlo.attachment	v1.2.0

Flattening preprocessing

Data source	Collector service	Optional	Flattening details

Data source	Collector service	Optional	Flattening details
Menlo Security API	All the services	`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

Setting	Details
token	The Token for Menlo API.

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.

web 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 an organized way and delivering the events via SDK.

Setup output

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

2024-10-30T13:58:32.249    INFO InputProcess::MainThread -> MenloPullerSetup(menlo_collector,menlo#12345,web#predefined) -> Starting thread
2024-10-30T13:58:32.257 WARNING InputProcess::MenloPuller(menlo#12345,web#predefined) -> Waiting until setup will be executed
2024-10-30T13:58:35.201    INFO InputProcess::MenloPullerSetup(menlo_collector,menlo#12345,web#predefined) -> Setup for module <MenloPuller> 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-10-30T14:04:06.676    INFO InputProcess::MenloPuller(menlo#12345,web#predefined) -> Pull Started
2024-10-30T14:04:06.677    INFO InputProcess::MenloPuller(menlo#12345,web#predefined) -> Pulling data from 2024-10-30 08:32:03+00:00
2024-10-30T14:04:38.748    INFO InputProcess::MenloPuller(menlo#12345,web#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1730277246659):Number of requests made: 11; Number of events received: 10279; Number of duplicated events filtered out: 0; Number of events generated and sent: 10279; Average of events per second: 320.496.
2024-10-30T14:04:38.749    INFO InputProcess::MenloPuller(menlo#12345,web#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:

2024-10-30T14:04:38.748    INFO InputProcess::MenloPuller(menlo#12345,web#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1730277246659):Number of requests made: 11; Number of events received: 10279; Number of duplicated events filtered out: 0; Number of events generated and sent: 10279; Average of events per second: 320.496.

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.

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
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 not in the required period	Ensure the date period is correct.
SetupError	100	Some error occurred while testing Menlo logs for log_type: {log_type}, error: {e}	Menlo API call is failing	Check the credentials and ensure that the collector has the necessary permissions to access the Menlo API.
PullError	300	Some error occurred while fetching Menlo logs for log_type: {log_type}, error: {e}	Menlo API call is failing	Contact the Developer with exact error message

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

Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes.

To enable this option you just need to edit the configuration file and change the debug_status parameter from false to true and restart the collector.
To disable this option, you just need to update the configuration file and change the debug_status parameter from true to false and restart the collector.

For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode.

Change log for v1.x.x

Release	Released on	Release type	Details	Recommendations

Release

Released on

Release type

Details

Recommendations

v1.2.0

30 Oct 2024

NEW FEATURE

Bug Fixes

New features:

Updated to DCSDK 1.13.1
Update to Docker Image 1.3.1

Bug fixes:

Fixed the missing logs bug.

Recommended Version