Update README

pull/10616/head
Regan Kuchan 2016-11-14 18:02:54 -08:00
parent 3747ae203a
commit 244d7e764c
2 changed files with 72 additions and 19 deletions

View File

@ -1,41 +1,94 @@
# Chronograf
## An Open-Source UI for Monitoring and Alerting your Infrastructure
Chronograf is an open-source web application written in go and react.js that is designed to simply and easily visualize your monitoring data and provide tools to create alerting and automation rules.
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](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/overview-readme.png)
## Features
* High level infrastructure view and search
* Application specific monitoring for:
* System stats
* InfluxDB
* Docker Containers
* Kubernetes
* Redis
* NSQ
* MySQL
* PostgreSQL
* Kapacitor alert creation and tracking
### 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:
* Apache
* Consul
* System
* Docker
* HAProxy
* InfluxDB
* Kubernetes
* System
* Memcached
* MongoDB
* MySQL
* Network
* Nginx
* NSQ
* Ping
* PostgreSQL
* Processes
* Redis
* Riak
* Win_system
* IIS
* etcd
* Elastic
### Data Explorer
Chronograf's graphing tool that allows you to dig in and create personalized visualizations of your data.
* Generate [InfluxQL](https://docs.influxdata.com/influxdb/v1.1/query_language/) 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](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:
* HipChat
* PagerDuty
* Sensu
* Slack
* SMTP
* Telegram
* VictorOps
* View all active alerts at a glance on the alerting dashboard
## Installation
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.
We recommend installing Chrongraf using one of the [pre-built packages](https://influxdata.com/downloads/#chronograf). 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.
## Builds
## Build Requirements
* 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.
* Chronograf requires [Kapacitor](https://github.com/influxdata/kapacitor) 1.1 to create and store alerts.
* To build assets and the go server, run `make`.
* To run server either `./chronograf --port 8888` or `make run`
## Getting Started
See the [getting started](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md) guide for setup instructions for chronograf and the other components of the [TICK stack](https://www.influxdata.com/get-started/what-is-the-tick-stack/)
## Documentation
[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.
Documentation for Telegraf, InfluxDB, and Kapacitor are available at https://docs.influxdata.com/.
## Contributing
Please see the [contributing guide](CONTRIBUTING.md) for details on contributing to Chronograf.

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB