https://github.com/influxdata/kapacitor

Open source framework for processing, monitoring, and alerting on time series data
https://github.com/influxdata/kapacitor

kapacitor monitoring time-series

Last synced: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/influxdata/kapacitor
• Owner: influxdata
• License: mit
• Created: 2015-08-31T14:54:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T11:09:24.000Z (7 months ago)
• Last Synced: 2024-04-22T11:45:17.686Z (7 months ago)
• Topics: kapacitor, monitoring, time-series
• Language: Go
• Size: 21 MB
• Stars: 2,279
• Watchers: 120
• Forks: 493
• Open Issues: 833
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-repositories - influxdata/kapacitor - Open source framework for processing, monitoring, and alerting on time series data (Go)
• starred-awesome - kapacitor - Open source framework for processing, monitoring, and alerting on time series data (Go)

README

        
# Kapacitor [![Circle CI](https://circleci.com/gh/influxdata/kapacitor/tree/master.svg?style=svg&circle-token=78c97422cf89526309e502a290c230e8a463229f)](https://circleci.com/gh/influxdata/kapacitor/tree/master) [![Docker pulls](https://img.shields.io/docker/pulls/library/kapacitor.svg)](https://hub.docker.com/_/kapacitor/)

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](https://influxdata.com/downloads/#kapacitor) page or go get them:

```sh

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](https://github.com/influxdata/kapacitor/blob/master/etc/kapacitor/kapacitor.conf)

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

```sh

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](https://docs.influxdata.com/kapacitor/latest/introduction/getting-started/). After you finish the getting started exercise you can check out the [TICKscripts](https://github.com/influxdata/kapacitor/tree/master/examples/telegraf) for different Telegraf plugins.

# Basic Example

Kapacitor uses a DSL named [TICKscript](https://docs.influxdata.com/kapacitor/latest/tick/) to define tasks.

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

```javascript

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:

```sh

# 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

```