Skip to content

Commit fabbbaa

Browse files
author
Mike Holloway
committed
2 parents 8286b50 + d7aa239 commit fabbbaa

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,24 @@
22

33
An Errbot plugin that queries Prometheus via it's API
44

5-
For many of the built-in commands, you'll need to configure Prometheus to scrape your Alertmanagers and also your hosts via [NetData](https://my-netdata.io/)
5+
For many of the built-in promql commands to work, you'll need to configure your Prometheus instance to scrape Alertmanagers as well as your hosts via [NetData](https://my-netdata.io/). This is done by default for [swarmstack](https://github.com/swarmstack/swarmstack) users who have installed Prometheus/Alertmanager/NetData using the swarmstack.yml playbook. If you wish to modify the included commands, consider forking this Github repo and altering promql.py for your own needs. The swarmstack [errbot-docker](https://github.com/swarmstack/errbot-docker) project also includes facilities for you to install locally-modified plugins directly into a Docker container if hosting your own copy via public or private repo isn't an option for you.
66

7-
If you need an Errbot docker image, see [swarmstack/errbot-docker](https://github.com/swarmstack/errbot-docker). The default configuration string displayed by calling _!plugin config PromQL_ can be used as-shown for [swarmstack](https://github.com/swarmstack/swarmstack) users. Otherwise, replace _task.prometheus_ (below) with your Prometheus _server IP or hostname_.
7+
If you need an Errbot docker image, see [swarmstack/errbot-docker](https://github.com/swarmstack/errbot-docker), you will need to configure your Errbot's webserver (documented in that project) before proceeding to configure Errbot plugins such as errbot-promql below.
8+
9+
The default configuration string displayed by calling _!plugin config PromQL_ can be used as-shown below for [swarmstack](https://github.com/swarmstack/swarmstack) users. Otherwise, replace _http://prometheus_ (below) with your Prometheus _server IP or hostname_.
810

911
## Installation
1012

1113
```
1214
repos install https://github.com/swarmstack/errbot-promql
1315
14-
plugin config PromQL {'PROMQL_URL': 'http://tasks.prometheus:9090/api/v1'}
16+
plugin config PromQL {'PROMQL_URL': 'http://prometheus:9090/api/v1'}
17+
```
18+
19+
## Updating
20+
21+
```
22+
repos update swarmstack/errbot-promql
1523
```
1624

1725
## Usage

0 commit comments

Comments
 (0)