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

See the latest version (4.13).

Environment Variables

You can use the following environment variables to configure your Cribl Stream installation.

Distributed Deployment Variables

​

You can use the following environment variables to configure your distributed Cribl Stream instance.

Usage Notes

​

This section explains how to use certain complex environment variables.

CRIBL_DIST_LEADER_URL

​

Use this format:

<tls|tcp>://<authToken>@<host>:<port>?group=defaultGroup&tag=tag1&tag=tag2&tls.<tls_settings>

To generate a random authentication token, leave <authToken> unchanged. You can define it to add your own token instead, but make sure it’s secure enough.

The auth token can include only alphanumeric characters or the underscore (_). Do not include <, >, ", `, \r, \n, \t, {, }, |, \, ^, or '.

When configuring the node as a Leader, use 0.0.0.0 (or another suitable binding address) for host. Then, set CRIBL_DIST_MODE to leader.

Here are the components:

• group – The preferred Worker Group assignment.
• resiliency – The preferred Leader failover mode.
• volume– The location of the NFS directory to support Leader failover.
• tag – A list of tags that you can use to map (Stream, Edge) the Worker to a Worker Group.
• disableSNIRouting – Whether Server Name Indicator (SNI) routing is enabled on the Worker Node. Boolean; defaults to false.

  Do not edit this advanced setting without supervision by Cribl Support. Changing this setting can affect the scalability of your system because it determines how Cribl Stream routes connections between Leader Nodes and Worker Nodes. See the Known Issue that resulted in this setting for more details.

• tls.privKeyPath – Private Key Path.
• tls.passphrase – Key Passphrase.
• tls.caPath – CA Certificate Path.
• tls.certPath – Certificate Path.
• tls.rejectUnauthorized – Validate Client Certs. Boolean; defaults to false.
• tls.requestCert – Authenticate Client (mutual auth). Boolean; defaults to false.
• tls.commonNameRegex – Regex matching peer certificate > subject > common names allowed to connect. Used only if tls.requestCert is set to true.

CRIBL_DIST_LEADER_URL was previously called CRIBL_DIST_MASTER_URL. This name is still in use in certain contexts, for example in Helm charts.

CRIBL_TMP_DIR

​

Sources use this variable to construct temporary directories in which to stage downloaded Parquet data. If CRIBL_TMP_DIR is not set (the default), Cribl applications create subdirectories within your operating system’s default temporary directory:

• For Cribl Stream: <OS_default_temporary_directory>/stream/.
• For Cribl Edge: <OS_default_temporary_directory>/edge/.

For example, on Linux, Stream’s default staging directory would be /tmp/stream/.

If you explicitly set this CRIBL_TMP_DIR environment variable, its value replaces this OS-specific default parent directory.

CRIBL_DIST_WORKER_PROXY

​

CRIBL_DIST_WORKER_PROXY lets you configure a SOCKS proxy for communication between the Leader Node and Worker Nodes.

The default protocol is SOCKS5, which uses the format: socks5://<username>:<password>@<host>:<port>. Only <host>:<port> are required.

You can alternatively specify SOCKS4 as the protocol with the format: socks4://<proxyhost>:<port>. To authenticate on a SOCKS4 proxy with username and password, use this format: socks4://<username>:<password>@<proxyhost>:<port>. The <proxyhost> can be a hostname, IPv4, or IPv6.

To configure a SOCKS proxy via the UI, see Configure SOCKS Proxy. To configure an HTTP(S) proxy to use for your Sources and Destinations, refer to System Proxy Configuration.

CRIBL_BOOTSTRAP_HOST

​

CRIBL_BOOTSTRAP_HOST overrides the Add/Bootstrap New Worker script generator’s default hostname.

For example, if you set CRIBL_BOOTSTRAP=myhost, then myhost will appear in the script modal’s Leader hostname/IP field, instead of the URL used in the browser.

CRIBL_BOOTSTRAP

​

CRIBL_BOOTSTRAP enables specifying a URL, an absolute disk file path, or a YAML string, in order to bootstrap a configuration to the $CRIBL_HOME/local directory. Cribl Stream applies this configuration only upon its first startup.

For any method, Cribl Stream expects each targeted config file to be YAML-formatted. Each file’s top-level keys should be the paths to config files inside the $CRIBL_HOME/local/... subdirectory.

Below is an example of a bootstrap file. Its output, when Cribl Stream starts, would be to create three files inside the $CRIBL_HOME/local/cribl path: inputs.yml, outputs.yml, and pipelines/route.yml.

cribl/inputs.yml:
  inputs:
    <id>:
      <config>
cribl/outputs.yml:
  outputs:
    <id>:
      <config>
cribl/pipelines/route.yml:
  id: default
  groups: {}
  comments: []
  routes:
    ...

For details about each file’s syntax, see Config Files and its child topics.

Adding Fallback Leaders

​

You can configure fallback Leader Nodes to support high availability and failover. Use the following environment variables.

GitOps Variables

​

Cribl Stream provides the following environment variables to facilitate using GitOps in Cribl Stream.

You can use these variables to override the defaults in the UI if you are not using systemd to manage the cribl service.

Bootstrap Variables

​

Additional Environment Variables

​

Cribl Stream uses the following variables for multiple purposes.

Cribl.Cloud Certificate Variables

​

The following variables point to the location of default certificate files on Cribl.Cloud:

CRIBL_HOME

​

CRIBL_HOME is a special internal environment variable that indicates the location of the Cribl binary (bin directory). You do not set it manually, but it is referred to in multiple places and commands.