From c030d920ddc49a81e02879316d750ebbefa596ec Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 6 Jul 2022 13:00:34 +0300 Subject: [PATCH] docs/Cluster-VictoriaMetrics.md: sync with cluster branch after f51bc07d977cce47e293193573d72b317da2d45c --- docs/Cluster-VictoriaMetrics.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 03d7dfa7f..19841de85 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -256,6 +256,9 @@ See [trobuleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html Note that the `delete_series` handler should be used only in exceptional cases such as deletion of accidentally ingested incorrect time series. It shouldn't be used on a regular basis, since it carries non-zero overhead. +- URL for accessing [vmalert's](https://docs.victoriametrics.com/vmalert.html) UI: `http://:8481/select//prometheus/vmalert/home`. + This URL works only when `-vmalert.proxyURL` flag is set. See more about vmalert [here](#vmalert). + - `vmstorage` nodes provide the following HTTP endpoints on `8482` port: - `/internal/force_merge` - initiate [forced compactions](https://docs.victoriametrics.com/#forced-merge) on the given `vmstorage` node. - `/snapshot/create` - create [instant snapshot](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282), @@ -468,6 +471,17 @@ curl http://0.0.0.0:8480/debug/pprof/heap > mem.pprof +## vmalert + +vmselect is capable of proxying requests to [vmalert](https://docs.victoriametrics.com/vmalert.html) +when `-vmalert.proxyURL` flag is set. Use this feature for the following cases: +* for proxying requests from [Grafana Alerting UI](https://grafana.com/docs/grafana/latest/alerting/); +* for accessing vmalert's UI through vmselect's Web interface. + +For accessing vmalert's UI through vmselect configure `-vmalert.proxyURL` flag and visit +`http://:8481/select//prometheus/vmalert/home` link. + + ## Community and contributions We are open to third-party pull requests provided they follow the [KISS design principle](https://en.wikipedia.org/wiki/KISS_principle): @@ -821,7 +835,7 @@ Below is the output for `/path/to/vmselect -help`: -version Show VictoriaMetrics version -vmalert.proxyURL string - Optional URL for proxying alerting API requests from Grafana. For example, if -vmalert.proxyURL is set to http://vmalert:8880 , then requests to /api/v1/rules are proxied to http://vmalert:8880/api/v1/rules + Optional URL for proxying requests to vmalert. For example, if -vmalert.proxyURL=http://vmalert:8880 , then alerting API requests such as /api/v1/rules from Grafana will be proxied to http://vmalert:8880/api/v1/rules -vmstorageDialTimeout duration Timeout for establishing RPC connections from vmselect to vmstorage (default 5s) ```