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.

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
• Redis
• Riak
• System
• Varnish
• Windows Performance Counters

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
• 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-beta1 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:

• Chronograf v1.1.0-beta1 does not support creating and editing raw queries in the Data Explorer. Currently, users must create all queries with the Data Explorer's query builder.
• Chronograf's OAuth 2.0 Style Authentication allows all users to authenticate with their GitHub account. It does not yet offer any security or allow administrators to filter users.
• 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.