Skip to content

Commit a3482e0

Browse files
Update README
1 parent 68188f5 commit a3482e0

1 file changed

Lines changed: 16 additions & 6 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# hubot-grafana
1+
# Grafana for Hubot
22

3-
Query Grafana dashboards and graphs
4-
5-
See [`src/grafana.coffee`](src/grafana.coffee) for full documentation.
3+
Query Grafana dashboards.
64

75
## Installation
86

@@ -18,9 +16,21 @@ Then add **hubot-grafana** to your `external-scripts.json`:
1816
]
1917
```
2018

19+
## Configuration Variables
20+
21+
- `HUBOT_GRAFANA_HOST` - Host for your Grafana 2.0 install, e.g. 'http://play.grafana.org'
22+
- `HUBOT_GRAFANA_API_KEY` - API key for a particular user
23+
24+
Example:
25+
26+
```
27+
export HUBOT_GRAFANA_HOST=http://play.grafana.org
28+
export HUBOT_GRAFANA_API_KEY=abcd01234deadbeef01234
29+
```
30+
2131
## Sample Interaction
2232

2333
```
24-
user1>> hubot hello
25-
hubot>> hello!
34+
user1>> hubot grafana dashboard graphite-carbon-metrics
35+
hubot>> Graphite Carbon Metrics: http://play.grafana.org/render/dashboard/solo/graphite-carbon-metrics/?panelId=1&width=1000&height=500&from=now-6h - http://play.grafana.org/dashboard/db/graphite-carbon-metrics/?panelId=1&fullscreen&from=now-6h
2636
```

0 commit comments

Comments
 (0)