From 7a0094adaefee51e8afb5dc2234868d0a1acb975 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 11 Nov 2020 16:01:08 +0200 Subject: [PATCH] docs/vmagent.md: add `Configuration update` section --- app/vmagent/README.md | 16 ++++++++++++++++ docs/vmagent.md | 16 ++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/app/vmagent/README.md b/app/vmagent/README.md index b21928d402..3cae6941ab 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -63,6 +63,22 @@ Then send Influx data to `http://vmagent-host:8429`. See [these docs](https://gi Pass `-help` to `vmagent` in order to see the full list of supported command-line flags with their descriptions. +### Configuration update + +`vmagent` should be restarted in order to update config options set via command-line args. + +`vmagent` supports multiple approaches for reloading configs from updated config files such as `-promscrape.config`, `-remoteWrite.relabelConfig` and `-remoteWrite.urlRelabelConfig`: + +* Sending `SUGHUP` signal to `vmagent` process: + ```bash + kill -SIGHUP `pidof vmagent` + ``` + +* Sending HTTP request to `http://vmagent:8429/-/reload` endpoint. + +There is also `-promscrape.configCheckInterval` command-line option, which can be used for automatic reloading configs from of updated `-promscrape.config` file. + + ### Use cases diff --git a/docs/vmagent.md b/docs/vmagent.md index b21928d402..3cae6941ab 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -63,6 +63,22 @@ Then send Influx data to `http://vmagent-host:8429`. See [these docs](https://gi Pass `-help` to `vmagent` in order to see the full list of supported command-line flags with their descriptions. +### Configuration update + +`vmagent` should be restarted in order to update config options set via command-line args. + +`vmagent` supports multiple approaches for reloading configs from updated config files such as `-promscrape.config`, `-remoteWrite.relabelConfig` and `-remoteWrite.urlRelabelConfig`: + +* Sending `SUGHUP` signal to `vmagent` process: + ```bash + kill -SIGHUP `pidof vmagent` + ``` + +* Sending HTTP request to `http://vmagent:8429/-/reload` endpoint. + +There is also `-promscrape.configCheckInterval` command-line option, which can be used for automatic reloading configs from of updated `-promscrape.config` file. + + ### Use cases