Cohesity collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Flattening preprocessing ] [ 5 Source Event Obfuscation ] [ 6 Minimum configuration required for basic pulling ] [ 7 Accepted authentication methods ] [ 8 Vendor setup ] [ 9 Run the collector ] [ 10 Collector services detail ] [ 11 Collector operations ] [ 12 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 Helios API is lazy, so the collector will have to observe a lookback window to ensure that the least amount of events are lost. To define this window the collector has 2 parameters:

lookback: This is the amount of time to look back and extract data.
lookback_width: The width of the slot to extract data from the look-back parameter.

If not defined, the collector will default to 1h for the lookback and 5m for the lookback width. This means that every time the request period is reached the collector will look back at the last 1 hour and pull all events that have occurred in that 5-minute time frame. These are reasonable defaults, but you can adjust them to your needs.

Important: The lookback_width parameter must be the same as the request_period_in_seconds parameter. If not, events will get lost or be duplicated.

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	`/v2/mcm/audit-logs`	`audit`	`dmp.cohesity.helios.audit`
Helios Alert	`/v2/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. If a record has several records, the new records will be extracted and partially applied to the original log.

For example:

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

The flattening process will be applied and you'll get the additional logs such as:

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

Source Event Obfuscation

There is no default source obfuscation for this collector.

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

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

Audit logs are pulled with a 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.audit.

Setup output

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
InitVariablesError	1	"lookback" parameter must be a valid time string.	The parameter has an unexpected type.	Review the configuration and ensure it is a string.
InitVariablesError	2	"lookback_width" parameter must be a valid time string.	The parameter has an unexpected type.	Review the configuration and ensure it is a string.
InitVariablesError	3	"lookback_width" is greater than "lookback"	The parameter has an invalid value.	Ensure the value is less than "lookback".
InitVariablesError	4	"lookback_width" must be the same as the "request_period_in_seconds" parameter	The parameter is not the same as "request_period_in_seconds".	Ensure both values are the same.
ApiError	496	Connection Error - Ensure the URL parameters are correct and the that host has access to the 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	Recommended actions

Release

Released on

Release type

Details

Recommended actions

v1.2.0

Nov 14, 2024

Improvement

Improvements

Add parameters for the lookback window in the configuration
Updated DCSDK to 1.13.1

Recommended version

v1.1.0

Oct 14, 2024

Improvement

bug fixing

Bug Fixes

Fixed bug with flattening a none type

Improvements

Updated Docker Image for Vulnerability
Updated DCSDK to 1.12.4

Upgrade

v1.0.0

Apr 9, 2024

INITIAL RELEASE

Initial release. Released with Audit and Alert services

-

Cohesity collector

Overview

Devo collector features

Data sources

Flattening preprocessing

Source Event Obfuscation

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`)