Go to file
Chris Goller 5057f57e09 Fix circle typo 2017-01-13 18:08:15 -06:00
.github Add changelog and update the PR template similar to other influxdata projects 2016-11-14 20:31:01 -06:00
archive Fix eslint issues again 2016-11-08 15:29:49 -08:00
bolt Add insecureSkipVerify option to source to accept all influxdb certs 2017-01-04 19:35:07 -06:00
canned Add rabbitmq canned dash 2017-01-09 12:33:22 -08:00
cmd/chronograf Fix missing version 2016-12-13 15:09:12 -05:00
dist Fix Content-Type of the index.html page to be text/html 2016-12-08 21:03:11 -06:00
docs Add Github organization restriction to authentication 2017-01-06 11:39:20 -06:00
etc Update build markdown output to be more user friendly 2017-01-12 18:42:48 -06:00
influx Add insecureSkipVerify option to source to accept all influxdb certs 2017-01-04 19:35:07 -06:00
jwt Refactor to remove autogenerated code. 2016-10-26 22:10:52 -05:00
kapacitor Clarifying operator values. 2017-01-06 10:45:54 -07:00
layouts Fix layouts to enforce uniqueness 2016-11-14 22:25:38 -06:00
log Add usage stats reporting 2016-10-28 14:34:55 -07:00
server Fix kapacitor auth with basic auth in header 2017-01-10 18:51:25 -06:00
ui Merge pull request #766 from influxdata/rule-template 2017-01-13 14:23:45 -08:00
uuid Refactor to remove autogenerated code. 2016-10-26 22:10:52 -05:00
.gitignore Adjult gitignore 2016-12-09 13:48:25 -08:00
CHANGELOG.md Remove periods 2017-01-13 15:15:09 -08:00
CONTRIBUTING.md Update to go 1.7.4 2016-12-06 12:35:30 -06:00
Dockerfile Update Dockerfile to use VOLUMEs 2016-11-15 09:07:12 -06:00
Godeps Update tickscript generation to use group by time as period. 2016-11-10 11:35:26 -06:00
LICENSE Update License so Github will autodetect it. 2017-01-04 22:55:23 -06:00
LICENSE_OF_DEPENDENCIES.md Add license of dependencies. 2016-11-14 10:23:45 -06:00
Makefile Add layouts as bindata in case chronograf run as a single-file binary 2016-11-14 19:07:38 -06:00
README.md Update changelog to beta6 2017-01-13 16:46:32 -06:00
agpl-3.0.md Add AGPL-3.0 2016-11-10 18:33:19 -06:00
chronograf.go Remove RangeOperator from chronograf.go, upon @goller's instruction. 2017-01-06 10:35:57 -07:00
circle.yml Fix circle typo 2017-01-13 18:08:15 -06:00

README.md

Chronograf

Chronograf is an open-source web application written in Go and React.js that provides the tools to visualize your monitoring data and easily create alerting and automation rules.

Chronograf

Features

Host List

  • List and sort hosts
  • View general CPU and load stats
  • View and access dashboard templates for configured apps

Dashboard Templates

Chronograf's pre-canned dashboards for the supported Telegraf input plugins. Currently, Chronograf offers dashboard templates for the following Telegraf input plugins:

  • Apache
  • Consul
  • Docker
  • Elastic
  • etcd
  • HAProxy
  • IIS
  • InfluxDB
  • Kubernetes
  • Memcached
  • MongoDB
  • MySQL
  • Network
  • NGINX
  • NSQ
  • Ping
  • PostgreSQL
  • Processes
  • RabbitMQ
  • Redis
  • Riak
  • System
  • Varnish
  • Windows Performance Counters

Note: If a telegraf instance isn't running the system and cpu plugins the canned dashboards from that instance won't be generated.

Data Explorer

Chronograf's graphing tool that allows you to dig in and create personalized visualizations of your data.

  • Generate InfluxQL statements with the query builder
  • Generate and edit InfluxQL statements with the raw query editor
  • Create visualizations and view query results in tabular format
  • Manage visualizations with exploration sessions

Kapacitor UI

A UI for Kapacitor alert creation and alert tracking.

  • Simply generate threshold, relative, and deadman alerts
  • Preview data and alert boundaries while creating an alert
  • Configure alert destinations - Currently, Chronograf supports sending alerts to:
    • HipChat
    • PagerDuty
    • Sensu
    • Slack
    • SMTP
    • Telegram
    • VictorOps
  • View all active alerts at a glance on the alerting dashboard

GitHub OAuth Login

See Chronograf with OAuth 2.0 for more information.

Versions

Chronograf v1.1.0-beta6 is a beta release. We will be iterating quickly based on user feedback and recommend using the nightly builds for the time being.

Spotted a bug or have a feature request? Please open an issue!

Known Issues

The Chronograf team has identified and is working on the following issues:

  • Currently, Chronograf requires users to run Telegraf's CPU and system plugins to ensure that all Apps appear on the HOST LIST page.

Installation

Check out the INSTALLATION guide to get up and running with Chronograf with as little configuration and code as possible.

We recommend installing Chronograf using one of the pre-built packages. Then start Chronograf using:

  • service chronograf start if you have installed Chronograf using an official Debian or RPM package.
  • systemctl start chronograf if you have installed Chronograf using an official Debian or RPM package, and are running a distro with systemd. For example, Ubuntu 15 or later.
  • $GOPATH/bin/chronograf if you have built Chronograf from source.

With Docker

To get started right away with Docker, you can pull down our latest alpha:

docker pull quay.io/influxdb/chronograf:latest

From Source

  • Chronograf works with go 1.7.4, npm 3.10.7 and node v6.6.0. Additional version support of these projects will be implemented soon, but these are the only supported versions to date.
  • Chronograf requires Kapacitor 1.1.x to create and store alerts.
  1. Install Go
  2. Install Node and NPM
  3. Setup your GOPATH
  4. Run go get github.com/influxdata/chronograf
  5. Run cd $GOPATH/src/github.com/influxdata/chronograf
  6. Run make
  7. To install run go install github.com/influxdata/chronograf/cmd/chronograf

Documentation

INSTALLATION will get you up and running with Chronograf with as little configuration and code as possible. See the GETTING STARTED guide to get familiar with Chronograf's main features.

Documentation for Telegraf, InfluxDB, and Kapacitor are available at https://docs.influxdata.com/.

Contributing

Please see the contributing guide for details on contributing to Chronograf.