Commit 952a69ab by Torkel Ödegaard

docs(tutorial): updated hubot tutorial

parent aa21bfd8
...@@ -14,7 +14,10 @@ as it does in your browser. ...@@ -14,7 +14,10 @@ as it does in your browser.
This guide will show you how to install and configure the [Hubot-Grafana](https://github.com/stephenyeargin/hubot-grafana) This guide will show you how to install and configure the [Hubot-Grafana](https://github.com/stephenyeargin/hubot-grafana)
plugin. This plugin allows you to tell hubot to render any dashboard or graph right from a channel in plugin. This plugin allows you to tell hubot to render any dashboard or graph right from a channel in
Slack, Hipchat or Basecamp. The bot will respond with an image of the graph and a link that will Slack, Hipchat or Basecamp. The bot will respond with an image of the graph and a link that will
take you the graph. take you to the graph.
> *Amazon S3 Required*: The hubot-grafana script will upload the rendered graphs to Amazon S3. This
> is so Hipchat and Slack can show them reliably (they require the image to be publicly available).
<div class="text-center"> <div class="text-center">
<img src="/img/tutorials/hubot_grafana.png" class="center"></a> <img src="/img/tutorials/hubot_grafana.png" class="center"></a>
...@@ -72,12 +75,12 @@ You can add these from the API Keys page wich you find in the Organization dropd ...@@ -72,12 +75,12 @@ You can add these from the API Keys page wich you find in the Organization dropd
### Amazon S3 ### Amazon S3
The `S3` options are optional but for the images to work properly in services like Slack and Hipchat they need The `S3` options are optional but for the images to work properly in services like Slack and Hipchat they need
to publicly available. By specifying the `S3` options the hubot-grafana script will publish the rendered to publicly available. By specifying the `S3` options the hubot-grafana script will publish the rendered
panel to `S3` it will use that URL when it posts to Slack or Hipchat. panel to `S3` and it will use that URL when it posts to Slack or Hipchat.
For everything to work
## Hubot commands ## Hubot commands
- `hubot graf list`
- Lists the available dashboards
- `hubot graf db graphite-carbon-metrics` - `hubot graf db graphite-carbon-metrics`
- Graph all panels in the dashboard - Graph all panels in the dashboard
- `hubot graf db graphite-carbon-metrics:3` - `hubot graf db graphite-carbon-metrics:3`
...@@ -92,12 +95,10 @@ For everything to work ...@@ -92,12 +95,10 @@ For everything to work
- Get only the third panel of a particular dashboard with a window of 8 days ago to yesterday - Get only the third panel of a particular dashboard with a window of 8 days ago to yesterday
- `hubot graf db graphite-carbon-metrics host=carbon-a` - `hubot graf db graphite-carbon-metrics host=carbon-a`
- Get a templated dashboard with the `$host` parameter set to `carbon-a` - Get a templated dashboard with the `$host` parameter set to `carbon-a`
- `hubot graf list`
- Lists the available dashboards
## Aliases ## Aliases
Some of the hubot commands above can lengthy and you might have to remember dashboard slug (url id). Some of the hubot commands above can lengthy and you might have to remember the dashboard slug (url id).
If you have a few favorite graphs you want to be able check up on often (lets say from your mobile) you If you have a few favorite graphs you want to be able check up on often (let's say from your mobile) you
can create hubot command aliases with the hubot script `hubot-alias`. can create hubot command aliases with the hubot script `hubot-alias`.
Install it: Install it:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment