https://github.com/influxdata/kapacitor

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

https://github.com/influxdata/kapacitor

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 133 committers (0.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

kapacitor monitoring time-series

Keywords from Contributors

gnmi kafka logs opcua telegraf windows-eventlog windows-management-instrumentation xpath arrow parquet
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
  • Host: GitHub
  • Owner: influxdata
  • License: mit
  • Language: Go
  • Default Branch: master
  • Size: 21.3 MB
Statistics
  • Stars: 2,358
  • Watchers: 117
  • Forks: 487
  • Open Issues: 838
  • Releases: 45
Topics
kapacitor monitoring time-series
Created over 10 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Security

README.md

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:

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

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. After you finish the getting started exercise you can check out the TICKscripts for different Telegraf plugins.

Basic Example

Kapacitor uses a DSL named TICKscript to define tasks.

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

```javascript stream |from() .measurement('cpuusageidle') .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 \ cpualert \ -type stream \ -dbrp telegraf.default \ -tick ./cpualert.tick

Start the task

kapacitor enable cpu_alert ```

Owner

  • Name: InfluxData
  • Login: influxdata
  • Kind: organization
  • Email: contact@influxdb.com
  • Location: San Francisco, CA

GitHub Events

Total
  • Create event: 13
  • Release event: 2
  • Issues event: 12
  • Watch event: 46
  • Delete event: 7
  • Member event: 1
  • Issue comment event: 22
  • Push event: 54
  • Pull request review event: 22
  • Pull request review comment event: 10
  • Pull request event: 31
  • Fork event: 3
Last Year
  • Create event: 13
  • Release event: 2
  • Issues event: 12
  • Watch event: 46
  • Delete event: 7
  • Member event: 1
  • Issue comment event: 22
  • Push event: 54
  • Pull request review event: 22
  • Pull request review comment event: 10
  • Pull request event: 31
  • Fork event: 3

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,462
  • Total Committers: 133
  • Avg Commits per committer: 10.992
  • Development Distribution Score (DDS): 0.635
Past Year
  • Commits: 17
  • Committers: 5
  • Avg Commits per committer: 3.4
  • Development Distribution Score (DDS): 0.471
Top Committers
Name Email Commits
Nathaniel Cook n****2@g****m 534
Nathaniel Cook n****l@i****m 130
Chris Goller g****r@g****m 112
J. Emrys Landivar l****r@g****m 107
Michael Desa m****a@g****m 79
Adam a****m@i****m 30
Ross McDonald r****s@i****m 29
Yosi Attias y****1@g****m 22
Min Pae s****3@g****m 20
alespour 4****r 19
Robert Hajek r****k@g****m 18
Jakub Bednář j****r@g****m 16
dependabot[bot] 4****] 16
Minh Danh m****h@h****m 15
karel-rehor k****r@e****z 12
Matt m****t@a****k 12
Sam Arnold s****d@i****m 11
Jamie Strandboge j****e@i****m 10
Jon Seymour j****n@w****m 9
Brandon Pfeifer b****r@i****m 8
gpestana g****a@g****m 8
Jonathan A. Sternberg j****n@i****m 7
Pavel Závora p****a@b****o 7
timhallinflux t****x 7
Ross McDonald r****d 6
zabullet g****b@m****m 6
vlastahajek v****k@b****o 6
davidby-influx 7****x 5
Steven Willis o****e@g****m 5
Jonathan S. Fisher e****l@g****m 5
and 103 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 84
  • Total pull requests: 167
  • Average time to close issues: over 2 years
  • Average time to close pull requests: about 1 month
  • Total issue authors: 73
  • Total pull request authors: 27
  • Average comments per issue: 1.76
  • Average comments per pull request: 0.46
  • Merged pull requests: 120
  • Bot issues: 0
  • Bot pull requests: 37
Past Year
  • Issues: 8
  • Pull requests: 39
  • Average time to close issues: about 16 hours
  • Average time to close pull requests: 14 days
  • Issue authors: 7
  • Pull request authors: 6
  • Average comments per issue: 0.25
  • Average comments per pull request: 0.44
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 17
Top Authors
Issue Authors
  • docmerlin (3)
  • pratikdas44 (3)
  • liukaiyuliukaiyu (3)
  • Anaisdg (2)
  • gwossum (2)
  • karel-rehor (2)
  • andoks (2)
  • lfarkas (2)
  • izenn (1)
  • sanderson (1)
  • bogdanveres (1)
  • chenrui333 (1)
  • bts-dido (1)
  • subodhdharma (1)
  • cho-m (1)
Pull Request Authors
  • dependabot[bot] (37)
  • bednar (31)
  • docmerlin (19)
  • alespour (12)
  • bnpfeife (12)
  • jdstrand (10)
  • karel-rehor (9)
  • chenrui333 (6)
  • vlastahajek (6)
  • davidby-influx (5)
  • gunnaraasen (2)
  • TiagoMHCSantana (2)
  • lichenliang666 (2)
  • stefanb (1)
  • Juneezee (1)
Top Labels
Issue Labels
bug (3) new-feature (2) help wanted (1) question (1) Flaky-Test (1) security (1) security/misc (1) team/edge (1) difficulty-easy (1) pm/review (1) packaging (1)
Pull Request Labels
dependencies (37) go (32) team/edge (6) python (5) build (3) bug (3) enhancement (3) security (2) difficulty-easy (2)

Packages

  • Total packages: 2
  • Total downloads:
    • homebrew 73 last-month
  • Total docker downloads: 212,221,640
  • Total dependent packages: 7
    (may contain duplicates)
  • Total dependent repositories: 12
    (may contain duplicates)
  • Total versions: 154
proxy.golang.org: github.com/influxdata/kapacitor

A data pipeline processing engine. See the README for more complete examples and guides. Code Organization: The pipeline package provides an API for how nodes can be connected to form a pipeline. The individual implementations of each node exist in this kapacitor package. The reason for the separation is to keep the exported API from the pipeline package clean as it is consumed via the TICKscripts (a DSL for Kapacitor). Other Concepts: Stream vs Batch -- Use of the word 'stream' indicates data arrives a single data point at a time. Use of the word 'batch' indicates data arrives in sets or batches or data points. Task -- A task represents a concrete workload to perform. It consists of a pipeline and an identifying name. Basic CRUD operations can be performed on tasks. Task Master -- Responsible for executing a task in a specific environment. Replay -- Replays static datasets against tasks.

  • Versions: 145
  • Dependent Packages: 6
  • Dependent Repositories: 11
  • Docker Downloads: 212,221,640
Rankings
Docker downloads count: 0.2%
Forks count: 1.3%
Average: 1.3%
Stargazers count: 1.4%
Dependent repos count: 1.6%
Dependent packages count: 2.0%
Last synced: 6 months ago
formulae.brew.sh: kapacitor

Open source time series data processor

  • Versions: 9
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 73 Last month
Rankings
Forks count: 5.3%
Stargazers count: 10.8%
Dependent packages count: 10.8%
Average: 22.6%
Dependent repos count: 29.5%
Downloads: 56.6%
Last synced: 6 months ago