Scripts

Admins can run scripts (for example, shell scripts) from within Cribl Stream by configuring and executing them at Settings > Global Settings > Scripts. Scripts are typically used to call custom automation jobs or, more generally, to trigger tasks on demand. For example, you can use Scripts to run an Ansible job, or to place a call to another automation system, when Cribl Stream configs are updated.

With Great Power Comes Great Responsibility!​

Scripts will allow you to execute almost anything on the system where Cribl Stream is running. Make sure you understand the impact of what you’re executing before you do so!

To add a new script, click Add script on the scripts page.

Settings > Scripts page
Settings > Scripts page

The New Script modal provides the following fields:

  • ID: Unique ID for this script.
  • Command: Command to execute for this script.
  • Description: Brief description about this script. Optional.
  • Arguments: Arguments to pass when executing this script.
  • Env variables: Extra environment variables to set when executing script.
Scripts in Distributed Deployments​

  • Scripts can be deployed from Leader Node, but can be run only locally from each Worker Node.

  • If the Script command is referencing a file (for example, herd.sh), that file must exist on the Cribl Stream instance. In other words, the Script management interface cannot be used to upload or manage script files.