These docs are for Cribl Stream 4.10 and are no longer actively maintained.

See the latest version (4.13).

Google Security Operations (SecOps) Destination

Cribl Stream supports sending data to Security Operations (SecOps), a cloud service for retaining, analyzing, and searching enterprise security and network telemetry data. This service was formerly known as Google Chronicle.

if you plan to use V2 of the Google Security Operations API, you need your Google service account credentials to define a Google SecOps Destination.

If you plan to use V1 of the Google Security Operations API, Cribl recommends using Google service account credentials for authentication, but alternatively, you can opt to use an API key from Google.

Type: Streaming | TLS Support: Yes | PQ Support: Yes

Configure Cribl Stream to Output to SecOps

​

1. On the top bar, select Products, and then select Cribl Stream. Under Worker Groups, select a Worker Group. Next, you have two options:

   • To configure via QuickConnect, navigate to Routing > QuickConnect (Stream) or Collect (Edge). Select Add Destination and select the Destination you want from the list, choosing either Select Existing or Add New.
   • To configure via the Routes, select Data > Destinations or More > Destinations (Edge). Select the Destination you want. Next, select Add Destination.

2. In the New Destination modal, configure the following under General Settings:

   • Output ID: Enter a unique name to identify this SecOps output definition. If you clone this Destination, Cribl Stream will add -CLONE to the original Output ID.

   • Description: Optionally, enter a description.

   • Send events as: From the drop-down, choose how you want the Destination to send data to SecOps. The options are: Unstructured and UDM. See Options for Sending Data to SecOps below to learn about the differences between working with Unstructured and already-structured UDM data.

   • API version: The version of the Google Security Operations Ingestion API you want the Destination to use when communicating with SecOps. Defaults to V2.

   • Default log type: This setting is available only when Send events as is set to Unstructured (the default). From the drop-down, select a log type to assign to events that lack a __logType field. For any events that do have a __logType field, Cribl Stream uses the value in that field, not the default log type. See Working with Log Types below to learn how Cribl Stream populates the drop-down and how to add log types missing from it.

     When API version is set to V2 (the default), one or both of the following additional controls appear in General Settings:

   • Namespace: This setting is available only when Send events as is set to Unstructured (the default). Optionally, configure an environment namespace to identify logs’ originating data domain. You can use this as a tag when indexing and/or enriching data. The __namespace event field, if present, will overwrite this.

   • Customer ID: A unique identifier (UUID) corresponding to a particular SecOps instance. To use this optional field, request the ID from your SecOps representative.
     

     When API version is set to V1 and Send events as is set to Unstructured, both Namespace and Customer ID appear under Optional Settings.
     

3. Next, you can configure the following Optional Settings: When General Settings > Send events as is set to Unstructured (the default), the UI displays some or all of these settings, depending on how API version is set.

   • Custom log types: For each log type you want to define, click Add type and enter values for Log type and Description in the resulting table row. See Working with Log Types above for more details.

   • Namespace: Appears here when API version is set to V1. Described in General Settings above.

   • Customer ID: Appears here when API version is set to V1. Described in General Settings above.

   • Custom labels: You can (optionally) define labels for the Destination to add to events. These “custom labels” are a Google SecOps feature used for data role-based access control (data RBAC) and other purposes. See the Google SecOps documentation. Click Add label to create a new label and specify it as a key-value pair.

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

     (The following settings are available regardless of how General Settings > Send events as is set.)
     
     

   • Region: The Google SecOps regional endpoint to send events to.

   • 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.

   • Tags: Optionally, add tags that you can use to filter and group Destinations on the Destinations page. These tags aren’t added to processed events. Use a tab or hard return between (arbitrary) tag names.

4. Optionally, you can adjust the Authentication, Persistent Queue, Processing, Retries and Advanced settings outlined in the sections below.

5. Select Save, then Commit & Deploy.

Working with Log Types

​

Google SecOps supports a dynamic list of log types that evolves over time. Cribl Stream periodically updates the Default log type drop-down with the latest list from Google. However, if you need to use a log type that is not yet included in the drop-down or an older log type that has been removed, you can define and manage these log types using the Custom log types table under Optional Settings.

