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
• Mesos
• MongoDB
• MySQL
• Network
• NGINX
• NSQ
• PHPfpm
• Ping
• PostgreSQL
• Processes
• RabbitMQ
• Redis
• Riak
• System
  • CPU
  • Disk
  • DiskIO
  • Memory
  • Net
  • Netstat
  • Processes
  • Procstat
• 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 and edit InfluxQL statements with the query editor
• Use Chronograf's query templates to easily explore your data
• Create visualizations and view query results in tabular format

Dashboards

Create and edit customized dashboards. The dashboards support several visualization types including line graphs, stacked graphs, step plots, single statistic graphs, and line-single-statistic graphs.

Use Chronograf's template variables to easily adjust the data that appear in your graphs and gain deeper insight into your data.

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:
  • Alerta
  • Exec
  • HTTP/Post
  • OpsGenie
  • PagerDuty
  • Sensu
  • Slack
  • SMTP/Email
  • Talk
  • Telegram
  • TCP
  • VictorOps
• View all active alerts at a glance on the alerting dashboard
• Enable and disable existing alert rules with the check of a box
• Configure multiple Kapacitor instances per InfluxDB source

User and Query Management

Manage users, roles, permissions for OSS InfluxDB and InfluxData's Enterprise product. View actively running queries and stop expensive queries on the Query Management page.

TLS/HTTPS Support

See Chronograf with TLS for more information.

OAuth Login

See Chronograf with OAuth 2.0 for more information.

Advanced Routing

Change the default root path of the Chronograf server with the --basepath option.

Versions

Find the most recent version of Chronograf here.

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 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.

By default, chronograf runs on port 8888.

With Docker

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

docker pull chronograf:latest

From Source

• Chronograf works with go 1.18+, node 12 LTS, and yarn 1.7+.
• Chronograf requires Kapacitor 1.5.x+ to create and store alerts.

1. Install Go 1.18
2. Install Node (version 16 LTS)
3. Install yarn
4. Setup your GOPATH
5. Build the Chronograf package:

   go get github.com/influxdata/chronograf
   cd $GOPATH/src/github.com/influxdata/chronograf
   make

6. Install the newly built Chronograf package:

   go install github.com/influxdata/chronograf/cmd/chronograf

Upgrading

In order to upgrade from a Chronograf older than 1.4.0 (<=1.3.10) to 1.8 or newer, you must first upgrade to any version between 1.4.0 and the newest 1.7.x version.

Compatibility

Chronograf 1.8 introduces a breaking change in the dashboards API (/chronograf/v1/dashboards) which may affect certain clients. The id previously was being returned as an integer. Since javascript can't cleanly handle numbers with more than 16 digits (console.log(12345678901234567890) yields 12345678901234567000), integer ids have been exposed as strings. As with other resource ids, they will remain stored internally as integers, so no database migration is required. If using .dashboard files to pre-populate available dashboards, those files should be updated and the id should be converted to a string value.

Documentation

Getting Started will get you up and running with Chronograf with as little configuration and code as possible. See our guides to get familiar with Chronograf's main features.

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

Chronograf uses swagger to document its REST interfaces. To reach the documentation, run the server and go to the /docs for example at http://localhost:8888/docs

The swagger JSON document is in server/swagger.json

Contributing

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