Update image links for merge

pull/548/head
Regan Kuchan 2016-11-14 18:14:52 -08:00
parent 616c3e7ce0
commit 0fb6ba7943
3 changed files with 13 additions and 14 deletions

View File

@ -2,7 +2,7 @@
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)
![Chronograf](https://github.com/influxdata/chronograf/blob/master/docs/images/overview-readme.png)
## Features

View File

@ -10,7 +10,7 @@ If you haven't installed Chronograf check out the [Installation Guide](https://g
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.
![Host List](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/host-list-gs.png)
![Host List](https://github.com/influxdata/chronograf/blob/master/docs/images/host-list-gs.png)
The Chronograf instance shown above is connected to three hosts (`telegraf-region-neverland`, `telegraf-region-narnia`, and `telegraf-region-howardsend`).
The first host is using 9.96% of its total CPU and has a load of 0.15.
@ -21,7 +21,7 @@ Click on the app on the `HOST LIST` page to access its dashboard template.
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 stats](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugin:
![System Graph Layout](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/system-layout-gs.gif)
![System Graph Layout](https://github.com/influxdata/chronograf/blob/master/docs/images/system-layout-gs.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 by using the time selector in the top right corner.
@ -33,11 +33,11 @@ Chronograf's Data Explorer gives you the tools to dig in and create personalized
Use the query builder to easily generate [InfluxQL](https://docs.influxdata.com/influxdb/latest/query_language/) queries and create beautiful visualizations:
![Data Exploration](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/data-exploration-gs.gif)
![Data Exploration](https://github.com/influxdata/chronograf/blob/master/docs/images/data-exploration-gs.gif)
You can also view those same query results in tabular format (1), easily alter the query's time range with the time range selector (2), and save your graphs in individual exploration sessions (3):
![Data Exploration Extras](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/data-exploration-extras-gs.png)
![Data Exploration Extras](https://github.com/influxdata/chronograf/blob/master/docs/images/data-exploration-extras-gs.png)
## Create and View Alerts
@ -50,7 +50,7 @@ Then, click on the `Add New Rule` button to create a new alert rule.
The example rule shown below operates on data from Telegraf's [system stats](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugin and sends a simple threshold alert to Slack:
![Example Rule](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/example-rule-gs.png)
![Example Rule](https://github.com/influxdata/chronograf/blob/master/docs/images/example-rule-gs.png)
The `Select a Time Series` section includes an [InfluxQL](https://docs.influxdata.com/influxdb/latest/query_language/) query builder which allows us to specify the target data for the alert rule.
The example shown above is working with the system stat's `usage_idle` [field](https://docs.influxdata.com/influxdb/v1.1/concepts/glossary/#field) in the `cpu` [measurement](https://docs.influxdata.com/influxdb/v1.1/concepts/glossary/#measurement).
@ -69,7 +69,7 @@ Lastly, the `Alert Message` section allows you to personalize the alert message
The rule shown above sends alert messages to a Slack channel.
Here's an example of the alert messages in Slack:
![Slack Alert](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/slack-alert-gs.png)
![Slack Alert](https://github.com/influxdata/chronograf/blob/master/docs/images/slack-alert-gs.png)
Currently, Chronograf supports the following alert endpoints: HipChat, PagerDuty, Sensu, Slack, SMTP, Telegram, and VictorOps.
You can configure your alert endpoints on the `CONFIGURE KAPACITOR` page.
@ -79,4 +79,4 @@ You can configure your alert endpoints on the `CONFIGURE KAPACITOR` page.
See all active alerts on the `ALERTING` page, and filter them by `Name`,
`Level`, and `Host`:
![Alert View](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/alert-view-gs.gif)
![Alert View](https://github.com/influxdata/chronograf/blob/master/docs/images/alert-view-gs.gif)

View File

@ -207,8 +207,7 @@ Point your web browser to `http://localhost:8888` (replace `localhost` with your
You should see a welcome page:
![Chronograf Welcome Page](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/welcome.png)
![Chronograf Welcome Page](https://github.com/influxdata/chronograf/blob/master/docs/images/welcome.png)
The next steps connect Chronograf to your InfluxDB instance.
For the `Connection String`, enter the hostname or IP of the machine that InfluxDB is running on, and be sure to include InfluxDB's default port: `8086`.
@ -217,14 +216,14 @@ Finally, there's no need to enter any information for the `Username` and `Passwo
Click `Create New Server` to move on to the `HOST LIST` page:
![Chronograf Host List Page](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/host-list.png)
![Chronograf Host List Page](https://github.com/influxdata/chronograf/blob/master/docs/images/host-list.png)
You should see your machine's hostname on the page along with information about its CPU usage and load.
Assuming you've configured Telegraf's system stats input plugin, `system` should appear in the `Apps` column.
Go ahead and click on the hostname to see a series of system level graphs about
your host:
![System Stats Graphs](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/system.png)
![System Stats Graphs](https://github.com/influxdata/chronograf/blob/master/docs/images/system.png)
#### 4. Connect Chronograf to Kapacitor
@ -232,7 +231,7 @@ The final step in the installation process is to connect Chronograf to Kapacitor
Hover over the last item in the left navigation menu and click `Kapacitor` to
get to the `CONFIGURE KAPACITOR` page.
![Configure Kapacitor](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/configure-kapacitor.png)
![Configure Kapacitor](https://github.com/influxdata/chronograf/blob/master/docs/images/configure-kapacitor.png)
For the `Connection String`, enter the hostname or IP of the machine that Kapacitor is running on, and be sure to include Kapacitor's default port: `9092`.
Next, name the connection string; this can be anything you want.
@ -243,7 +242,7 @@ If Kapacitor successfully connects you'll see an
[Alert Endpoints](https://docs.influxdata.com/kapacitor/v1.0/nodes/alert_node/)
section below the `Connection Details` section:
![Alert Endpoints](https://github.com/influxdata/chronograf/blob/rk-doc-edits/docs/images/alert-endpoints.png)
![Alert Endpoints](https://github.com/influxdata/chronograf/blob/master/docs/images/alert-endpoints.png)
That's it! You've successfully downloaded, installed, and configured each component of the TICK stack.
Check out the [Getting Started](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md) guide to familiarize yourself with Chronograf and see all that it can do for you!