Go to file
Regan Kuchan 9a7ccb0a34 Add section about versioning to README 2016-11-16 13:12:55 -08: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 Fix problems found by https://github.com/dominikh/go-staticcheck 2016-11-14 11:04:32 -06:00
canned Add Varnish Layout 2016-11-16 11:28:21 -05:00
cmd/chronograf Add version option 2016-11-09 13:25:07 -08:00
dist Refactor to remove autogenerated code. 2016-10-26 22:10:52 -05:00
docs Merge pull request #560 from influxdata/feature/layouts-docs 2016-11-14 22:40:03 -06:00
etc Add license of dependencies. 2016-11-14 10:23:45 -06:00
influx Fix logger panic and put logging of queries into debug 2016-11-12 17:48:49 -06:00
jwt Refactor to remove autogenerated code. 2016-10-26 22:10:52 -05:00
kapacitor Fix problems found by https://github.com/dominikh/go-staticcheck 2016-11-14 11:04:32 -06: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 layouts to enforce uniqueness 2016-11-14 22:25:38 -06:00
ui Merge pull request #546 from influxdata/warn-#487 2016-11-14 19:38:52 -08:00
uuid Refactor to remove autogenerated code. 2016-10-26 22:10:52 -05:00
.gitignore Add layouts as bindata in case chronograf run as a single-file binary 2016-11-14 19:07:38 -06:00
CHANGELOG.md Update changelog w/ new varnish layout 2016-11-16 11:33:55 -05:00
CONTRIBUTING.md First version of CONTRIBUTING.md 2016-11-03 11:31:05 -07: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 Add AGPL-3.0 2016-11-10 18:33:19 -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 Add section about versioning to README 2016-11-16 13:12:55 -08:00
agpl-3.0.md Add AGPL-3.0 2016-11-10 18:33:19 -06:00
chronograf.go Merge pull request #451 from influxdata/feature/ga-remove-pw-todos 2016-11-10 12:26:53 -06:00
circle.yml Update circle to push to quay and use go 1.7.3 2016-11-15 10:05:51 -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
  • System
  • Docker
  • HAProxy
  • InfluxDB
  • Kubernetes
  • System
  • Memcached
  • MongoDB
  • MySQL
  • Network
  • NGINX
  • NSQ
  • Ping
  • PostgreSQL
  • Processes
  • Redis
  • Riak
  • Windows Performance Counters
  • IIS
  • etcd
  • Elastic
  • Varnish

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

Versions

Chronograf v1.1.0-alpha is an alpha 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!

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