Cohesity 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 Vendor setup ] [ 8 Run the collector ] [ 9 Collector services detail ] [ 10 Collector operations ] [ 11 Change log ]

Overview

Cohesity gives you both data security and data management. Defend against ransomware with immutable backup, AI-based early threat detection, and rapid data.

The Cohesity collector takes events from v2/mcm/ endpoints. This API is very tough to work with, as it will add events over 1 hour later. To prevent this, the collector will perform a check every 10 minutes (now()-65m < evendate < now()-55m) to guarantee the minimal amount of event loss.

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	`no`
Allowed source events obfuscation	`yes`

Data sources

Data source	API endpoint	Collector service name	Devo table

Data source	API endpoint	Collector service name	Devo table
Helios Audit	`/mcm/audit-logs`	`audit`	`dmp.cohesity.helios.audit`
Helios Alert	`/mcm/alerts`	`alerts`	`dmp.cohesity.helios.alerts`

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

Flattening preprocessing

The audit logs have flattening enabled. the have a dictionary inside the record called new record. The new record will be extracted and applied to the original log.

For example: {a: 1, b: 2, c: [{name: john},{name: scott}]} will show up in Devo as unflattened. The flattening will happen and you'll get the additional logs, such as:

{"a": 1, "b": 2, "newRecord": [{"name": "john"}]} {"a": 1, "b": 2, "newRecord": [{"name": "scott"}]}

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
`api_key_name`	The name of the API given in setup.
`api_key`	The key generated in setup.

Accepted authentication methods

Authentication method	api_key_name	api_key

Authentication method	api_key_name	api_key
OAuth2	REQUIRED	REQUIRED

Vendor setup

Follow these steps to get the required credentials:

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.

Alerts (`alerts`)

Internal process and deduplication method

All alerts data are pulled with an Id value. The collector checks the Ids each run. Checkpoints are persisted to ensure that duplicate data is not sent to Devo.

Devo categorization and destination

All events of this service are ingested into the table dmp.cohesity.helios.alerts.

Setup output

