On This Page

Home / Stream/ Integrations/ Destinations/ Elastic/Elastic Serverless Destination

Elastic Serverless Destination ​

The Elastic Serverless Destination sends events to an Elastic Serverless project through the Elasticsearch Bulk API. Cribl Stream authenticates with an API key and writes each event to the data stream or index you configure.

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

Configure an Elastic Serverless Destination ​

  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 Elastic Serverless from the list, choosing either Select Existing or Add New.
    • To configure via the Routes, select Data > Destinations or More > Destinations (Edge). Select Elastic Serverless. 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 Elastic Serverless Destination definition.

    • Description: Optionally, enter a description.

    • Connection mode: Select Manual (the default) or Cloud ID. When you select Manual, the following settings appear:

      • Project name: Enter the Serverless project name. Cribl Stream combines it with the project ID to form the endpoint subdomain.
      • Project ID: Enter the project ID from the Elastic Cloud console project settings.
      • Cloud provider: Select Amazon Web Services (AWS), Microsoft Azure, or Google Cloud Platform (GCP). You can enter a custom provider. Confirm that a custom value matches the Elastic Serverless endpoint format.
      • Region: Select the region for the chosen provider. You can enter a custom region. Confirm that a custom region is available for the project.

      When you select Cloud ID, the following setting appears:

      • Cloud ID: Enter the Cloud ID of the Serverless project. Find it in the Elastic Cloud console under the project settings.
    • Data stream or index: Enter a JavaScript expression that evaluates to the Elastic data stream or index name. Enclose a constant in quotes or backticks. An event’s __index field can overwrite this value.

  3. Under Authentication:
    • API key (text secret): Select or create a stored text secret that contains the Elastic API key.
  4. Next, you can configure the following Optional Settings:
    • Backpressure behavior: Select Block, Drop, or Persistent Queue when receivers exert backpressure. Defaults to Block.
    • Tags: Metadata tags used for categorization and filtering in the Cribl Stream UI. These tags aren’t added to processed events. Use a tab or hard return between tag names.
  5. Optionally, you can adjust the Persistent Queue, Processing, Retries, and Advanced settings outlined in the sections below.
  6. Select Save, then Commit & Deploy.

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:

Some of these settings might not appear if you set the persistent queue storage mode to Network filesystem or AWS S3 at the Worker Group level (Worker Group Settings > System > PQ Storage). When using these storage types, this behavior is managed at the Worker Group level. See Worker Group PQ Storage Fields for more information.

On Cribl-managed Cloud Workers (with an Enterprise plan), this tab exposes only the Mode and Backpressure duration limit settings and 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 blocks 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 engages the persistent queue in response to backpressure events from this Destination. The options are:

ModeDescription
ErrorQueues and stores data on a disk when the Destination is unavailable or in an error state.
BackpressureQueues and stores data to a disk when it detects backpressure from the Destination until the backpressure event resolves.
Always OnCribl Stream immediately queues and stores all data on a disk for all events, even when there is no backpressure.

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.

File size limit: The maximum data volume to store in each queue file before closing it. Enter a numeral with units of KB, MB, and so on. Defaults to 10 MB. When you save the configuration, File size limit must be greater than or equal to Buffer size limit (bytes). Cribl Stream rejects invalid combinations.

Queue size limit: 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 Worker Group/Fleet Settings page.

Queue file path: The location for the persistent queue files. Defaults to $CRIBL_HOME/state/queues. Cribl Stream appends /<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.

Buffer size limit (bytes): The maximum memory to buffer events before flushing them to persistent queue on disk. Enter a value with a unit suffix. For example: 64KB, 1MB, or 10MB. Spaces between the number and unit are allowed (such as 64 KB). Units are case-insensitive. Plain byte values (like 65536) are accepted, but decimals (like 0.5MB) are not. The valid range is 64KB to 10MB. Values outside this range are rounded to the nearest limit. Defaults to 1MB.

Deprecation Notice

The Buffer size limit (bytes) setting replaces the deprecated Buffer size limit (events) setting as of version 4.18.0 to provide more predictable memory management. For upgraded Worker Groups and Fleets, the new byte-based limit defaults to 1MB. Update your configurations to use the byte-based limit to ensure optimal memory stability.

Backpressure duration limit: Displays when Mode is set to Backpressure. Controls how long (in seconds) a Destination must experience backpressure before Cribl Stream queues data to persistent storage. Defaults to 30 seconds. Lowering this limit strengthens data loss prevention, while raising it helps prevent unnecessary queue activation in environments with frequent, short network interruptions.

Strict ordering: Toggle on (default) to enable FIFO (first in, first out) event forwarding, ensuring Cribl Stream 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 Worker Processes settings.

Clear Persistent Queue: For Cloud Enterprise only, select this button if you want to delete the files that are currently queued for delivery to this Destination. If you select 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 How to Safely Disable and Clear Persistent Queues for more information.

Processing Settings ​

Post-Processing ​

Pipeline: Pipeline or Pack to process data before sending it through this Destination.

