From 33afaa49d94220ac6f4152732a9cdaea25d36109 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Tue, 7 Jun 2022 14:50:39 +0300 Subject: [PATCH] docs: run `make docs-sync` after fda8da297e14913832fe67512df7351636950c2b --- docs/README.md | 21 ++++++++------- docs/Single-server-VictoriaMetrics.md | 37 +++++++++++++++------------ 2 files changed, 31 insertions(+), 27 deletions(-) diff --git a/docs/README.md b/docs/README.md index a411cc95a3..0800119aa4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -289,7 +289,7 @@ VictoriaMetrics can be used as drop-in replacement for Prometheus for scraping t * [digitalocean_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#digitalocean_sd_config) * [http_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) -If you need to support for other `*_sd_config` types feel free to open a [feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues). +File a [feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues) if you need support for other `*_sd_config` types. The file pointed by `-promscrape.config` may contain `%{ENV_VAR}` placeholders, which are substituted by the corresponding `ENV_VAR` environment variable values. @@ -826,8 +826,8 @@ Optional `start` and `end` args may be added to the request in order to limit th unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/api/v1/export -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/api/v1/export -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` Optional `max_rows_per_line` arg may be added to the request for limiting the maximum number of rows exported per each JSON line. @@ -870,8 +870,8 @@ Optional `start` and `end` args may be added to the request in order to limit th unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/api/v1/export/csv -d 'format=' -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/api/v1/export/csv -d 'format=' -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` The exported CSV data can be imported to VictoriaMetrics via [/api/v1/import/csv](#how-to-import-csv-data). @@ -897,8 +897,8 @@ Optional `start` and `end` args may be added to the request in order to limit th unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/api/v1/export/native -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/api/v1/export/native -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` The exported data can be imported to VictoriaMetrics via [/api/v1/import/native](#how-to-import-data-in-native-format). @@ -1097,11 +1097,10 @@ Optional `start` and `end` args may be added to the request in order to scrape t `start` and `end` may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/federate -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/federate -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` - -By default, the last point on the interval `[now - max_lookback ... now]` is scraped for each time series. The default value for `max_lookback` is `5m` (5 minutes), but it can be overridden. +By default, the last point on the interval `[now - max_lookback ... now]` is scraped for each time series. The default value for `max_lookback` is `5m` (5 minutes), but it can be overridden with `max_lookback` query arg. For instance, `/federate?match[]=up&max_lookback=1h` would return last points on the `[now - 1h ... now]` interval. This may be useful for time series federation with scrape intervals exceeding `5m`. diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 4fc42b05bb..8f0363e17d 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -18,7 +18,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) -and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). +and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Just download VictoriaMetrics and follow [these instructions](https://docs.victoriametrics.com/Quick-Start.html). The cluster version of VictoriaMetrics is available [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). @@ -26,9 +26,9 @@ The cluster version of VictoriaMetrics is available [here](https://docs.victoria Learn more about [key concepts](https://docs.victoriametrics.com/keyConcepts.html) of VictoriaMetrics and follow the [QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for a better experience. -[Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. +[Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://victoriametrics.com/products/enterprise/). -Enterprise binaries can be downloaded and evaluated for free +Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). ## Prominent features @@ -188,7 +188,7 @@ global: ``` This instructs Prometheus to add `datacenter=dc-123` label to each sample before sending it to remote storage. -The label name can be arbitrary - `datacenter` it is just an example. The label value must be unique +The label name can be arbitrary - `datacenter` is just an example. The label value must be unique across Prometheus instances, so time series could be filtered and grouped by this label. For highly loaded Prometheus instances (200k+ samples per second) the following tuning may be applied: @@ -207,14 +207,14 @@ remote_write: Using remote write increases memory usage for Prometheus by up to ~25%. If you are experiencing issues with -too high memory consumption of Prometheus, then try to lower `max_samples_per_send` and `capacity` params. +too high memory consumption of Prometheus, then try to lower `max_samples_per_send` and `capacity` params. Keep in mind that these two params are tightly connected. Read more about tuning remote write for Prometheus [here](https://prometheus.io/docs/practices/remote_write). -It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases) or newer, +It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases) or newer, since previous versions may have issues with `remote_write`. -Take a look also at [vmagent](https://docs.victoriametrics.com/vmagent.html) +Take a look also at [vmagent](https://docs.victoriametrics.com/vmagent.html) and [vmalert](https://docs.victoriametrics.com/vmalert.html), which can be used as faster and less resource-hungry alternative to Prometheus. @@ -293,7 +293,7 @@ VictoriaMetrics can be used as drop-in replacement for Prometheus for scraping t * [digitalocean_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#digitalocean_sd_config) * [http_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) -If you need to support for other `*_sd_config` types feel free to open a [feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues). +File a [feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues) if you need support for other `*_sd_config` types. The file pointed by `-promscrape.config` may contain `%{ENV_VAR}` placeholders, which are substituted by the corresponding `ENV_VAR` environment variable values. @@ -830,8 +830,8 @@ Optional `start` and `end` args may be added to the request in order to limit th unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/api/v1/export -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/api/v1/export -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` Optional `max_rows_per_line` arg may be added to the request for limiting the maximum number of rows exported per each JSON line. @@ -874,8 +874,8 @@ Optional `start` and `end` args may be added to the request in order to limit th unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/api/v1/export/csv -d 'format=' -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/api/v1/export/csv -d 'format=' -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` The exported CSV data can be imported to VictoriaMetrics via [/api/v1/import/csv](#how-to-import-csv-data). @@ -901,8 +901,8 @@ Optional `start` and `end` args may be added to the request in order to limit th unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: ```bash -1. http://:8428/api/v1/export?match[]=&start=1654543486&end=1654543486 -2. http://:8428/api/v1/export?match[]=&start=2022-06-06T19:25:48+00:00&end=2022-06-06T19:29:07+00:00 +curl http://:8428/api/v1/export/native -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/api/v1/export/native -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' ``` The exported data can be imported to VictoriaMetrics via [/api/v1/import/native](#how-to-import-data-in-native-format). @@ -1098,8 +1098,13 @@ VictoriaMetrics exports [Prometheus-compatible federation data](https://promethe at `http://:8428/federate?match[]=`. Optional `start` and `end` args may be added to the request in order to scrape the last point for each selected time series on the `[start ... end]` interval. -`start` and `end` may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. By default, the last point -on the interval `[now - max_lookback ... now]` is scraped for each time series. The default value for `max_lookback` is `5m` (5 minutes), but it can be overridden. +`start` and `end` may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. +For example: +```bash +curl http://:8428/federate -d 'match[]=' -d 'start=1654543486' -d 'end=1654543486' +curl http://:8428/federate -d 'match[]=' -d 'start=2022-06-06T19:25:48+00:00' -d 'end=2022-06-06T19:29:07+00:00' +``` +By default, the last point on the interval `[now - max_lookback ... now]` is scraped for each time series. The default value for `max_lookback` is `5m` (5 minutes), but it can be overridden with `max_lookback` query arg. For instance, `/federate?match[]=up&max_lookback=1h` would return last points on the `[now - 1h ... now]` interval. This may be useful for time series federation with scrape intervals exceeding `5m`.