diff --git a/documentation/examples/remote_storage/remote_storage_bridge/README.md b/documentation/examples/remote_storage/remote_storage_bridge/README.md index ad194c716..4c48a7ddf 100644 --- a/documentation/examples/remote_storage/remote_storage_bridge/README.md +++ b/documentation/examples/remote_storage/remote_storage_bridge/README.md @@ -1,10 +1,13 @@ # Remote storage bridge -This is a bridge that receives samples in Prometheus's remote storage -format and forwards them to Graphite, InfluxDB, or OpenTSDB. It is meant +This is a bridge that receives samples via Prometheus's remote write +protocol and stores them in Graphite, InfluxDB, or OpenTSDB. It is meant as a replacement for the built-in specific remote storage implementations that have been removed from Prometheus. +For InfluxDB, this bridge also supports reading back data through +Prometheus via Prometheus's remote read protocol. + ## Building ``` @@ -13,10 +16,22 @@ go build ## Running -Example: +Graphite example: + +``` +./remote_storage_bridge -graphite-address=localhost:8080 +``` + +OpenTSDB example: ``` -./remote_storage_bridge -graphite-address=localhost:8080 -opentsdb-url=http://localhost:8081/ +./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: @@ -30,6 +45,11 @@ To show all flags: To configure Prometheus to send samples to this bridge, add the following to your `prometheus.yml`: ```yaml +# Remote write configuration (for Graphite, OpenTSDB, or InfluxDB). 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" ``` \ No newline at end of file