linux-devops/chronograf

Open source monitoring and visualization UI for the TICK stack

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

Dashboards

While there is an API and presentation layer for dashboards released in version 1.2.0-beta1+, it is not recommended that you try to use Chronograf as a general purpose dashboard solution. The visualization around editing is under way and will be in a future release. Meanwhile, if you would like to try it out you can use curl or other HTTP tools to push dashboard definitions directly to the API. If you do so, they should be shown when selected in the application.

Example:

curl -X POST -H "Content-Type: application/json" -d '{
    "cells": [
        {
            "queries": [
                {
                    "label": "%",
                    "query": "SELECT mean(\"usage_user\") AS \"usage_user\" FROM \"cpu\"",
                    "wheres": [],
                    "groupbys": []
                }
            ],
            "type": "line"
        }
    ],
    "name": "dashboard name"
}' "http://localhost:8888/chronograf/v1/dashboards"

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
  • HipChat
  • 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

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

Chronograf v1.2.0-beta4 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.

By default, chronograf runs on port 8888.

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.x, node 6.x/7.x, and yarn 0.18+.
• Chronograf requires Kapacitor 1.1.x+ to create and store alerts.

1. Install Go
2. Install Node and NPM
3. Install yarn
4. Setup your GOPATH
5. Run go get github.com/influxdata/chronograf
6. Run cd $GOPATH/src/github.com/influxdata/chronograf
7. Run make
8. 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.