Skip to content

Commit 7f31baf

Browse files
committed
Update README
Signed-off-by: Markus Blaschke <[email protected]>
1 parent efa2faf commit 7f31baf

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,32 @@ The alerts are stored in Elasticsearch as [alert groups][].
1818
[Elasticsearch]: https://www.elastic.co/products/elasticsearch
1919
[HTTP webhook]: https://prometheus.io/docs/alerting/configuration/#webhook-receiver-<webhook_config>
2020

21+
## Usage
22+
23+
```
24+
Usage:
25+
alertmanager2es [OPTIONS]
26+
27+
Application Options:
28+
-v, --verbose verbose mode [$VERBOSE]
29+
--bind= Server address (default: :9097) [$SERVER_BIND]
30+
--elasticsearch.address= ElasticSearch urls [$ELASTICSEARCH_ADDRESS]
31+
--elasticsearch.username= ElasticSearch username for HTTP Basic
32+
Authentication [$ELASTICSEARCH_USERNAME]
33+
--elasticsearch.password= ElasticSearch password for HTTP Basic
34+
Authentication [$ELASTICSEARCH_PASSWORD]
35+
--elasticsearch.apikey= ElasticSearch base64-encoded token for
36+
authorization; if set, overrides username and
37+
password [$ELASTICSEARCH_APIKEY]
38+
--elasticsearch.index= ElasticSearch index name (placeholders: %y for
39+
year, %m for month and %d for day) (default:
40+
alertmanager-%y.%m) [$ELASTICSEARCH_INDEX]
41+
42+
Help Options:
43+
-h, --help Show this help message
44+
```
45+
46+
2147
## Rationale
2248

2349
It can be useful to see which alerts fired over a given time period, and

0 commit comments

Comments
 (0)