From ceb6d1459fa072013e7bae4d8277a0f5ff402749 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Sat, 28 Mar 2020 23:16:38 +0200 Subject: [PATCH] docs/vmagent.md: add `prometheus remote_write proxy` use case --- app/vmagent/README.md | 11 ++++++++++- docs/vmagent.md | 11 ++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/app/vmagent/README.md b/app/vmagent/README.md index f379cbc6b2..458a0ed860 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -1,7 +1,8 @@ ## vmagent `vmagent` is a tiny but brave agent, which helps you collecting metrics from various sources -and storing them to [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics). +and storing them to [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics) +or any other Prometheus-compatible storage system that supports `remote_write` protocol. vmagent @@ -105,6 +106,14 @@ data among long-term remote storage, short-term remote storage and real-time ana Note that each destination can receive its own subset of the collected data thanks to per-destination relabeling via `-remoteWrite.urlRelabelConfig`. +#### Prometheus remote_write proxy + +`vmagent` may be used as a proxy for Prometheus data sent via Prometheus `remote_write` protocol. It can accept data via `remote_write` API +at `/api/v1/write` endpoint, apply relabeling and filtering and then proxy it to another `remote_write` systems. +The `vmagent` can be configured to encrypt the incoming `remote_write` requests with `-tls*` command-line flags. +Additionally, Basic Auth can be enabled for the incoming `remote_write` requests with `-httpAuth.*` command-line flags. + + ### How to collect metrics in Prometheus format diff --git a/docs/vmagent.md b/docs/vmagent.md index f379cbc6b2..458a0ed860 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -1,7 +1,8 @@ ## vmagent `vmagent` is a tiny but brave agent, which helps you collecting metrics from various sources -and storing them to [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics). +and storing them to [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics) +or any other Prometheus-compatible storage system that supports `remote_write` protocol. vmagent @@ -105,6 +106,14 @@ data among long-term remote storage, short-term remote storage and real-time ana Note that each destination can receive its own subset of the collected data thanks to per-destination relabeling via `-remoteWrite.urlRelabelConfig`. +#### Prometheus remote_write proxy + +`vmagent` may be used as a proxy for Prometheus data sent via Prometheus `remote_write` protocol. It can accept data via `remote_write` API +at `/api/v1/write` endpoint, apply relabeling and filtering and then proxy it to another `remote_write` systems. +The `vmagent` can be configured to encrypt the incoming `remote_write` requests with `-tls*` command-line flags. +Additionally, Basic Auth can be enabled for the incoming `remote_write` requests with `-httpAuth.*` command-line flags. + + ### How to collect metrics in Prometheus format