System fields: A list of fields to automatically add to events that use this Destination. By default, includes cribl_pipe. Supports wildcards. Available fields include:

  • cribl_host - Worker Node that processed the event.
  • cribl_input - Source that processed the event.
  • cribl_output - Destination that processed the event.
  • cribl_pipe - Pipeline that processed the event.
  • cribl_route - Route (or QuickConnect) that processed the event.
  • cribl_wp - Worker Process that processed the event.
  • cribl_group - Worker Group that processed the event.
  • cribl_mode - Distributed mode of the instance that processed the event.

Retries ​

Honor Retry-After header: Toggle on to honor a Retry-After header, provided that the header specifies a delay no longer than 180 seconds. Cribl Stream/Edge limits the delay to 180 seconds even if the Retry-After header specifies a longer delay. Any Retry-After header received takes precedence over all other options configured in the Retries section. Toggle off to ignore all Retry-After headers.

Default Retry Behavior: By default, Cribl Stream/Edge applies predefined retry strategies for certain failed requests to the Destination using an exponential backoff algorithm. You can override these settings by manually configuring the retry behavior for a particular error code.

Destinations created before the 4.16.0 release do not support the default 4xx series retry behavior. If your Destination was created prior to this release and you’d like it to support the behavior, reconfigure the Destination.

To retry requests, Cribl Stream/Edge applies the following rules by default:

Status CodeAction
Any in the 1xx, 3xx seriesDrop the request
401, 403, 408, 429 errorsRetry in memory or persistent queue if enabled, and initiate backpressure after limit is reached
Any other 4xx seriesDrop the request
Any in the 5xx seriesRetry in memory or persistent queue if enabled, and initiate backpressure after limit is reached

By default, any 429 (Too Many Requests) response that is not listed in the retry settings is treated as a non-retryable 4xx error and dropped. If you want 429 responses retried, ensure 429 is included in the Settings for failed HTTP requests.

Settings for failed HTTP requests: You can also manually configure Cribl Stream/Edge to automatically retry requests that receive particular HTTP response status codes.

Upon receiving a response code that’s on the list, Cribl Stream/Edge 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/Edge 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.

For each response code you want to add to the list, select 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 1000 (one second).
  • Backoff multiplier: The base for the exponential backoff algorithm. A value of 2 (the default) means that Cribl Stream/Edge will retry after 2 seconds, then 4 seconds, then 8 seconds, and so on.
  • Backoff limit (ms): The maximum backoff interval Cribl Stream/Edge 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).

Retry timed-out HTTP requests: Toggle on to automatically retry requests that have timed out and 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/Edge will retry after 2 seconds, then 4 seconds, then 8 seconds, and so on.
  • Backoff limit (ms): The maximum backoff interval Cribl Stream/Edge 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).

Retry partial errors: Retry events that failed inside a bulk response after Elastic accepted the HTTP request. Defaults to toggled on.

Advanced Settings ​

Request timeout: Seconds to wait for a request to complete before canceling it. Defaults to 60.

Request concurrency: Maximum concurrent requests per Worker Process. Defaults to 4.

Body size limit (KB): Maximum size of the request body before compression. Defaults to 5120 KB. The request can exceed this size because the Destination adds bytes as it writes the body.

Events-per-request limit: Maximum number of events in the request body. Defaults to 3000.

Max connection reuse (seconds): How long to reuse a keep-alive connection after its first use. Defaults to 30. Set 0 to reuse the connection until the server closes it.

Flush period (sec): Maximum time between requests. Defaults to 60.

Extra HTTP headers: Name-value pairs sent as additional HTTP headers. Values are sent encrypted.

Extra parameters: Name-value pairs sent as additional parameters. A filter_path parameter is prefilled with errors,items.*.error,items.*._index,items.*.status.

Elastic pipeline: Optional Elastic ingest pipeline name. You can enter a JavaScript expression.

Include document _id: Toggle on to include the document_id field when sending events to an Elastic time series data stream. Defaults to toggled off.

Distinct failure reason limit: How many distinct per-event failure reasons to surface in health status and warning logs when a request partially fails. Defaults to 5. Set 0 to omit failure reasons from health status and warning logs.

Failed request logging mode: Data to log when a request fails. Select Payload, Payload + Headers, or None. Defaults to None. Headers are redacted unless you list them under Safe headers.

Safe headers: Header names that are safe to log in plain text.

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 configuration is enabled everywhere.

Field Normalization ​

This Destination applies the following field normalization to align with the Elasticsearch schema:

  • Renames _time to @timestamp, maintaining millisecond precision.
  • Renames host to host.name.

See also the Elasticsearch Source Field Normalization section.

Internal Fields ​

Cribl Stream uses a set of internal fields to assist in forwarding data to a Destination.

Fields for this Destination:

  • __id
  • __type
  • __index
  • __host

Notes on HTTP-Based Outputs ​

  • To proxy outbound HTTP/S requests, see System Proxy Configuration.
  • Cribl Stream uses keepalives to reuse a connection for multiple requests. Max connection reuse (seconds) in Advanced Settings sets how long to reuse a connection after its first use.
  • If the server does not support keepalives, or closes a pooled connection while idle, Cribl Stream opens a new connection for the next request.

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.