Skip to main content
Version: 3.2

Google Chronicle

Cribl LogStream supports sending data to Google Chronicle, a cloud service for retaining, analyzing, and searching enterprise security and network telemetry data. This is a non-streaming Destination type.

To define a Google Chronicle Destination, you need to obtain an API key from Google. If you want LogStream or an external KMS to manage the API key, configure a key pair that references the API key.

Configuring Cribl LogStream to Output to Chronicle

In the QuickConnect UI: Click + Add beside Destinations. From the resulting drawer's tiles, select Google Chronicle. Next, click either + Add New or (if displayed) Select Existing. The resulting drawer will provide the following options and fields.

Or, in the Data Routes UI: From the top nav of a LogStream instance or Group, select Data > Destinations. From the resulting page's tiles or the Destinations left nav, select Google Chronicle. Next, click + Add New to open a New Destination modal that provides the following options and fields.

General Settings

Output ID: Enter a unique name to identify this Chronicle output definition.

Send events as: Unstructured is the only currently supported format. Cribl plans to add UDM (Unified Data Model) support in a future release.

Log type: Select an application log type to send to Chronicle. (Google Chronicle expects all batches for a given Destination to have the same log type.) Can be overwritten by the __logType event field.

Log text field: Specify the event field that contains the log text to send. If you do not specify a log text field, LogStream sends a JSON representation of the whole event.

Backpressure behavior: Whether to block, drop, or queue events when all receivers are exerting backpressure. (Causes might include a broken or denied connection, or a rate limiter.) Defaults to Block.

Persistent Queue Settings

This section is displayed when the Backpressure behavior is set to Persistent Queue.

Max file size: The maximum size to store in each queue file before closing it. Enter a numeral with units of KB, MB, etc. Defaults to 1 MB.

Max queue size: The maximum amount of disk space the queue is allowed to consume. Once this limit is reached, queueing is stopped and data blocking is applied. Enter a numeral with units of KB, MB, etc.

Queue file path: The location for the persistent queue files. This will be of the form: your/path/here/<worker-id>/<output-id>. Defaults to: $CRIBL_HOME/state/queues.

Compression: Codec to use to compress the persisted data, once a file is closed. Defaults to None; Gzip is also available.

Queue-full behavior: Whether to block or drop events when the queue is exerting backpressure (because disk is low or at full capacity). Block is the same behavior as non-PQ blocking, corresponding to the Block option on the Backpressure behavior drop-down. Drop new data throws away incoming data, while leaving the contents of the PQ unchanged.

Authentication

The Google Chronicle API key is required to complete this part of the Destination definition.

Use the Authentication Method buttons to select one of these options:

  • Manual: In¬†the resulting API key field, enter your Google Chronicle API key.

  • Secret: This option exposes a Secret drop-down, in which you can select a stored secret that references your Google Chronicle API key. A Create link is available to store a new, reusable secret.

Processing Settings

Post-Processing

Pipeline: In this section's Pipeline drop-down list, you can select a single existing Pipeline to process data from this input before the data is sent through the Routes.

System fields: Specify any fields you want LogStream to automatically add to events using this output. Wildcards are supported.

Advanced Settings

Validate server certs: Toggle to Yes to reject certificates that are not authorized by a CA in the CA certificate path, nor by another trusted CA (e.g., the system's CA).

Round-robin DNS: Toggle to Yes to use round-robin DNS lookup. When a DNS server returns multiple addresses, this will cause LogStream to cycle through them in the order returned.

Compress: Toggle to Yes if you want LogStream to compress the payload body before sending.

Request timeout: Enter an amount of time, in seconds, to wait for a request to complete before aborting it.

Request concurrency: Enter the maximum number of ongoing requests to allow before blocking.

Max body size (KB): Enter a maximum size, in KB, for the request body.

Max events per request: Enter the maximum number of events to include in the request body. Defaults to 0 (unlimited).

Flush period (sec): Enter the maximum time to allow between requests. Be aware that small values could cause the payload size to be smaller than the configured Max body size.

Extra HTTP Headers: Click + Add Header to insert extra headers as Name/Value pairs.

Environment: If you're using GitOps, optionally use this field to specify a single Git branch on which to enable this configuration. If empty, the config will be enabled everywhere.