Kapacitor guides and tutorials
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 following is a list of examples in no particular order that demonstrate some of the features of Kapacitor. These guides assume you’re familiar with the basics of defining, recording, replaying and enabling tasks within Kapacitor. See the getting started guide if you need a refresher.
Calculating rates across joined series + backfill
Collecting a set of time series data where each time series is counting a particular event is a common scenario. Using Kapacitor, multiple time series in a set can be joined and used to calculate a combined value, which can then be stored as a new time series. This guide shows how to use a prepared data generator in python to combine two generated time series into a new calculated measurement, then store that measurement back into InfluxDB using Kapacitor.
Creating a live leaderboard for game scores
Tutorial on using Kapacitor stream processing and Chronograf to build a leaderboard for gamers to be able to see player scores in realtime. Historical data is also available for post-game analysis.
Custom anomaly detection with Kapacitor
Tutorial on building a custom anomaly detection system using Kapacitor and user defined functions (UDFs) to get alerts
Kapacitor TICKscript examples
The Kapacitor repository includes TICKscript examples. These scripts use popular Telegraf plugins as data sources and show how to build common alert messages. Telegraf plugins, with example scripts, include cpu, disk, mem, and netstat metrics from the System (system) input plugin.
Load directory service
Configure a load directory service for file-based definitions of Kapacitor tasks, templates, and topic handlers that load on startup
Using Kapacitor as a continous query engine
Converting an InfluxDB continuous query to a Kapacitor TICKscript
Using Kapacitor event handlers to send alert messages
Configuring Kapacitor to send alert messages to a HipChat room using event handlers and TICKscripts
Writing Kapacitor socket-based user defined functions (UDFs)
Learn about Kapacitor user defined functions (UDFs), differences between socket UDFs and process UDFs
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Kapacitor and this documentation. To find support, use the following resources: