Free Report! Gartner® Hype Cycle™ for Monitoring and Observability.Read more

Chronicle

Currently only v2 of the ingestion API is supported

Supported Types

MetricsLogsTraces

Prerequisites

Before setting up the Chronicle destination, ensure you have a Google Cloud account and access to the Chronicle security analytics platform. More details on setting this up can be found in the Google Cloud documentation here.

Configuration Fields

FieldDescription
EndpointThe endpoint for sending to chronicle.
Authentication MethodMethod used for authenticating to Google Cloud: auto, json, file.
CredentialsJSON value from a Google Service Account credential file. Required if Authentication Method is set to 'json'.
Credentials FilePath to a Google Service Account credential file on the collector system. Required if Authentication Method is set to 'file'.
Log TypeType of log to be sent to Chronicle. The Supported Log Types can be seen here.
Customer IDThe customer ID used for sending logs.
Raw Log FieldThe OTTL formatted field name that contains the raw log data.

Sources

Chronicle expects to be sent raw unstructured logs. Therefore, when sending logs to Chronicle, you should only use the following supported sources:

  • Windows Events (With Advanced -> “Raw Logs” enabled)
  • Microsoft SQL Server
  • Common Event Format
  • CSV
  • File
  • HTTP
  • TCP
  • UDP

Log Type Handling / Chronicle Parsing

Chronicle uses the log_type ingestion label to determine which Chronicle Parser should be applied to logs. In BindPlane you can set the log_type ingestion label in one of the following ways:

  1. Automatic Mapping: BindPlane will automatically create the log_type ingestion label for sources that use one of the following log_types. In these cases, you don’t need to take any action.

    attributes[“log_type”]chronicle_log_type (Ingestion Label)
    windows_event.securityWINEVTLOG
    windows_event.applicationWINEVTLOG
    windows_event.systemWINEVTLOG
    sql_serverMICROSFT_SQL
  2. Set Chronicle Log Type: You can specify a new log attribute called chronicle_log_type and set its value to the appropriate Chronicle ingestion label (log_type). It’s best practice to always explicitly set this when sending logs to Chronicle. You should use the Add Field processor to set this attribute.

    observIQ docs - Chronicle Destination - image 1

    Note: This field will take precedence over any automatic mapping that may occur.

  3. Fallback: The Chronicle Destination has a Log Type field that you can set as a fallback option, in the case that you did not set chronicle_log_type or BindPlane couldn’t automatically map the log_type for you.

Credentials

This exporter requires a Google Cloud service account with access to the Chronicle API. The service account must have access to the endpoint specfied in the config. Besides the default endpoint (https://malachiteingestion-pa.googleapis.com), there are also regional endpoints that can be used here.

For additional information on accessing Chronicle, see the Chronicle documentation.

Supported Retry and Queuing Settings

This destination supports the following retry and queuing settings:

Sending QueuePersistent QueueRetry on Failure

Example Configuration

Basic Configuration

This configuration sets up the Chronicle destination with necessary details such as region, authentication method, credentials, and log type.

observIQ docs - Chronicle Destination - image 1