From b96b19f040131512c0b7d6784122d9b2fbeea7a1 Mon Sep 17 00:00:00 2001 From: Roman Khavronenko Date: Sun, 16 May 2021 18:43:09 +0100 Subject: [PATCH] Docs update from victoriaMetrics.github.io (#1302) * port change from https://github.com/VictoriaMetrics/VictoriaMetrics.github.io/pull/9/commits/11ca65677b3fb5d71acbbc99c4651aa0bb1aba43 * port change from https://github.com/VictoriaMetrics/VictoriaMetrics.github.io/pull/8/commits/afb41dfa437a2cc39e6ca04985c8801011de73dc * port change from https://github.com/VictoriaMetrics/VictoriaMetrics.github.io/pull/7/commits/f82e3733c9fad9b01f008f45e1a5a3164c63cf88 * port change from https://github.com/VictoriaMetrics/VictoriaMetrics.github.io/pull/6/commits/d499ab050291361e937beefa56bda55da244da20 --- docs/CaseStudies.md | 2 +- docs/MetricsQL.md | 2 +- docs/vmgateway.md | 4 ++-- docs/vmrestore.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/CaseStudies.md b/docs/CaseStudies.md index 9525af44a..455a836a8 100644 --- a/docs/CaseStudies.md +++ b/docs/CaseStudies.md @@ -227,7 +227,7 @@ as the load balancer for reads. [idealo.de](https://www.idealo.de/) is the leading price comparison website in Germany. We use Prometheus for metrics on our container platform. When we introduced Prometheus at idealo we started with m3db as our longterm storage. In our setup, m3db was quite unstable and consumed a lot of resources. -VictoriaMetrics in poroduction is very stable for us and uses only a fraction of the resources even though we also increased our retention period from 1 month to 13 months. +VictoriaMetrics in production is very stable for us and uses only a fraction of the resources even though we also increased our retention period from 1 month to 13 months. Numbers: diff --git a/docs/MetricsQL.md b/docs/MetricsQL.md index 833720ca3..446cb2a87 100644 --- a/docs/MetricsQL.md +++ b/docs/MetricsQL.md @@ -67,7 +67,7 @@ This functionality can be tried at [an editable Grafana dashboard](http://play-g - `label_del(q, label1, ... labelN)` for deleting the given labels from `q`. For example, `label_del(foo, "bar")` would delete `bar` label from all the `foo` series. - `label_keep(q, label1, ... labelN)` for deleting all the labels except the given labels from `q`. For example, `label_keep(foo, "bar")` would delete all the labels except `bar` from `foo` series. - `label_copy(q, src_label1, dst_label1, ... src_labelN, dst_labelN)` for copying label values from `src_*` to `dst_*`. If `src_label` is empty, then `dst_label` is left untouched. For example, `label_copy(foo, "bar", baz")` would transform `foo{bar="x"}` to `foo{bar="x",baz="x"}`. - - `label_move(q, src_label1, dst_label1, ... src_labelN, dst_labelN)` for moving label values from `src_*` to `dst_*`. If `src_label` is empty, then `dst_label` is left untouched. For example, `label_move(foo, 'bar", "baz")` would transform `foo{bar="x"}` to `foo{bax="x"}`. + - `label_move(q, src_label1, dst_label1, ... src_labelN, dst_labelN)` for moving label values from `src_*` to `dst_*`. If `src_label` is empty, then `dst_label` is left untouched. For example, `label_move(foo, 'bar", "baz")` would transform `foo{bar="x"}` to `foo{baz="x"}`. - `label_transform(q, label, regexp, replacement)` for replacing all the `regexp` occurences with `replacement` in the `label` values from `q`. For example, `label_transform(foo, "bar", "-", "_")` would transform `foo{bar="a-b-c"}` to `foo{bar="a_b_c"}`. - `label_value(q, label)` - returns numeric values for the given `label` from `q`. For example, if `label_value(foo, "bar")` is applied to `foo{bar="1.234"}`, then it will return a time series `foo{bar="1.234"}` with `1.234` value. - `label_match(q, label, regexp)` and `label_mismatch(q, label, regexp)` for filtering time series with labels matching (or not matching) the given regexps. diff --git a/docs/vmgateway.md b/docs/vmgateway.md index ddc677a80..7874bf7ec 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -43,8 +43,8 @@ jwt token must be in following format: } ``` Where: -- `exp` - required, expire time in unix_timestamp. If the token expires then `vmgateway` rejects the request. -- `vm_access` - required, dict with claim info, minimum form: `{"vm_access": {"tenand_id": {}}` +- `exp` - required, token expiration in unix_timestamp. If the token expires then `vmgateway` rejects the request. +- `vm_access` - required, object with claim information, minimum form: `{"vm_access": {"tenand_id": {}}` - `tenant_id` - optional, for cluster mode, routes requests to the corresponding tenant. - `extra_labels` - optional, key-value pairs for label filters added to the ingested or selected metrics. - `mode` - optional, access mode for api - read, write, or full. Supported values: 0 - full (default value), 1 - read, 2 - write. diff --git a/docs/vmrestore.md b/docs/vmrestore.md index 0ce1e92d3..034a2851c 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -21,7 +21,7 @@ vmrestore -src=gcs:/// -storageDataPath=` is [GCS bucket](https://cloud.google.com/storage/docs/creating-buckets) name. -* `` is the path to backup made with [vmbackup](https://docs.victoriametrics.com/vbackup.html) on GCS bucket. +* `` is the path to backup made with [vmbackup](https://docs.victoriametrics.com/vmbackup.html) on GCS bucket. * `` is the path to folder where data will be restored. This folder must be passed to VictoriaMetrics in `-storageDataPath` command-line flag after the restore process is complete.