From 754db0d22ec9dcdddce297e2b9290dabb7370c04 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 4 Mar 2020 18:14:47 +0200 Subject: [PATCH] app/vmagent/README.md: small fixes --- app/vmagent/README.md | 6 +++--- docs/vmagent.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/app/vmagent/README.md b/app/vmagent/README.md index b3cf67bfb..10ef9116a 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -77,7 +77,7 @@ See [the corresponding Makefile rules](https://github.com/VictoriaMetrics/Victor #### Drop-in replacement for Prometheus If you use Prometheus only for scraping metrics from various targets and forwarding these metrics to remote storage, -then `vmagent` can replace such Prometheus setup. Usually `vmagent` requires lower amounts RAM, CPU and network bandwidth comparing to Prometheus for such setup. +then `vmagent` can replace such Prometheus setup. Usually `vmagent` requires lower amounts of RAM, CPU and network bandwidth comparing to Prometheus for such setup. See [these docs](#how-to-collect-metrics-in-prometheus-format) for details. @@ -184,8 +184,8 @@ either via `vmagent` itself or via Prometheus, so the exported metrics could be and `vmagent_remotewrite_pending_data_bytes` metric exported by `vmagent` at `/metrics` page constantly grows. * `vmagent` buffers scraped data at `-remoteWrite.tmpDataPath` directory until it is sent to `-remoteWrite.url`. - The directory can grow big when remote storage is unvailable during extended periods of time. If you don't want - sending all the data from the directory to remote storage, just stop `vmagent` and delete the directory. + The directory can grow big when remote storage is unvailable during extended periods of time and if `-remoteWrite.maxDiskUsagePerURL` isn't set. + If you don't want sending all the data from the directory to remote storage, just stop `vmagent` and delete the directory. ### How to build from sources diff --git a/docs/vmagent.md b/docs/vmagent.md index ae8ee6284..10ef9116a 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -68,7 +68,7 @@ Pass `-help` to `vmagent` in order to see the full list of supported command-lin `vmagent` can run and collect metrics in IoT and industrial networks with unreliable or scheduled connections to the remote storage. It buffers the collected data in local files until the connection to remote storage becomes available and then sends the buffered data to the remote storage. It re-tries sending the data to remote storage on any errors. -The maximum buffer size can be limited with `-remoteWrite.maxDiskUsagePerURL'. +The maximum buffer size can be limited with `-remoteWrite.maxDiskUsagePerURL`. `vmagent` works on various architectures from IoT world - 32-bit arm, 64-bit arm, ppc64, 386, amd64. See [the corresponding Makefile rules](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmagent/Makefile) for details. @@ -77,7 +77,7 @@ See [the corresponding Makefile rules](https://github.com/VictoriaMetrics/Victor #### Drop-in replacement for Prometheus If you use Prometheus only for scraping metrics from various targets and forwarding these metrics to remote storage, -then `vmagent` can replace such Prometheus setup. Usually `vmagent` requires lower amounts RAM, CPU and network bandwidth comparing to Prometheus for such setup. +then `vmagent` can replace such Prometheus setup. Usually `vmagent` requires lower amounts of RAM, CPU and network bandwidth comparing to Prometheus for such setup. See [these docs](#how-to-collect-metrics-in-prometheus-format) for details. @@ -184,8 +184,8 @@ either via `vmagent` itself or via Prometheus, so the exported metrics could be and `vmagent_remotewrite_pending_data_bytes` metric exported by `vmagent` at `/metrics` page constantly grows. * `vmagent` buffers scraped data at `-remoteWrite.tmpDataPath` directory until it is sent to `-remoteWrite.url`. - The directory can grow big when remote storage is unvailable during extended periods of time. If you don't want - sending all the data from the directory to remote storage, just stop `vmagent` and delete the directory. + The directory can grow big when remote storage is unvailable during extended periods of time and if `-remoteWrite.maxDiskUsagePerURL` isn't set. + If you don't want sending all the data from the directory to remote storage, just stop `vmagent` and delete the directory. ### How to build from sources