How Log Types are Assigned

​

• Event-specific: When processing an event, Cribl Stream first checks if the event has a __logType field. If this field is present, its value determines the log type for that event.
• Default: If the event lacks a __logType field, Cribl Stream assigns the log type specified in the Default log type drop-down.
• Custom: If the Default log type is set to Custom, Cribl Stream will use the first custom log type listed in the Custom log types table. Reorder the custom log types in the table using the grab handles to prioritize which custom log type should be used as the default. If the Default log type is set to a specific log type (not Custom), the custom log types defined in the Custom log types table will not be used as defaults. However, you can still use these custom log types by explicitly setting the __logType field in your events to one of the custom log types.

For Google’s latest list of supported log types, see the API documentation or send a GET request to https://malachiteingestion-pa.googleapis.com/v1/logtypes.

Authentication

​

To complete this part of the Destination definition, you will need either a Google Security Operations API key or your Google SecOps service account credentials. If you clone this Destination, Cribl Stream will add -CLONE to the original Output ID.

Use the Authentication method drop-down to select an option. Whether you have set General Settings > API version to V2 or V1 determines what options are displayed.

For API version V2, the options are:

• Service Account Credentials: This option exposes a field where you can enter your Google SecOps service account directly.

• Service Account Credentials Secret: This option exposes a drop-down, in which you can select a stored secret that references your Google SecOps service account. A Create link is available to store a new, reusable secret.

For API version V1, the options include the two listed above plus two more:

• API key: This option exposes a field where you can enter your Google Security Operations API key.

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

Persistent Queue Settings

​

The Persistent Queue Settings tab displays when the Backpressure behavior option in General settings is set to Persistent Queue. Persistent queue buffers and preserves incoming events when a downstream Destination has an outage or experiences backpressure.

Before enabling persistent queue, learn more about persistent queue behavior and how to optimize it with your system:

• About Persistent Queues
• Optimize Destination Persistent Queues (dPQ)
• Destination Backpressure Triggers

On Cribl-managed Cloud Workers (with an Enterprise plan), this tab exposes only the destructive Clear Persistent Queue button (described at the end of this section). A maximum queue size of 1 GB disk space is automatically allocated per PQ‑enabled Destination, per Worker Process. The 1 GB limit is on outbound uncompressed data, and no compression is applied to the queue.

This limit is not configurable. If the queue fills up, Cribl Stream/Edge will block outbound data. To configure the queue size, compression, queue-full fallback behavior, and other options below, use a hybrid Group.

Mode: Use this menu to select when Cribl Stream/Edge engages the persistent queue in response to backpressure events from this Destination. The options are:

If a Worker/Edge Node starts with an invalid Mode setting, it automatically switches to Error mode. This might happen if the Worker/Edge Node is running a version that does not support other modes (older than 4.9.0), or if it encounters a nonexistent value in YAML configuration files.

Max file size: The maximum data volume 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 that the queue can consume on each Worker Process. When the queue reaches this limit, the Destination stops queueing data and applies the Queue‑full behavior. Defaults to 5 GB. This field accepts positive numbers with units of KB, MB, GB, and so on. You can set it as high as 1 TB, unless you’ve configured a different Worker Process PQ size limit on the Group Settings/Fleet Settings page.

Queue file path: The location for the persistent queue files. Defaults to $CRIBL_HOME/state/queues. Cribl Stream/Edge will append /<worker‑id>/<output‑id> to this value.

Compression: Set the codec to use when compressing the persisted data after closing a file. Defaults to None. Gzip is also available.

Queue-full behavior: Whether to block or drop events when the queue begins to exert backpressure. A queue begins to exert backpressure when the disk is low or at full capacity. This setting has two options:

• Block: The output will refuse to accept new data until the receiver is ready. The system will return block signals back to the sender.
• Drop new data: Discard all new events until the backpressure event has resolved and the receiver is ready.

Backpressure duration limit: When Mode is set to Backpressure, this setting controls how long to wait during network slowdowns before activating queues. A shorter duration enhances critical data loss prevention, while a longer duration helps avoid unnecessary queue transitions in environments with frequent, brief network fluctuations. The default value is 30 seconds.