2024-04-09T09:56:19.561389088Z 2024-04-09T09:56:19.561 WARNING InputProcess::CohesityPullerSetup(cohesity,cohesity#56752,alerts#predefined) -> Testing fetch from /mcm/alerts.
2024-04-09T09:56:19.771898077Z 2024-04-09T09:56:19.771    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Number of available senders: 1, sender manager internal queue size: 0
2024-04-09T09:56:19.772167710Z 2024-04-09T09:56:19.771    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Number of available senders: 1, sender manager internal queue size: 0
2024-04-09T09:56:19.772327665Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-04-09T09:56:19.772395427Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-04-09T09:56:19.772425735Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
2024-04-09T09:56:19.772519048Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False}
2024-04-09T09:56:19.772601144Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Internal - Total number of messages: 6333 messages/bytes sent since/to "2024-04-09T09:51:19.771169+00:00/2024-04-09T09:56:19.772408+00:00": 25/13762, (elapsed 0.052 seconds)
2024-04-09T09:56:19.772631900Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Lookup - Total number of messages sent: 0, messages sent since "2024-04-09 09:51:19.770969+00:00": 0 (elapsed 0.000 seconds)
2024-04-09T09:56:20.261298432Z 2024-04-09T09:56:20.261    INFO InputProcess::CohesityPullerSetup(cohesity,cohesity#56752,alerts#predefined) -> Successfully tested fetch from /mcm/alerts. Source is pullable.
2024-04-09T09:56:20.262730750Z 2024-04-09T09:56:20.262    INFO InputProcess::CohesityPullerSetup(cohesity,cohesity#56752,alerts#predefined) -> Setup for module <CohesityPuller> has been successfully executed

Puller output

2024-04-09T09:56:22.704294203Z 2024-04-09T09:56:22.704    INFO InputProcess::CohesityPuller(cohesity,56752,alerts,predefined) -> Pull Started
2024-04-09T09:56:23.124016843Z 2024-04-09T09:56:23.123    INFO InputProcess::CohesityPuller(cohesity,56752,alerts,predefined) -> Updating the persistence
2024-04-09T09:56:23.124811682Z 2024-04-09T09:56:23.124    INFO InputProcess::CohesityPuller(cohesity,56752,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1712656582704):Number of requests made: 535; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 4.759.

Restart the persistence

Update the unique ID of the collector and restart, this will remove the Id values that have been pulled. This may cause duplicates.

Audit (`audit`)

Internal process and deduplication method

Alerts are pulled with start time value, that value is updated anytime logs are found. If no logs are found the start time is not persisted. The start time will be used until logs are found.

Devo categorization and destination

All events of this service are ingested into the table dmp.cohesity.helios.audidt.

Setup output

2024-04-09T09:56:19.561389088Z 2024-04-09T09:56:19.561 WARNING InputProcess::CohesityPullerSetup(cohesity,cohesity#56752,audit#predefined) -> Testing fetch from /mcm/get-audit.
2024-04-09T09:56:19.771898077Z 2024-04-09T09:56:19.771    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Number of available senders: 1, sender manager internal queue size: 0
2024-04-09T09:56:19.772167710Z 2024-04-09T09:56:19.771    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Number of available senders: 1, sender manager internal queue size: 0
2024-04-09T09:56:19.772327665Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-04-09T09:56:19.772395427Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-04-09T09:56:19.772425735Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
2024-04-09T09:56:19.772519048Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False}
2024-04-09T09:56:19.772601144Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Internal - Total number of messages: 6333 messages/bytes sent since/to "2024-04-09T09:51:19.771169+00:00/2024-04-09T09:56:19.772408+00:00": 25/13762, (elapsed 0.052 seconds)
2024-04-09T09:56:19.772631900Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Lookup - Total number of messages sent: 0, messages sent since "2024-04-09 09:51:19.770969+00:00": 0 (elapsed 0.000 seconds)
2024-04-09T09:56:20.261298432Z 2024-04-09T09:56:20.261    INFO InputProcess::CohesityPullerSetup(cohesity,cohesity#56752,audit#predefined) -> Successfully tested fetch from /mcm/get-audit. Source is pullable.
2024-04-09T09:56:20.262730750Z 2024-04-09T09:56:20.262    INFO InputProcess::CohesityPullerSetup(cohesity,cohesity#56752,audit#predefined) -> Setup for module <CohesityPuller> has been successfully executed

Puller output

Restart the persistence

Update the unique Id of the collector and restart, this will remove the Id values that have been pulled. This may cause duplicates.

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.

Common logic

Error type	Error ID	Error message	Cause	Solution

Error type	Error ID	Error message	Cause	Solution
`ApiError`	`496`	Connection Error - Ensure the URL parameters are correct and that host has access to server.	Could Not connect to the Host	Ensure the endpoint is reachable with the credentials
`ApiError`	`497`	Max Retries Error - Request attempts with {retries} retries failed. \n{reason}	Max Retries Hit	Update rate limits
`SetUpError`	`102`	Failed to fetch from {endpoint}. Error: {e}	The collector was unable to access the specified endpoint.	Ensure the endpoint is reachable with the credentials

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.

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: 57, messages sent since "2023-01-10 16:09:16.116750+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 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.00 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`	Apr 9, 2024	INITIAL RELEASE	Initial release	`-`

Overview

Devo collector features

Data sources

Flattening preprocessing

Minimum configuration required for basic pulling

Accepted authentication methods

Vendor setup

Run the collector

Collector services detail

Alerts (alerts)

Internal process and deduplication method

Devo categorization and destination

Setup output

Puller output

Restart the persistence

Audit (audit)

Internal process and deduplication method

Devo categorization and destination

Setup output

Puller output

Restart the persistence

Troubleshooting

Common logic

Collector operations

Initialization

Events delivery and Devo ingestion

Sender services

Sender statistics

Change log

Alerts (`alerts`)

Audit (`audit`)