Exec event handler

This page documents an earlier version of Kapacitor. Kapacitor v1.6 is the latest stable version. View this page in the v1.6 documentation.

The exec event handler executes an external program. Event data is passed over STDIN to the process.


The following exec event handler options can be set in a handler file or when using .exec() in a TICKscript.

progstringPath to program to execute.
argslist of stringList of arguments to the program.

Example: handler file

id: handler-id
topic: topic-name
kind: exec
  prog: /path/to/executable
    - 'executable arguments'

Example: TICKscript

  // ...
  .exec('/path/to/executable', 'executable arguments')

Using the exec event handler

The exec event handler can be used in both TICKscripts and handler files to execute an external program based off of alert logic.

Note: Exec programs are run as the kapacitor user which typically only has access to the default system $PATH. If using an executable not in the $PATH, pass the executable’s absolute path.

Execute an external program from a TICKscript

The following TICKscript executes the Python script whenever idle CPU usage drops below 10% using the .exec() event handler.


    .crit(lambda: "usage_idle" < 10)
    .exec('/usr/bin/python', '')

Execute an external program from a defined handler

The following setup sends an alert to the cpu topic with the message, “Hey, check your CPU”. An exec handler is added that subscribes to the cpu topic and executes the Python script whenever an alert message is published.

Create a TICKscript that publishes alert messages to a topic. The TICKscript below sends an alert message to the cpu topic any time idle CPU usage drops below 10%.


    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')

Add and enable the TICKscript:

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert

Create a handler file that subscribes to the cpu topic and uses the exec event handler to execute the Python script.


id: exec-cpu-alert
topic: cpu
kind: exec
  prog: '/usr/bin/python'
    - ''

Add the handler:

kapacitor define-topic-handler exec_cpu_handler.yaml

Was this page helpful?

Thank you for your feedback!

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.