Claroty CTD (Preview)

The CTD package allows you to leverage it's syslogs to gain insights on alerts, system health monitoring, events and activity log.

This package provides a preview parser for Claroty CTD events in JSON format.

The parser normalizes data to a common schema based on an OpenTelemetry standard. This schema allows you to search the data without knowing Claroty's data specifically, and just knowing the common schema instead. It also allows you to combine the data more easily with other data sources which conform to the same schema.

Preview Status

Note that this package is considered a PREVIEW. This means we are seeking feedback on the package, and may make breaking changes to the parser in the future.

Configurations and Sending The Logs to LogScale

See Claroty Syslog Specification manual for information on how to send Claroty logs to Falcon LogScale Collector.

Installing the Claroty CTD Package in LogScale

Find the repository where you want to send the CTD logs, or create a new one.

  1. Navigate to your repository in the LogScale interface, click Settings and then Packages on the left.

  2. Click Marketplace and install the LogScale package for CTD (i.e. claroty/ctd).

  3. When the package has finished installing, click Ingest tokens on the left (still under the Settings, see Ingest Tokens).

  4. In the right panel, click + Add Token to create a new token. Give the token an appropriate name (e.g.the name of the server and the name of the server the token is ingesting logs for), and leave the parser unassigned. You can assign the parser to the LogScale Collector Configuration as described in the documentation Sources & Examples.

    Before leaving this page, view the ingest token and copy it to your clipboard — to save it temporarily elsewhere.

    Now that you have a repository set up in LogScale along with an ingest token you're ready to send logs to LogScale.

  5. Next, configure the Falcon LogScale Collector to ship the logs from your syslog server into LogScale. Follow LogScale Collector Installing the LogScale Collector and Configuring LogScale Collector. LogScale Collector documentation also provides an example of how you can configure your syslog datasource, see Sources & Examples.

Verify Data is Arriving in LogScale

Once you have completed the above steps the CTD data should be arriving in your LogScale repository.

You can verify this by doing a simple search to see the CTD events:

logscale
#Vendor = "claroty"
| Product = "ctd"

Package Contents Explained

This package is only for parsing incoming data, and normalizing the data as part of that parsing. The parser normalizes the data to a subset of this schema based on OpenTelemetry standards, while still preserving the original data.

If you want to search using the original field names and values, you can access those in the fields whose names are prefixed with the word "Vendor". Fields which are not prefixed with "Vendor" are standard fields which are either based on the schema (e.g. source.ip) or on LogScale conventions (e.g. @rawstring).

The fields which the parser currently maps the data to, are chosen based on what seems the most relevant, and will potentially be expanded in the future. But the parser won't necessarily normalize every field that has potential to be normalized.

Event Categorisation

As part of the schema, events are categorized by different fields, including:

  • event.category

event.category is an array, so needs to be searched like so:

array:contains("event.category[]", value="info")

This will find events where some event.category[n] field contains the value info, regardless of what n is. Note that not all events will be categorized to this level of detail.

Normalized Fields

Here are some of the normalized fields which are being set by this parser:

  • message.*

  • source.destination.*(eg. source.ip and destination.mac)