2016-11-07 05:23:57 +00:00
# Chronograf
2016-09-16 20:47:38 +00:00
2016-11-15 02:02:54 +00:00
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.
2017-02-24 19:46:58 +00:00
< p align = "left" >
< img src = "https://github.com/influxdata/chronograf/blob/master/docs/images/overview-readme.png" / >
< / p >
2016-09-16 20:47:38 +00:00
2016-11-07 05:23:57 +00:00
## Features
2016-11-15 02:02:54 +00:00
### 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 ](https://github.com/influxdata/chronograf/tree/master/canned ) for the supported [Telegraf ](https://github.com/influxdata/telegraf ) input plugins.
Currently, Chronograf offers dashboard templates for the following Telegraf input plugins:
2017-02-10 01:35:14 +00:00
* [Apache ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/apache )
* [Consul ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/consul )
* [Docker ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/docker )
* [Elastic ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/elasticsearch )
2016-12-06 17:24:42 +00:00
* etcd
2017-02-10 01:35:14 +00:00
* [HAProxy ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/haproxy )
2016-12-06 17:24:42 +00:00
* IIS
2017-02-10 01:35:14 +00:00
* [InfluxDB ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/influxdb )
* [Kubernetes ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/kubernetes )
* [Memcached ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/memcached )
2017-03-10 17:12:37 +00:00
* [Mesos ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/mesos )
2017-02-10 01:35:14 +00:00
* [MongoDB ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/mongodb )
* [MySQL ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/mysql )
2016-11-15 02:02:54 +00:00
* Network
2017-02-10 01:35:14 +00:00
* [NGINX ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/nginx )
* [NSQ ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/nsq )
* [Ping ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/ping )
* [PostgreSQL ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/postgresql )
2016-11-15 02:02:54 +00:00
* Processes
2017-02-10 01:35:14 +00:00
* [RabbitMQ ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/rabbitmq )
* [Redis ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/redis )
* [Riak ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/riak )
2017-01-14 19:10:39 +00:00
* [System ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/SYSTEM_README.md )
* [CPU ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/CPU_README.md )
* [Disk ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/DISK_README.md )
* [DiskIO ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/disk.go#L136 )
* [Memory ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/MEM_README.md )
2017-01-27 18:03:50 +00:00
* [Net ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/net.go )
2017-01-14 19:10:39 +00:00
* [Netstat ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/NETSTAT_README.md )
* [Processes ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/PROCESSES_README.md )
2017-01-27 18:03:50 +00:00
* [Procstat ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/procstat/README.md )
2017-02-10 01:35:14 +00:00
* [Varnish ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/varnish )
* [Windows Performance Counters ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/win_perf_counters )
2016-11-15 02:02:54 +00:00
2016-12-15 18:58:03 +00:00
> Note: If a `telegraf` instance isn't running the `system` and `cpu` plugins the canned dashboards from that instance won't be generated.
2016-11-15 02:02:54 +00:00
### Data Explorer
Chronograf's graphing tool that allows you to dig in and create personalized visualizations of your data.
2017-01-25 23:36:18 +00:00
* Generate [InfluxQL ](https://docs.influxdata.com/influxdb/latest/query_language/ ) statements with the query builder
* Generate and edit [InfluxQL ](https://docs.influxdata.com/influxdb/latest/query_language/ ) statements with the raw query editor
2016-11-15 02:02:54 +00:00
* Create visualizations and view query results in tabular format
2017-01-28 01:07:09 +00:00
### Dashboards
2017-02-15 23:17:49 +00:00
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.
2017-01-28 01:07:09 +00:00
Example:
```
curl -X POST -H "Content-Type: application/json" -d '{
"cells": [
{
"queries": [
{
"label": "%",
Introduce ability to edit a dashboard cell
* Correct documentation for dashboards
* Exclude .git and use 'make run-dev' in 'make continuous'
* Fix dashboard deletion bug where id serialization was wrong
* Commence creation of overlay technology, add autoRefresh props to DashboardPage
* Enhance overlay magnitude of overlay technology
* Add confirm buttons to overlay technology
* Refactor ResizeContainer to accommodate arbitrary containers
* Refactor ResizeContainer to require explicit ResizeTop and ResizeBottom for clarity
* Add markup and styles for OverlayControls
* CellEditorOverlay needs a larger minimum bottom height to accommodate more things
* Revert Visualization to not use ResizeTop or flex-box
* Remove TODO and move to issue
* Refactor CellEditorOverlay to allow selection of graph type
* Style Overlay controls, move confirm buttons to own stylesheet
* Fix toggle buttons in overlay so active is actually active
* Block user-select on a few UI items
* Update cell query shape to support Visualization and LayoutRenderer
* Code cleanup
* Repair fixture schema; update props for affected components
* Wired up selectedGraphType and activeQueryID in CellEditorOverlay
* Wire up chooseMeasurements in QueryBuilder
Pass queryActions into QueryBuilder so that DataExplorer can provide
actionCreators and CellEditorOverlay can provide functions that
modify its component state
* semicolon cleanup
* Bind all queryModifier actions to component state with a stateReducer
* Overlay Technologies™ can add and delete a query from a cell
* Semicolon cleanup
* Add conversion of InfluxQL to QueryConfig for dashboards
* Update go deps to add influxdb at af72d9b0e4ebe95be30e89b160f43eabaf0529ed
* Updated docs for dashboard query config
* Update CHANGELOG to mention InfluxQL to QueryConfig
* Make reducer’s name more specific for clarity
* Remove 'table' as graphType
* Make graph renaming prettier
* Remove duplicate DashboardQuery in swagger.json
* Fix swagger to include name and links for Cell
* Refactor CellEditorOverlay to enable graph type selection
* Add link.self to all Dashboard cells; add bolt migrations
* Make dash graph names only hover on contents
* Consolidate timeRange format patterns, clean up
* Add cell endpoints to dashboards
* Include Line + Stat in Visualization Type list
* Add cell link to dashboards
* Enable step plot and stacked graph in Visualization
* Overlay Technologies are summonable and dismissable
* OverlayTechnologies saves changes to a cell
* Convert NameableGraph to createClass for state
This was converted from a pure function to encapsulate the state of the
buttons. An attempt was made previously to store this state in Redux,
but it proved too convoluted with the current state of the reducers for
cells and dashboards. Another effort must take place to separate a cell
reducer to manage the state of an individual cell in Redux in order for
this state to be sanely kept in Redux as well.
For the time being, this state is being kept in the component for the
sake of expeditiousness, since this is needed for Dashboards to be
released. A refactor of this will occur later.
* Cells should contain a links key in server response
* Clean up console logs
* Use live data instead of a cellQuery fixture
* Update docs for dashboard creation
* DB and RP are already present in the Command field
* Fix LayoutRenderer’s understanding of query schema
* Return a new object, rather that mutate in place
* Visualization doesn’t use activeQueryID
* Selected is an object, not a string
* QueryBuilder refactored to use query index instead of query id
* CellEditorOverlay refactored to use query index instead of query id
* ConfirmButtons doesn’t need to act on an item
* Rename functions to follow convention
* Queries are no longer guaranteed to have ids
* Omit WHERE and GROUP BY clauses when saving query
* Select new query on add in OverlayTechnologies
* Add click outside to dash graph menu, style menu also
* Change context menu from ... to a caret
More consistent with the rest of the UI, better affordance
* Hide graph context menu in presentation mode
Don’t want people editing a dashboard from presentation mode
* Move graph refreshing spinner so it does not overlap with context menu
* Wire up Cell Menu to Overlay Technologies
* Correct empty dashboard type
* Refactor dashboard spec fixtures
* Test syncDashboardCell reducer
* Remove Delete button from graph dropdown menu (for now)
* Update changelog
2017-03-24 00:12:33 +00:00
"query": "SELECT mean(\"usage_user\") AS \"usage_user\" FROM \"telegraf\".\"autogen\".\"cpu\""
2017-01-28 01:07:09 +00:00
}
],
"type": "line"
}
],
"name": "dashboard name"
}' "http://localhost:8888/chronograf/v1/dashboards"
```
2016-11-15 02:02:54 +00:00
### Kapacitor UI
A UI for [Kapacitor ](https://github.com/influxdata/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:
2017-02-10 23:36:38 +00:00
* [Alerta ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#alerta )
* [Exec ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#exec )
2017-02-10 01:35:14 +00:00
* [HipChat ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#hipchat )
2017-02-10 22:36:43 +00:00
* [HTTP/Post ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#post )
2017-02-10 01:35:14 +00:00
* [OpsGenie ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#opsgenie )
* [PagerDuty ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#pagerduty )
* [Sensu ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#sensu )
* [Slack ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#slack )
2017-02-10 22:36:43 +00:00
* [SMTP/Email ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#email )
2017-02-10 01:35:14 +00:00
* [Talk ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#talk )
* [Telegram ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#telegram )
2017-02-10 22:36:43 +00:00
* [TCP ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#tcp )
2017-02-10 01:35:14 +00:00
* [VictorOps ](https://docs.influxdata.com/kapacitor/latest/nodes/alert_node/#victorops )
2016-11-15 02:02:54 +00:00
* View all active alerts at a glance on the alerting dashboard
2017-02-10 22:51:43 +00:00
* Enable and disable existing alert rules with the check of a box
2016-09-10 00:11:18 +00:00
2017-03-11 03:11:13 +00:00
### User and Query Management
Manage users, roles, permissions for [OSS InfluxDB ](https://github.com/influxdata/influxdb ) and InfluxData's [Enterprise ](https://docs.influxdata.com/enterprise/v1.2/ ) product.
View actively running queries and stop expensive queries on the Query Management page.
These features are new in Chronograf version 1.2.0-beta5. We recommend using them in a non-production environment only. Should you come across any bugs or unexpected behavior please open [an issue ](https://github.com/influxdata/chronograf/issues/new ). We appreciate the feedback as we work to finalize and improve the user and query management features!
### TLS/HTTPS Support
2017-02-14 16:32:37 +00:00
See [Chronograf with TLS ](https://github.com/influxdata/chronograf/blob/master/docs/tls.md ) for more information.
2017-02-23 23:31:59 +00:00
### OAuth Login
2016-12-06 17:24:42 +00:00
See [Chronograf with OAuth 2.0 ](https://github.com/influxdata/chronograf/blob/master/docs/auth.md ) for more information.
2017-01-28 00:54:32 +00:00
### Advanced Routing
2017-02-07 14:23:39 +00:00
Change the default root path of the Chronograf server with the `--basepath` option.
2017-01-28 00:54:32 +00:00
2016-11-16 21:12:55 +00:00
## Versions
2017-03-11 03:11:13 +00:00
Chronograf v1.2.0-beta5 is a beta release.
2016-11-16 21:12:55 +00:00
We will be iterating quickly based on user feedback and recommend using the [nightly builds ](https://www.influxdata.com/downloads/ ) for the time being.
Spotted a bug or have a feature request?
Please open [an issue ](https://github.com/influxdata/chronograf/issues/new )!
2016-12-05 21:02:44 +00:00
### Known Issues
The Chronograf team has identified and is working on the following issues:
* Currently, Chronograf requires users to run Telegraf's [CPU ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/CPU_README.md ) and [system ](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/SYSTEM_README.md ) plugins to ensure that all Apps appear on the [HOST LIST ](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md#host-list ) page.
2016-11-07 05:23:57 +00:00
## Installation
2016-09-10 00:11:18 +00:00
2016-11-15 02:02:54 +00:00
Check out the [INSTALLATION ](https://github.com/influxdata/chronograf/blob/master/docs/INSTALLATION.md ) guide to get up and running with Chronograf with as little configuration and code as possible.
2016-11-15 03:03:18 +00:00
We recommend installing Chronograf using one of the [pre-built packages ](https://influxdata.com/downloads/#chronograf ). Then start Chronograf using:
2016-09-10 00:11:18 +00:00
2016-11-07 05:23:57 +00:00
* `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.
2016-09-10 00:11:18 +00:00
2017-02-28 01:43:29 +00:00
By default, chronograf runs on port `8888` .
2016-11-15 15:12:41 +00:00
### With Docker
To get started right away with Docker, you can pull down our latest alpha:
```sh
docker pull quay.io/influxdb/chronograf:latest
```
2016-11-15 03:03:18 +00:00
### From Source
2016-09-10 00:11:18 +00:00
2017-02-08 15:38:55 +00:00
* Chronograf works with go 1.7.x, node 6.x/7.x, and yarn 0.18+.
2017-01-25 23:36:18 +00:00
* Chronograf requires [Kapacitor ](https://github.com/influxdata/kapacitor ) 1.1.x+ to create and store alerts.
2016-11-15 03:03:18 +00:00
1. [Install Go ](https://golang.org/doc/install )
1. [Install Node and NPM ](https://nodejs.org/en/download/ )
2017-02-08 15:38:55 +00:00
1. [Install yarn ](https://yarnpkg.com/docs/install )
2016-11-15 03:03:18 +00:00
1. [Setup your GOPATH ](https://golang.org/doc/code.html#GOPATH )
1. Run `go get github.com/influxdata/chronograf`
1. Run `cd $GOPATH/src/github.com/influxdata/chronograf`
1. Run `make`
1. To install run `go install github.com/influxdata/chronograf/cmd/chronograf`
2016-09-10 00:11:18 +00:00
2016-11-15 02:02:54 +00:00
## Documentation
2016-09-10 00:11:18 +00:00
2016-11-15 02:02:54 +00:00
[INSTALLATION ](https://github.com/influxdata/chronograf/blob/master/docs/INSTALLATION.md ) will get you up and running with Chronograf with as little configuration and code as possible.
See the [GETTING STARTED ](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md ) guide to get familiar with Chronograf's main features.
2016-09-10 00:11:18 +00:00
2016-11-15 02:02:54 +00:00
Documentation for Telegraf, InfluxDB, and Kapacitor are available at https://docs.influxdata.com/.
2016-09-10 00:11:18 +00:00
2016-11-15 02:02:54 +00:00
## Contributing
2016-09-10 00:11:18 +00:00
2016-11-15 02:02:54 +00:00
Please see the [contributing guide ](CONTRIBUTING.md ) for details on contributing to Chronograf.