Strict ordering: Toggle on (default) to enable FIFO (first in, first out) event forwarding, ensuring Cribl Stream/Edge sends earlier queued events first when receivers recover. The persistent queue flushes every 10 seconds in this mode. Toggle off to prioritize new events over queued events, configure a custom drain rate for the queue, and display this option:

• Drain rate limit (EPS): Optionally, set a throttling rate (in events per second) on writing from the queue to receivers. (The default 0 value disables throttling.) Throttling the queue drain rate can boost the throughput of new and active connections by reserving more resources for them. You can further optimize Worker startup connections and CPU load in the Group Settings/Fleet Settings > Worker Processes settings.

Clear Persistent Queue: For Cloud Enterprise only, click this button if you want to delete the files that are currently queued for delivery to this Destination. If you click this button, a confirmation modal appears. Clearing the queue frees up disk space by permanently deleting the queued data, without delivering it to downstream receivers. This button only appears after you define the Output ID.

Use the Clear Persistent Queue button with caution to avoid data loss. See Steps to Safely Disable and Clear Persistent Queues for more information.

Options for Sending Data to SecOps

​

The options for Sending Data to SecOps are:

• Sending Unstructured data that SecOps then parses into UDM (Unified Data Model).

• Sending data already structured as UDM, bypassing the SecOps parsers.

Sending unstructured data to SecOps is best for writing well-known data types to SecOps. SecOps runs the unstructured data through a series of parsers that transform it to satisfy the required UDM schema. Where this can break down is when you need to write less-usual data types, which can stump SecOps’s parsers, leading to parsing errors and additional time spent troubleshooting.

Sending data already structured as UDM into SecOps bypasses the parsing gauntlet. When the customer is working with less-usual or unique, proprietary data types that could confound the parsers, this can be essential.

Overall, support for sending data already structured as UDM provides more control and flexibility to land more data in SecOps. To gain that flexibility, you must be prepared to “own” the data transformation into UDM before sending it to SecOps – this method “gives you the keys.” You will need to use Pipelines and Functions to transform your initially unstructured data to UDM before routing it to this Destination.

Processing Settings

​

Post-Processing

​

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

System fields: Specify any fields you want Cribl Stream to automatically add to events using this output. Wildcards are supported. By default, includes cribl_pipe (identifying the Cribl Stream Pipeline that processed the event). Other options include:

• cribl_host – Cribl Stream Node that processed the event.
• cribl_input – Cribl Stream Source that processed the event.
• cribl_output – Cribl Stream Destination that processed the event.
• cribl_route – Cribl Stream Route (or QuickConnect) that processed the event.
• cribl_wp – Cribl Stream Worker Process that processed the event.

Retries

​

Honor Retry-After header: Whether to honor a Retry-After header, provided that the header specifies a delay no longer than 180 seconds. Cribl Stream limits the delay to 180 seconds even if the Retry-After header specifies a longer delay. When enabled, any Retry-After header received takes precedence over all other options configured in the Retries section. When disabled, all Retry-After headers are ignored.

Settings for failed HTTP requests: When you want to automatically retry requests that receive particular HTTP response status codes, use these settings to list those response codes.

For any HTTP response status codes that are not explicitly configured for retries, Cribl Stream applies the following rules:

Upon receiving a response code that’s on the list, Cribl Stream first waits for a set time interval called the Pre-backoff interval and then begins retrying the request. Time between retries increases based on an exponential backoff algorithm whose base is the Backoff multiplier, until the backoff multiplier reaches the Backoff limit (ms). At that point, Cribl Stream continues retrying the request without increasing the time between retries any further.

If the sender (which manages the connection to the Destination) is at capacity, it will not accept any incoming events. These incoming events originate internally from a previous stage of the data flow when Destinations send outbound requests to their respective external services, and they include retry requests and new requests. Any events that were already in transit when the sender reached capacity will continue to be processed downstream.

Sender capacity is freed up when an outgoing request succeeds or encounters a non-retryable error. When the sender has available capacity again, it will resume accepting incoming events. This capacity management is influenced by the number of active connections and configured limits, such as concurrency and buffer sizes. If a Pipeline sends events faster than the Destination can process, the buffers may fill up, leading to backpressure and Sender at capacity warnings. This backpressure prevents the sender from accepting additional requests until capacity is restored.

