Skip to content

Open source framework for processing, monitoring, and alerting on time series data

License

Notifications You must be signed in to change notification settings

EmOne/kapacitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1906564 · Jan 11, 2017
May 31, 2016
Apr 13, 2016
Jan 11, 2017
Aug 10, 2016
Jan 5, 2017
Jan 5, 2017
Jan 7, 2016
Jan 11, 2017
Jan 5, 2017
Jan 9, 2017
Oct 26, 2016
Oct 25, 2016
Jan 10, 2017
Jan 9, 2017
Oct 26, 2016
Jan 11, 2017
Nov 13, 2015
Jan 11, 2017
Jan 11, 2017
Jan 10, 2017
Apr 4, 2016
Jan 10, 2017
Jan 11, 2017
Jan 9, 2017
Jan 15, 2016
May 31, 2016
Apr 13, 2016
Sep 21, 2016
Jan 11, 2017
Aug 31, 2016
Dec 23, 2015
Dec 2, 2016
Dec 2, 2016
Aug 22, 2016
Aug 31, 2015
Jan 9, 2017
Aug 8, 2016
Jan 11, 2017
Jan 11, 2017
Nov 23, 2016
Mar 18, 2016
Aug 22, 2016
Jul 9, 2016
Jul 2, 2016
Jul 2, 2016
Jul 27, 2016
Aug 5, 2016
Mar 28, 2016
Oct 22, 2015
Nov 16, 2016
Aug 3, 2016
Oct 25, 2016
Jul 25, 2016
Jul 25, 2016
Jan 10, 2017
Feb 5, 2016
Jul 25, 2016
Jan 10, 2017
Oct 24, 2016
Sep 19, 2016
Sep 19, 2016
Aug 25, 2016
Jul 27, 2016
Nov 1, 2016
Jun 10, 2016
Jan 10, 2017
Oct 26, 2016
Jul 25, 2016
Feb 16, 2016
Oct 2, 2015
Jan 11, 2017
Jan 11, 2017
Jan 10, 2017
Jan 10, 2017
Mar 25, 2016
Feb 22, 2016
Jun 30, 2016
Jul 25, 2016
Jan 10, 2017
Jan 11, 2017
May 31, 2016
Jan 9, 2017
Nov 2, 2016
May 18, 2016
Jan 10, 2017
Jan 5, 2017
Jan 9, 2017
Mar 25, 2016
Jan 9, 2017
Aug 25, 2016
Aug 30, 2016
Nov 11, 2016
Nov 11, 2016

Repository files navigation

Kapacitor Circle CI Docker pulls

Open source framework for processing, monitoring, and alerting on time series data

Installation

Kapacitor has two binaries:

  • kapacitor – a CLI program for calling the Kapacitor API.
  • kapacitord – the Kapacitor server daemon.

You can either download the binaries directly from the downloads page or go get them:

go get github.com/influxdata/kapacitor/cmd/kapacitor
go get github.com/influxdata/kapacitor/cmd/kapacitord

Configuration

An example configuration file can be found here

Kapacitor can also provide an example config for you using this command:

kapacitord config

Getting Started

This README gives you a high level overview of what Kapacitor is and what its like to use it. As well as some details of how it works. To get started using Kapacitor see this guide. After you finish the getting started exercise you can check out the TICKscripts for different Telegraf plugins.

Basic Example

Kapacitor use a DSL named TICKscript to define tasks.

A simple TICKscript that alerts on high cpu usage looks like this:

stream
    |from()
        .measurement('cpu_usage_idle')
        .groupBy('host')
    |window()
        .period(1m)
        .every(1m)
    |mean('value')
    |eval(lambda: 100.0 - "mean")
        .as('used')
    |alert()
        .message('{{ .Level}}: {{ .Name }}/{{ index .Tags "host" }} has high cpu usage: {{ index .Fields "used" }}')
        .warn(lambda: "used" > 70.0)
        .crit(lambda: "used" > 85.0)

        // Send alert to hander of choice.

        // Slack
        .slack()
        .channel('#alerts')

        // VictorOps
        .victorOps()
        .routingKey('team_rocket')

        // PagerDuty
        .pagerDuty()

Place the above script into a file cpu_alert.tick then run these commands to start the task:

# Define the task (assumes cpu data is in db 'telegraf')
kapacitor define \
    cpu_alert \
    -type stream \
    -dbrp telegraf.default \
    -tick ./cpu_alert.tick
# Start the task
kapacitor enable cpu_alert

For more complete examples see the documentation.

About

Open source framework for processing, monitoring, and alerting on time series data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 95.9%
  • Python 3.6%
  • Shell 0.5%