Update remote storage bridge README.md

This commit is contained in:
Julius Volz 2017-04-02 23:14:56 +02:00
parent b391cbb808
commit 3581057ea4

View file

@ -1,10 +1,13 @@
# Remote storage bridge # Remote storage bridge
This is a bridge that receives samples in Prometheus's remote storage This is a bridge that receives samples via Prometheus's remote write
format and forwards them to Graphite, InfluxDB, or OpenTSDB. It is meant protocol and stores them in Graphite, InfluxDB, or OpenTSDB. It is meant
as a replacement for the built-in specific remote storage implementations as a replacement for the built-in specific remote storage implementations
that have been removed from Prometheus. that have been removed from Prometheus.
For InfluxDB, this bridge also supports reading back data through
Prometheus via Prometheus's remote read protocol.
## Building ## Building
``` ```
@ -13,10 +16,22 @@ go build
## Running ## Running
Example: Graphite example:
``` ```
./remote_storage_bridge -graphite-address=localhost:8080 -opentsdb-url=http://localhost:8081/ ./remote_storage_bridge -graphite-address=localhost:8080
```
OpenTSDB example:
```
./remote_storage_bridge -opentsdb-url=http://localhost:8081/
```
InfluxDB example:
```
./remote_storage_bridge -influxdb-url=http://localhost:8086/ -influxdb.database=prometheus -influxdb.retention-policy=autogen
``` ```
To show all flags: To show all flags:
@ -30,6 +45,11 @@ To show all flags:
To configure Prometheus to send samples to this bridge, add the following to your `prometheus.yml`: To configure Prometheus to send samples to this bridge, add the following to your `prometheus.yml`:
```yaml ```yaml
# Remote write configuration (for Graphite, OpenTSDB, or InfluxDB).
remote_write: remote_write:
url: "http://localhost:9201/receive" - url: "http://localhost:9201/write"
# Remote read configuration (for InfluxDB only at the moment).
remote_read:
- url: "http://localhost:9201/read"
``` ```