The Rookout ETL Agent is a component that can be installed within your network.
It collects debugging data from the from your application instances, performs aggregation and data redaction, and sends the results to your target data collection application.
Using the Rookout ETL Agent you may perform all related data processing inside your own network.
Run as Container
The easiest way to deploy the ETL Agent is as a Docker container available here.
The ETL Agent can be configured to your needs using environment variables.
To run as a Docker container, simply execute:
docker run -p 7486:7486 -e "ROOKOUT_TOKEN=[Your Rookout Token]" rookout/agent
2. Kubernetes and Helm
If you are running on Kubernetes, we recommend using our provided helm chart available here.
helm install --name rookout stable/rookout --set token=[Your Rookout Token]
Run as Daemon
The Rookout ETL Agent is also available as a Linux Daemon.
To install it using a setup script, run the following commands:
export ROOKOUT_TOKEN=[Your Rookout Token] curl -fs https://get.rookout.com | bash
Alternatively, you can download the script to disk and execute it with command line arguments (see more options below):
curl -fs https://get.rookout.com > setup.sh bash setup.sh --token=[Your Rookout Token]
Linux Daemon Configuration
The enviorments variables for the Linux daemon are accessible by editing the
By default, the ETL Agent listens only on localhost when running in daemon mode.
This can easily be changed by adding the following line to the configuration file:
Linux Daemon OS Support
The Linux daemon is supported in the following operating systems:
|Debian||GNU/Linux 9 (strech)|
|Ubuntu||14.04 LTS, 16.04 LTS|
|Red Hat Enterprise||Linux 6, 7|
Linux Daemon Update
The linux deamon can be updated to the latest version using the following command:
curl -fs https://get.rookout.com > setup.sh bash setup.sh --update
The ETL Agent configuration will be saved during the update process.
Linux Daemon Restart
When modifying the configuration it is important to restart the ETL Agent using one of the following options:
systemctl restart rookout-agent
Linux Daemon Uninstall
To uninstall the linux daemon run the following command:
curl -fs https://get.rookout.com/remove_agent.sh | bash
Disable Sending Data
The ETL Agent connects to the Rookout Service to receive commands and report telemetry information.
Data collected from within the application may be sent to Rookout for interactive debugging sessions.
You may configure a local policy preventing the ETL Agent from sending application data to Rookout by adding the following line to the configuration file at
Local Breakpoint Targets
As the ETL Agent runs within your network, it allows you to direct the collected data into data sinks.
For example, debug messages can be sent to Elasticsearch or Splunk clusters.
All data received by the ETL gent undergoes a data redaction process based on the configuration set by the user.
The Rookout ETL Agent has HTTPS proxy support for advanced network configurations.
As most production systems do have automated means for proxy detection, you should configure it statically.
This can be done when installing the ETL Agent:
setup.sh --token=[Your Rookout Token] --https-proxy=[Your Proxy Server]
Or by adding the HTTPS_PROXY configuration to the ETL Agent configuration file at
export HTTPS_PROXY=[Your Proxy Server]