influxdb/docs/GETTING_STARTED.md

69 lines
3.4 KiB
Markdown

# Getting Started with Chronograf
Let's get familiar with some of Chronograf's main features.
In the next sections, we'll show you how Chronograf makes the monitoring and alerting for your infrastructure easy to configure and maintain.
If you haven't installed Chronograf check out the [Installation Guide](https://github.com/influxdata/chronograf/blob/master/docs/INSTALLATION.md).
### Host List
The `HOST LIST` page is essentially Chronograf's home page.
It lists every host that is sending [Telegraf](https://github.com/influxdata/telegraf) data to your [InfluxDB](https://github.com/influxdata/influxdb) instance as well a some information about each host's CPU usage, load, and configured apps.
![IMAGE]()
The Chronograf instance shown above is connected to three hosts (`telegraf-region-neverland`, `telegraf-region-narnia`, and `telegraf-region-howardsend`).
The first host `telegraf-region-neverland` is using 4.63% of its total CPU and has a load of 0.05.
It has one configured app: `system`.
Apps are Telegraf [input plugins](https://github.com/influxdata/telegraf#input-plugins) that have visualization layouts in Chronograf.
Click on the app on the `HOST LIST` page to access its visualization layout.
The visualization layout offers pre-canned graphs of the input's data that are currently in InfluxDB.
Here's the visualization layout for Telegraf's system input plugin:
![GIF]()
Notice that you can hover over the graphs to get additional information about the data, and you select alternative time ranges for the graphs using the time selector in the top right corner.
Currently Chronograf supports eight apps (we will be increasing this number with every release!):
* [InfluxDB Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/influxdb)
* [Kubernetes Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/kubernetes)
* [Docker Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/docker)
* [Redis Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/redis)
* [Postgres Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/postgresql)
* [System Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system)
* [Consul Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/consul)
* [NSQ Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/nsq)
### Data Explorer
Chronograf's Data Explorer gives you the tools to dig in and create personalized visualizations of your data.
Use the query builder to easily generate [InfluxQL](https://docs.influxdata.com/influxdb/latest/query_language/) queries and create beautiful visualizations:
![GIF]
View those same query results in tabular format:
![IMAGE]
Easily alter your query's time range with the time selector in the top right corner:
![IMAGE]
Finally, group your graphs into saved exploration sessions:
![GIF]
### Alerting
* Easily generate kapacitor alerts using the Rules UI
* Alert destinations can be configured and tested (for example, email, slack, pagerduty, etc).
* Simply generate threshold, relative and deadman alerts!
* threshold: if the data crosses a boundary alert
* relative: if the data changes over time alert
* deadman: if no data is received for some length of time, alert!
* Preview data and alert boundaries while making an alert.
* See all active alerts at a glance at the alerting dashboard