Open source monitoring and visualization UI for the TICK stack
Switch branches/tags
Clone or download
Latest commit d6f6649 Sep 25, 2018
Permalink
Failed to load latest commit information.
.circleci Remove deprecated email flag Jun 18, 2018
.github Update PR template to include checkbox for Swagger docs Apr 18, 2018
bolt Add type property to queries (#4458) Sep 14, 2018
canned Update cmd to com Jul 10, 2018
cmd merged upstream, updated comments, added GroupFromClaims() Feb 20, 2018
dist Update to fix go linter issues Mar 6, 2017
docs Update oauth documentation link to non broken link Mar 9, 2018
enterprise Remove concurrency from source authentication test Jul 2, 2018
etc Update to Go 1.10 and Node 8.10.0 Mar 29, 2018
filestore feat: protoboard api Aug 14, 2018
flux Flux/connections page (#4026) Jul 27, 2018
id Add id generator based on time Dec 19, 2017
influx Add support for user-defined annotation tags Aug 6, 2018
integrations Add type property to queries (#4458) Sep 14, 2018
kapacitor Fix leaking sockets in Kapacitor client Aug 31, 2018
log Add structured logging to underlying http server Mar 6, 2017
memdb Move MultiSourceStore to the multistore package Dec 19, 2017
mocks feat: protoboard api Aug 14, 2018
multistore Add organization multistore over bolt and filesystem Dec 19, 2017
noop Rename org config method Update to Put for semantic accuracy Jul 10, 2018
oauth2 -Less restrictive key equalness check in OAuth due to providers like … Jul 9, 2018
organizations Rename org config method Update to Put for semantic accuracy Jul 10, 2018
protoboards Add suggestprotoboards function at dashboard step Sep 6, 2018
roles merged upstream, updated comments, added GroupFromClaims() Feb 20, 2018
server Display more error information in flux editor Sep 24, 2018
ui Check response uuid for updating linegraph Sep 25, 2018
v2 review(chronograf): make changes suggested in pr Jul 18, 2018
vendor Update flux golang dependencies Sep 10, 2018
.bumpversion.cfg Update master to 1.7.0 and use bumpversion for makefile config instea… Jul 23, 2018
.eslintrc Upgrade prettier to 1.11.1 Mar 21, 2018
.gitattributes Revert "Temp commit" Apr 8, 2017
.gitignore Merge pull request #4018 from influxdata/generic-wizard Jul 26, 2018
CHANGELOG.md Merge pull request #4479 from influxdata/bugfix/validate-alert-rule-m… Sep 24, 2018
CONTRIBUTING.md Update to Go 1.10 and Node 8.10.0 Mar 29, 2018
Dockerfile merged upstream, updated comments, added GroupFromClaims() Feb 20, 2018
Gopkg.lock Update flux golang dependencies Sep 10, 2018
Gopkg.toml Update flux golang dependencies Sep 10, 2018
LICENSE Update location of InfluxData in the LICENSE file Mar 9, 2017
LICENSE_OF_DEPENDENCIES.md Add download.js license Sep 13, 2017
Makefile Fix error when running `run-dev` after `clean` target Aug 1, 2018
README.md Update master to 1.7.0 and use bumpversion for makefile config instea… Jul 23, 2018
agpl-3.0.md Add AGPL-3.0 Nov 11, 2016
chronograf.go Add type property to queries (#4458) Sep 14, 2018
kapacitor.go Fixes topic saving for kafka handler May 22, 2018
platform_migrate.md Add documentation on how to migrate changes to platform Jul 26, 2018

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.

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:

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

The most recent version of Chronograf is v1.7.0.

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:1.7.0

From Source

  • Chronograf works with go 1.10+, node 8.x, and yarn 1.5+.
  • Chronograf requires Kapacitor 1.2.x+ to create and store alerts.
  1. Install Go
  2. Install Node and NPM
  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

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.