By default, 429 (Too Many Requests) and 503 (Service Unavailable) are the only response codes configured for automatic retries. For each response code you want to add to the list, click Add Setting and configure the following settings:

• HTTP status code: A response code that indicates a failed request, for example 429 (Too Many Requests) or 503 (Service Unavailable).
• Pre-backoff interval (ms): The amount of time to wait before beginning retries, in milliseconds. Defaults to 30000 (30 seconds).
• Backoff multiplier: The base for the exponential backoff algorithm; defaults to 1. A value of 2 means that Cribl Stream will retry after 2 seconds, then 4 seconds, then 8 seconds, and so on.
• Backoff limit (ms): The maximum backoff interval Cribl Stream should apply for its final retry, in milliseconds. Defaults to 30000 (30 seconds); minimum is 10,000 (10 seconds); maximum is 180,000 (180 seconds, or 3 minutes).

Retry timed-out HTTP requests: When you want to automatically retry requests that have timed out, toggle this control on to display the following settings for configuring retry behavior:

• Pre-backoff interval (ms): The amount of time to wait before beginning retries, in milliseconds. Defaults to 1000 (one second).
• Backoff multiplier: The base for the exponential backoff algorithm. A value of 2 (the default) means that Cribl Stream will retry after 2 seconds, then 4 seconds, then 8 seconds, and so on.
• Backoff limit (ms): The maximum backoff interval Cribl Stream should apply for its final retry, in milliseconds. Default (and minimum) is 10,000 (10 seconds); maximum is 180,000 (180 seconds, or 3 minutes).

Advanced Settings

​

Validate server certs: Reject certificates that are not authorized by a CA in the CA certificate path, or by another trusted CA (such as the system’s CA). Defaults to toggled on.

Round-robin DNS: Toggle on to enable round-robin DNS lookup across multiple IP addresses, IPv4 and IPv6. When a DNS server resolves a Fully Qualified Domain Name (FQDN) to multiple IP addresses, Cribl Stream will sequentially use each address in the order they are returned by the DNS server for subsequent connection attempts.

Compress: Toggle on (default) 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. Defaults to 90.

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

Max body size (KB): Maximum size of the request body before compression. Defaults to 1024 KB. The actual request body size might exceed the specified value because the Destination adds bytes when it writes to the downstream receiver. Cribl recommends that you experiment with the Max body size value until downstream receivers reliably accept all events.

Buffer memory limit (KB): Total amount of memory used to buffer outgoing requests waiting to be sent. If left blank, defaults to five times the max body size (if set). If 0, no limit is enforced. This provides granular control over the memory allocated for buffering outgoing batched requests. Increasing the limit allows batches to grow larger before being flushed, improving efficiency for data with high cardinality (a large number of unique batches). Finding the optimal balance between efficient data transfer and memory usage involves adjusting both the Buffer memory limit and Max Body Size settings.

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. Values will be sent encrypted.

Failed request logging mode: Use this drop-down to determine which data should be logged when a request fails. Select among None (the default), Payload, or Payload + Headers. With this last option, Cribl Stream will redact all headers, except non-sensitive headers that you declare below in Safe headers.

Safe headers: Add headers to declare them as safe to log in plaintext. (Sensitive headers such as authorization will always be redacted, even if listed here.) Use a tab or hard return to separate header names.

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.

Proxying Requests

​

If you need to proxy HTTP/S requests, see System Proxy Configuration.

Troubleshooting

​

The Destination’s configuration modal has helpful tabs for troubleshooting:

Live Data: Try capturing live data to see real-time events as they flow through the Destination. On the Live Data tab, click Start Capture to begin viewing real-time data.

Logs: Review and search the logs that provide detailed information about the delivery process, including any errors or warnings that may have occurred.

Test: Ensures that the Destination is correctly set up and reachable. Verify that sample events are sent correctly by clicking Run Test.

You can also view the Monitoring page that provides a comprehensive overview of data volume and rate, helping you identify delivery issues. Analyze the graphs showing events and bytes in/out over time.