From 954a7a6fc6dd0dab3dcb296483a7310773e95a0a Mon Sep 17 00:00:00 2001 From: Artem Navoiev Date: Sun, 19 Jun 2022 22:57:53 +0300 Subject: [PATCH] docs: replace bash code block type with console (#2746) --- docs/CHANGELOG.md | 2 +- docs/Cluster-VictoriaMetrics.md | 6 +- docs/Quick-Start.md | 4 +- docs/README.md | 72 ++++++++-------- docs/Single-server-VictoriaMetrics.md | 72 ++++++++-------- .../getting-started-with-vm-operator.md | 40 ++++----- .../k8s-ha-monitoring-via-vm-cluster.md | 30 +++---- docs/guides/k8s-monitoring-via-vm-cluster.md | 22 ++--- docs/guides/k8s-monitoring-via-vm-single.md | 22 ++--- docs/guides/migrate-from-influx.md | 4 +- .../multi-regional-setup-dedicated-regions.md | 2 +- docs/keyConcepts.md | 6 +- docs/operator/VictoriaMetrics-Operator.md | 6 +- docs/operator/high-availability.MD | 4 +- docs/operator/quick-start.MD | 54 ++++++------ docs/url-examples.md | 82 +++++++++---------- docs/vmagent.md | 14 ++-- docs/vmalert.md | 6 +- docs/vmauth.md | 12 +-- docs/vmbackup.md | 18 ++-- docs/vmctl.md | 6 +- docs/vmgateway.md | 10 +-- docs/vmrestore.md | 10 +-- 23 files changed, 252 insertions(+), 252 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 25dd3cedc..0696396ab 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1006,7 +1006,7 @@ Released at 26-11-2020 * FEATURE: added [Snap package for single-node VictoriaMetrics](https://snapcraft.io/victoriametrics). This simplifies installation under Ubuntu to a single command: - ```bash + ```console snap install victoriametrics ``` diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 3764a5de3..15ed5efba 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -115,7 +115,7 @@ By default images are built on top of [alpine](https://hub.docker.com/_/scratch) It is possible to build an image on top of any other base image by setting it via `` environment variable. For example, the following command builds images on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package ``` @@ -448,7 +448,7 @@ Example command for collecting cpu profile from `vmstorage` (replace `0.0.0.0` w
-```bash +```console curl http://0.0.0.0:8482/debug/pprof/profile > cpu.pprof ``` @@ -458,7 +458,7 @@ Example command for collecting memory profile from `vminsert` (replace `0.0.0.0`
-```bash +```console curl http://0.0.0.0:8480/debug/pprof/heap > mem.pprof ``` diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index 3ac8cf712..5ee27eac3 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -40,7 +40,7 @@ under the current directory:
-```bash +```console docker pull victoriametrics/victoria-metrics:latest docker run -it --rm -v `pwd`/victoria-metrics-data:/victoria-metrics-data -p 8428:8428 victoriametrics/victoria-metrics:latest ``` @@ -63,7 +63,7 @@ file.
-```bash +```console git clone https://github.com/VictoriaMetrics/VictoriaMetrics --branch cluster && cd VictoriaMetrics/deployment/docker && docker-compose up diff --git a/docs/README.md b/docs/README.md index c29be2f99..7ef7e15d7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -164,7 +164,7 @@ Then apply new config via the following command:
-```bash +```console kill -HUP `pidof prometheus` ``` @@ -328,7 +328,7 @@ VictoriaMetrics doesn't check `DD_API_KEY` param, so it can be set to arbitrary Example on how to send data to VictoriaMetrics via DataDog "submit metrics" API from command line: -```bash +```console echo ' { "series": [ @@ -354,7 +354,7 @@ The imported data can be read via [export API](https://docs.victoriametrics.com/
-```bash +```console curl http://localhost:8428/api/v1/export -d 'match[]=system.load.1' ``` @@ -418,7 +418,7 @@ to local VictoriaMetrics using `curl`:
-```bash +```console curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://localhost:8428/write' ``` @@ -429,7 +429,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match={__name__=~"measurement_.*"}' ``` @@ -457,7 +457,7 @@ Comma-separated list of expected databases can be passed to VictoriaMetrics via Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` command line flag. For instance, the following command will enable Graphite receiver in VictoriaMetrics on TCP and UDP port `2003`: -```bash +```console /path/to/victoria-metrics-prod -graphiteListenAddr=:2003 ``` @@ -466,7 +466,7 @@ to the VictoriaMetrics host in `StatsD` configs. Example for writing data with Graphite plaintext protocol to local VictoriaMetrics using `nc`: -```bash +```console echo "foo.bar.baz;tag1=value1;tag2=value2 123 `date +%s`" | nc -N localhost 2003 ``` @@ -476,7 +476,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match=foo.bar.baz' ``` @@ -518,7 +518,7 @@ The same protocol is used for [ingesting data in KairosDB](https://kairosdb.gith Enable OpenTSDB receiver in VictoriaMetrics by setting `-opentsdbListenAddr` command line flag. For instance, the following command enables OpenTSDB receiver in VictoriaMetrics on TCP and UDP port `4242`: -```bash +```console /path/to/victoria-metrics-prod -opentsdbListenAddr=:4242 ``` @@ -528,7 +528,7 @@ Example for writing data with OpenTSDB protocol to local VictoriaMetrics using `
-```bash +```console echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2" | nc -N localhost 4242 ``` @@ -539,7 +539,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match=foo.bar.baz' ``` @@ -556,7 +556,7 @@ The `/api/v1/export` endpoint should return the following response: Enable HTTP server for OpenTSDB `/api/put` requests by setting `-opentsdbHTTPListenAddr` command line flag. For instance, the following command enables OpenTSDB HTTP server on port `4242`: -```bash +```console /path/to/victoria-metrics-prod -opentsdbHTTPListenAddr=:4242 ``` @@ -566,7 +566,7 @@ Example for writing a single data point:
-```bash +```console curl -H 'Content-Type: application/json' -d '{"metric":"x.y.z","value":45.34,"tags":{"t1":"v1","t2":"v2"}}' http://localhost:4242/api/put ``` @@ -576,7 +576,7 @@ Example for writing multiple data points in a single request:
-```bash +```console curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' http://localhost:4242/api/put ``` @@ -586,7 +586,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match[]=x.y.z' -d 'match[]=foo' -d 'match[]=bar' ``` @@ -756,7 +756,7 @@ The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is pos by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-victoria-metrics ``` @@ -870,7 +870,7 @@ Each JSON line contains samples for a single time series. An example output: Optional `start` and `end` args may be added to the request in order to limit the time frame for the exported data. These args may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: -```bash +```console 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' ``` @@ -884,7 +884,7 @@ of time series data. This enables gzip compression for the exported data. Exampl
-```bash +```console curl -H 'Accept-Encoding: gzip' http://localhost:8428/api/v1/export -d 'match[]={__name__!=""}' > data.jsonl.gz ``` @@ -918,7 +918,7 @@ for metrics to export. Optional `start` and `end` args may be added to the request in order to limit the time frame for the exported data. These args may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: -```bash +```console 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' ``` @@ -935,7 +935,7 @@ for metrics to export. Use `{__name__=~".*"}` selector for fetching all the time On large databases you may experience problems with limit on the number of time series, which can be exported. In this case you need to adjust `-search.maxExportSeries` command-line flag: -```bash +```console # count unique timeseries in database wget -O- -q 'http://your_victoriametrics_instance:8428/api/v1/series/count' | jq '.data[0]' @@ -945,7 +945,7 @@ wget -O- -q 'http://your_victoriametrics_instance:8428/api/v1/series/count' | jq Optional `start` and `end` args may be added to the request in order to limit the time frame for the exported data. These args may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: -```bash +```console 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' ``` @@ -977,7 +977,7 @@ Time series data can be imported into VictoriaMetrics via any supported data ing Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format): -```bash +```console # Export the data from : curl http://source-victoriametrics:8428/api/v1/export -d 'match={__name__!=""}' > exported_data.jsonl @@ -987,7 +987,7 @@ curl -X POST http://destination-victoriametrics:8428/api/v1/import -T exported_d Pass `Content-Encoding: gzip` HTTP request header to `/api/v1/import` for importing gzipped data: -```bash +```console # Export gzipped data from : curl -H 'Accept-Encoding: gzip' http://source-victoriametrics:8428/api/v1/export -d 'match={__name__!=""}' > exported_data.jsonl.gz @@ -1008,7 +1008,7 @@ The specification of VictoriaMetrics' native format may yet change and is not fo If you have a native format file obtained via [/api/v1/export/native](#how-to-export-data-in-native-format) however this is the most efficient protocol for importing data in. -```bash +```console # Export the data from : curl http://source-victoriametrics:8428/api/v1/export/native -d 'match={__name__!=""}' > exported_data.bin @@ -1049,14 +1049,14 @@ Each request to `/api/v1/import/csv` may contain arbitrary number of CSV lines. Example for importing CSV data via `/api/v1/import/csv`: -```bash +```console curl -d "GOOG,1.23,4.56,NYSE" 'http://localhost:8428/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' curl -d "MSFT,3.21,1.67,NASDAQ" 'http://localhost:8428/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' ``` After that the data may be read via [/api/v1/export](#how-to-export-data-in-json-line-format) endpoint: -```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match[]={ticker!=""}' ``` @@ -1082,7 +1082,7 @@ via `/api/v1/import/prometheus` path. For example, the following line imports a
-```bash +```console curl -d 'foo{bar="baz"} 123' -X POST 'http://localhost:8428/api/v1/import/prometheus' ``` @@ -1092,7 +1092,7 @@ The following command may be used for verifying the imported data:
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match={__name__=~"foo"}' ``` @@ -1108,7 +1108,7 @@ Pass `Content-Encoding: gzip` HTTP request header to `/api/v1/import/prometheus`
-```bash +```console # Import gzipped data to : curl -X POST -H 'Content-Encoding: gzip' http://destination-victoriametrics:8428/api/v1/import/prometheus -T prometheus_data.gz ``` @@ -1159,7 +1159,7 @@ at `http://:8428/federate?match[]=: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' ``` @@ -1213,7 +1213,7 @@ See also [cardinality limiter](#cardinality-limiter) and [capacity planning docs * Install multiple VictoriaMetrics instances in distinct datacenters (availability zones). * Pass addresses of these instances to [vmagent](https://docs.victoriametrics.com/vmagent.html) via `-remoteWrite.url` command-line flag: -```bash +```console /path/to/vmagent -remoteWrite.url=http://:8428/api/v1/write -remoteWrite.url=http://:8428/api/v1/write ``` @@ -1232,7 +1232,7 @@ remote_write: * Apply the updated config: -```bash +```console kill -HUP `pidof prometheus` ``` @@ -1413,7 +1413,7 @@ For example, substitute `-graphiteListenAddr=:2003` with `-graphiteListenAddr= -```bash +```console curl http://0.0.0.0:8428/debug/pprof/heap > mem.pprof ``` @@ -1745,7 +1745,7 @@ curl http://0.0.0.0:8428/debug/pprof/heap > mem.pprof
-```bash +```console curl http://0.0.0.0:8428/debug/pprof/profile > cpu.pprof ``` diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 01603a3a2..dde38f0f1 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -168,7 +168,7 @@ Then apply new config via the following command:
-```bash +```console kill -HUP `pidof prometheus` ``` @@ -332,7 +332,7 @@ VictoriaMetrics doesn't check `DD_API_KEY` param, so it can be set to arbitrary Example on how to send data to VictoriaMetrics via DataDog "submit metrics" API from command line: -```bash +```console echo ' { "series": [ @@ -358,7 +358,7 @@ The imported data can be read via [export API](https://docs.victoriametrics.com/
-```bash +```console curl http://localhost:8428/api/v1/export -d 'match[]=system.load.1' ``` @@ -422,7 +422,7 @@ to local VictoriaMetrics using `curl`:
-```bash +```console curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://localhost:8428/write' ``` @@ -433,7 +433,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match={__name__=~"measurement_.*"}' ``` @@ -461,7 +461,7 @@ Comma-separated list of expected databases can be passed to VictoriaMetrics via Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` command line flag. For instance, the following command will enable Graphite receiver in VictoriaMetrics on TCP and UDP port `2003`: -```bash +```console /path/to/victoria-metrics-prod -graphiteListenAddr=:2003 ``` @@ -470,7 +470,7 @@ to the VictoriaMetrics host in `StatsD` configs. Example for writing data with Graphite plaintext protocol to local VictoriaMetrics using `nc`: -```bash +```console echo "foo.bar.baz;tag1=value1;tag2=value2 123 `date +%s`" | nc -N localhost 2003 ``` @@ -480,7 +480,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match=foo.bar.baz' ``` @@ -522,7 +522,7 @@ The same protocol is used for [ingesting data in KairosDB](https://kairosdb.gith Enable OpenTSDB receiver in VictoriaMetrics by setting `-opentsdbListenAddr` command line flag. For instance, the following command enables OpenTSDB receiver in VictoriaMetrics on TCP and UDP port `4242`: -```bash +```console /path/to/victoria-metrics-prod -opentsdbListenAddr=:4242 ``` @@ -532,7 +532,7 @@ Example for writing data with OpenTSDB protocol to local VictoriaMetrics using `
-```bash +```console echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2" | nc -N localhost 4242 ``` @@ -543,7 +543,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match=foo.bar.baz' ``` @@ -560,7 +560,7 @@ The `/api/v1/export` endpoint should return the following response: Enable HTTP server for OpenTSDB `/api/put` requests by setting `-opentsdbHTTPListenAddr` command line flag. For instance, the following command enables OpenTSDB HTTP server on port `4242`: -```bash +```console /path/to/victoria-metrics-prod -opentsdbHTTPListenAddr=:4242 ``` @@ -570,7 +570,7 @@ Example for writing a single data point:
-```bash +```console curl -H 'Content-Type: application/json' -d '{"metric":"x.y.z","value":45.34,"tags":{"t1":"v1","t2":"v2"}}' http://localhost:4242/api/put ``` @@ -580,7 +580,7 @@ Example for writing multiple data points in a single request:
-```bash +```console curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' http://localhost:4242/api/put ``` @@ -590,7 +590,7 @@ After that the data may be read via [/api/v1/export](#how-to-export-data-in-json
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match[]=x.y.z' -d 'match[]=foo' -d 'match[]=bar' ``` @@ -760,7 +760,7 @@ The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is pos by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-victoria-metrics ``` @@ -874,7 +874,7 @@ Each JSON line contains samples for a single time series. An example output: Optional `start` and `end` args may be added to the request in order to limit the time frame for the exported data. These args may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: -```bash +```console 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' ``` @@ -888,7 +888,7 @@ of time series data. This enables gzip compression for the exported data. Exampl
-```bash +```console curl -H 'Accept-Encoding: gzip' http://localhost:8428/api/v1/export -d 'match[]={__name__!=""}' > data.jsonl.gz ``` @@ -922,7 +922,7 @@ for metrics to export. Optional `start` and `end` args may be added to the request in order to limit the time frame for the exported data. These args may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: -```bash +```console 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' ``` @@ -939,7 +939,7 @@ for metrics to export. Use `{__name__=~".*"}` selector for fetching all the time On large databases you may experience problems with limit on the number of time series, which can be exported. In this case you need to adjust `-search.maxExportSeries` command-line flag: -```bash +```console # count unique timeseries in database wget -O- -q 'http://your_victoriametrics_instance:8428/api/v1/series/count' | jq '.data[0]' @@ -949,7 +949,7 @@ wget -O- -q 'http://your_victoriametrics_instance:8428/api/v1/series/count' | jq Optional `start` and `end` args may be added to the request in order to limit the time frame for the exported data. These args may contain either unix timestamp in seconds or [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) values. For example: -```bash +```console 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' ``` @@ -981,7 +981,7 @@ Time series data can be imported into VictoriaMetrics via any supported data ing Example for importing data obtained via [/api/v1/export](#how-to-export-data-in-json-line-format): -```bash +```console # Export the data from : curl http://source-victoriametrics:8428/api/v1/export -d 'match={__name__!=""}' > exported_data.jsonl @@ -991,7 +991,7 @@ curl -X POST http://destination-victoriametrics:8428/api/v1/import -T exported_d Pass `Content-Encoding: gzip` HTTP request header to `/api/v1/import` for importing gzipped data: -```bash +```console # Export gzipped data from : curl -H 'Accept-Encoding: gzip' http://source-victoriametrics:8428/api/v1/export -d 'match={__name__!=""}' > exported_data.jsonl.gz @@ -1012,7 +1012,7 @@ The specification of VictoriaMetrics' native format may yet change and is not fo If you have a native format file obtained via [/api/v1/export/native](#how-to-export-data-in-native-format) however this is the most efficient protocol for importing data in. -```bash +```console # Export the data from : curl http://source-victoriametrics:8428/api/v1/export/native -d 'match={__name__!=""}' > exported_data.bin @@ -1053,14 +1053,14 @@ Each request to `/api/v1/import/csv` may contain arbitrary number of CSV lines. Example for importing CSV data via `/api/v1/import/csv`: -```bash +```console curl -d "GOOG,1.23,4.56,NYSE" 'http://localhost:8428/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' curl -d "MSFT,3.21,1.67,NASDAQ" 'http://localhost:8428/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' ``` After that the data may be read via [/api/v1/export](#how-to-export-data-in-json-line-format) endpoint: -```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match[]={ticker!=""}' ``` @@ -1086,7 +1086,7 @@ via `/api/v1/import/prometheus` path. For example, the following line imports a
-```bash +```console curl -d 'foo{bar="baz"} 123' -X POST 'http://localhost:8428/api/v1/import/prometheus' ``` @@ -1096,7 +1096,7 @@ The following command may be used for verifying the imported data:
-```bash +```console curl -G 'http://localhost:8428/api/v1/export' -d 'match={__name__=~"foo"}' ``` @@ -1112,7 +1112,7 @@ Pass `Content-Encoding: gzip` HTTP request header to `/api/v1/import/prometheus`
-```bash +```console # Import gzipped data to : curl -X POST -H 'Content-Encoding: gzip' http://destination-victoriametrics:8428/api/v1/import/prometheus -T prometheus_data.gz ``` @@ -1163,7 +1163,7 @@ at `http://:8428/federate?match[]=: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' ``` @@ -1217,7 +1217,7 @@ See also [cardinality limiter](#cardinality-limiter) and [capacity planning docs * Install multiple VictoriaMetrics instances in distinct datacenters (availability zones). * Pass addresses of these instances to [vmagent](https://docs.victoriametrics.com/vmagent.html) via `-remoteWrite.url` command-line flag: -```bash +```console /path/to/vmagent -remoteWrite.url=http://:8428/api/v1/write -remoteWrite.url=http://:8428/api/v1/write ``` @@ -1236,7 +1236,7 @@ remote_write: * Apply the updated config: -```bash +```console kill -HUP `pidof prometheus` ``` @@ -1417,7 +1417,7 @@ For example, substitute `-graphiteListenAddr=:2003` with `-graphiteListenAddr= -```bash +```console curl http://0.0.0.0:8428/debug/pprof/heap > mem.pprof ``` @@ -1749,7 +1749,7 @@ curl http://0.0.0.0:8428/debug/pprof/heap > mem.pprof
-```bash +```console curl http://0.0.0.0:8428/debug/pprof/profile > cpu.pprof ``` diff --git a/docs/guides/getting-started-with-vm-operator.md b/docs/guides/getting-started-with-vm-operator.md index 432cd961b..131203ad4 100644 --- a/docs/guides/getting-started-with-vm-operator.md +++ b/docs/guides/getting-started-with-vm-operator.md @@ -22,7 +22,7 @@ See how to work with a [VictoriaMetrics Helm repository in previous guide](https
-```bash +```console helm install operator vm/victoria-metrics-operator ``` @@ -30,7 +30,7 @@ helm install operator vm/victoria-metrics-operator The expected output is: -```bash +```console NAME: vmoperator LAST DEPLOYED: Thu Sep 30 17:30:30 2021 NAMESPACE: default @@ -49,13 +49,13 @@ Run the following command to check that VM Operator is up and running:
-```bash +```console kubectl --namespace default get pods -l "app.kubernetes.io/instance=vmoperator" ```
The expected output: -```bash +```console NAME READY STATUS RESTARTS AGE vmoperator-victoria-metrics-operator-67cff44cd6-s47n6 1/1 Running 0 77s ``` @@ -68,7 +68,7 @@ Run the following command to install [VictoriaMetrics Cluster](https://docs.vict
-```bash +```console cat << EOF | kubectl apply -f - apiVersion: operator.victoriametrics.com/v1beta1 kind: VMCluster @@ -89,7 +89,7 @@ EOF The expected output: -```bash +```console vmcluster.operator.victoriametrics.com/example-vmcluster-persistent created ``` @@ -100,13 +100,13 @@ vmcluster.operator.victoriametrics.com/example-vmcluster-persistent created Please note that it may take some time for the pods to start. To check that the pods are started, run the following command:
-```bash +```console kubectl get pods | grep vmcluster ```
The expected output: -```bash +```console NAME READY STATUS RESTARTS AGE vminsert-example-vmcluster-persistent-845849cb84-9vb6f 1/1 Running 0 5m15s vminsert-example-vmcluster-persistent-845849cb84-r7mmk 1/1 Running 0 5m15s @@ -119,13 +119,13 @@ vmstorage-example-vmcluster-persistent-1 1/1 Running 0 There is an extra command to get information about the cluster state:
-```bash +```console kubectl get vmclusters ```
The expected output: -```bash +```console NAME INSERT COUNT STORAGE COUNT SELECT COUNT AGE STATUS example-vmcluster-persistent 2 2 2 5m53s operational ``` @@ -136,14 +136,14 @@ To get the name of `vminsert` services, please run the following command:
-```bash +```console kubectl get svc | grep vminsert ```
The expected output: -```bash +```console vminsert-example-vmcluster-persistent ClusterIP 10.107.47.136 8480/TCP 5m58s ``` @@ -153,7 +153,7 @@ Here is an example of the full configuration that we need to apply:
-```bash +```console cat < -```bash +```console kubectl get pods | grep vmagent ```
The expected output is: -```bash +```console vmagent-example-vmagent-7996844b5f-b5rzs 2/2 Running 0 9s ``` @@ -207,13 +207,13 @@ Run the following command to make `VMAgent`'s port accessible from the local mac
-```bash +```console kubectl port-forward svc/vmagent-example-vmagent 8429:8429 ``` The expected output is: -```bash +```console Forwarding from 127.0.0.1:8429 -> 8429 Forwarding from [::1]:8429 -> 8429 ``` @@ -235,14 +235,14 @@ To get the new service name, please run the following command:
-```bash +```console kubectl get svc | grep vmselect ```
The expected output: -```bash +```console vmselect-example-vmcluster-persistent ClusterIP None 8481/TCP 7m ``` diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster.md b/docs/guides/k8s-ha-monitoring-via-vm-cluster.md index 28d7da409..9d1f98a67 100644 --- a/docs/guides/k8s-ha-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-ha-monitoring-via-vm-cluster.md @@ -65,7 +65,7 @@ EOF The expected result of the command execution is the following: -```bash +```console NAME: vmcluster LAST DEPLOYED: Thu Jul 29 13:33:51 2021 NAMESPACE: default @@ -121,14 +121,14 @@ Verify that the VictoriaMetrics cluster pods are up and running by executing the
-```bash +```console kubectl get pods | grep vmcluster ```
The expected output is: -```bash +```console vmcluster-victoria-metrics-cluster-vminsert-78b84d8cd9-4mh9d 1/1 Running 0 2m28s vmcluster-victoria-metrics-cluster-vminsert-78b84d8cd9-4ppl7 1/1 Running 0 2m28s vmcluster-victoria-metrics-cluster-vminsert-78b84d8cd9-782qk 1/1 Running 0 2m28s @@ -241,7 +241,7 @@ Verify that `vmagent`'s pod is up and running by executing the following command
-```bash +```console kubectl get pods | grep vmagent ```
@@ -249,7 +249,7 @@ kubectl get pods | grep vmagent The expected output is: -```bash +```console vmagent-victoria-metrics-agent-57ddbdc55d-h4ljb 1/1 Running 0 13s ``` @@ -258,14 +258,14 @@ vmagent-victoria-metrics-agent-57ddbdc55d-h4ljb 1/1 Running Run the following command to check that VictoriaMetrics services are up and running:
-```bash +```console kubectl get pods | grep victoria-metrics ```
The expected output is: -```bash +```console vmagent-victoria-metrics-agent-57ddbdc55d-h4ljb 1/1 Running 0 75s vmcluster-victoria-metrics-cluster-vminsert-78b84d8cd9-s8v7x 1/1 Running 0 89s vmcluster-victoria-metrics-cluster-vminsert-78b84d8cd9-xlm9d 1/1 Running 0 89s @@ -283,14 +283,14 @@ To verify that metrics are present in the VictoriaMetrics send a curl request to Run the following command to see the list of services:
-```bash +```console k get svc | grep vmselect ```
The expected output: -```bash +```console vmcluster-victoria-metrics-cluster-vmselect ClusterIP 10.88.2.69 8481/TCP 1m ``` @@ -298,20 +298,20 @@ Run the following command to make `vmselect`'s port accessable from the local ma
-```bash +```console kubectl port-forward svc/vmcluster-victoria-metrics-cluster-vmselect 8481:8481 ```
Execute the following command to get metrics via `curl`: -```bash +```console curl -sg 'http://127.0.0.1:8481/select/0/prometheus/api/v1/query_range?query=count(up{kubernetes_pod_name=~".*vmselect.*"})&start=-10m&step=1m' | jq ``` The expected output is: -```bash +```console { "status": "success", "isPartial": false, @@ -389,7 +389,7 @@ To test if High Availability works, we need to shutdown one of the `vmstorages`.
-```bash +```console kubectl scale sts vmcluster-victoria-metrics-cluster-vmstorage --replicas=2 ```
@@ -398,13 +398,13 @@ Verify that now we have two running `vmstorages` in the cluster by executing the
-```bash +```console kubectl get pods | grep vmstorage ```
The expected output is: -```bash +```console vmcluster-victoria-metrics-cluster-vmstorage-0 1/1 Running 0 44m vmcluster-victoria-metrics-cluster-vmstorage-1 1/1 Running 0 43m ``` diff --git a/docs/guides/k8s-monitoring-via-vm-cluster.md b/docs/guides/k8s-monitoring-via-vm-cluster.md index 3ff58d63a..6ebf227a5 100644 --- a/docs/guides/k8s-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-monitoring-via-vm-cluster.md @@ -28,7 +28,7 @@ You need to add the VictoriaMetrics Helm repository to install VictoriaMetrics c
-```bash +```console helm repo add vm https://victoriametrics.github.io/helm-charts/ ``` @@ -38,7 +38,7 @@ Update Helm repositories:
-```bash +```console helm repo update ``` @@ -48,7 +48,7 @@ To verify that everything is set up correctly you may run this command:
-```bash +```console helm search repo vm/ ``` @@ -56,7 +56,7 @@ helm search repo vm/ The expected output is: -```bash +```console NAME CHART VERSION APP VERSION DESCRIPTION vm/victoria-metrics-agent 0.7.20 v1.62.0 Victoria Metrics Agent - collects metrics from ... vm/victoria-metrics-alert 0.3.34 v1.62.0 Victoria Metrics Alert - executes a list of giv... @@ -100,7 +100,7 @@ EOF As a result of this command you will see the following output: -```bash +```console NAME: vmcluster LAST DEPLOYED: Thu Jul 1 09:41:57 2021 NAMESPACE: default @@ -159,14 +159,14 @@ Verify that [VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-V
-```bash +```console kubectl get pods ```
The expected output is: -```bash +```console NAME READY STATUS RESTARTS AGE vmcluster-victoria-metrics-cluster-vminsert-689cbc8f55-95szg 1/1 Running 0 16m vmcluster-victoria-metrics-cluster-vminsert-689cbc8f55-f852l 1/1 Running 0 16m @@ -422,14 +422,14 @@ Verify that `vmagent`'s pod is up and running by executing the following command
-```bash +```console kubectl get pods | grep vmagent ```
The expected output is: -```bash +```console vmagent-victoria-metrics-agent-69974b95b4-mhjph 1/1 Running 0 11m ``` @@ -440,7 +440,7 @@ Add the Grafana Helm repository.
-```bash +```console helm repo add grafana https://grafana.github.io/helm-charts helm repo update ``` @@ -512,7 +512,7 @@ The second and the third will forward Grafana to `127.0.0.1:3000`:
-```bash +```console kubectl get secret --namespace default my-grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=grafana,app.kubernetes.io/instance=my-grafana" -o jsonpath="{.items[0].metadata.name}") diff --git a/docs/guides/k8s-monitoring-via-vm-single.md b/docs/guides/k8s-monitoring-via-vm-single.md index 973df57ee..eaab671ab 100644 --- a/docs/guides/k8s-monitoring-via-vm-single.md +++ b/docs/guides/k8s-monitoring-via-vm-single.md @@ -28,7 +28,7 @@ You need to add the VictoriaMetrics Helm repository to install VictoriaMetrics c
-```bash +```console helm repo add vm https://victoriametrics.github.io/helm-charts/ ``` @@ -38,7 +38,7 @@ Update Helm repositories:
-```bash +```console helm repo update ``` @@ -48,7 +48,7 @@ To verify that everything is set up correctly you may run this command:
-```bash +```console helm search repo vm/ ``` @@ -56,7 +56,7 @@ helm search repo vm/ The expected output is: -```bash +```console NAME CHART VERSION APP VERSION DESCRIPTION vm/victoria-metrics-agent 0.7.20 v1.62.0 Victoria Metrics Agent - collects metrics from ... vm/victoria-metrics-alert 0.3.34 v1.62.0 Victoria Metrics Alert - executes a list of giv... @@ -74,7 +74,7 @@ Run this command in your terminal:
.html -```bash +```console helm install vmsingle vm/victoria-metrics-single -f https://docs.victoriametrics.com/guides/guide-vmsingle-values.yaml ``` @@ -175,7 +175,7 @@ server: As a result of the command you will see the following output: -```bash +```console NAME: victoria-metrics LAST DEPLOYED: Fri Jun 25 12:06:13 2021 NAMESPACE: default @@ -219,7 +219,7 @@ Verify that VictoriaMetrics pod is up and running by executing the following com
-```bash +```console kubectl get pods ``` @@ -227,7 +227,7 @@ kubectl get pods The expected output is: -```bash +```console NAME READY STATUS RESTARTS AGE vmsingle-victoria-metrics-single-server-0 1/1 Running 0 68s ``` @@ -239,7 +239,7 @@ Add the Grafana Helm repository.
-```bash +```console helm repo add grafana https://grafana.github.io/helm-charts helm repo update ``` @@ -305,7 +305,7 @@ To see the password for Grafana `admin` user use the following command:
-```bash +```console kubectl get secret --namespace default my-grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo ``` @@ -315,7 +315,7 @@ Expose Grafana service on `127.0.0.1:3000`:
-```bash +```console export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=grafana,app.kubernetes.io/instance=my-grafana" -o jsonpath="{.items[0].metadata.name}") kubectl --namespace default port-forward $POD_NAME 3000 diff --git a/docs/guides/migrate-from-influx.md b/docs/guides/migrate-from-influx.md index 5487be42f..a4965f91f 100644 --- a/docs/guides/migrate-from-influx.md +++ b/docs/guides/migrate-from-influx.md @@ -72,7 +72,7 @@ supports [InfluxDB line protocol](https://docs.victoriametrics.com/#how-to-send- for data ingestion. For example, to write a measurement to VictoriaMetrics we need to send an HTTP POST request with payload in a line protocol format: -```bash +```console curl -d 'census,location=klamath,scientist=anderson bees=23 1566079200000' -X POST 'http://:8428/write' ``` @@ -83,7 +83,7 @@ Please note, an arbitrary number of lines delimited by `\n` (aka newline char) c To get the written data back let's export all series matching the `location="klamath"` filter: -```bash +```console curl -G 'http://:8428/api/v1/export' -d 'match={location="klamath"}' ``` diff --git a/docs/guides/multi-regional-setup-dedicated-regions.md b/docs/guides/multi-regional-setup-dedicated-regions.md index 95a601251..cac726e1e 100644 --- a/docs/guides/multi-regional-setup-dedicated-regions.md +++ b/docs/guides/multi-regional-setup-dedicated-regions.md @@ -28,7 +28,7 @@ Using this schema, you can achieve: * You need to pass two `-remoteWrite.url` command-line options to `vmagent`: -```bash +```console /path/to/vmagent-prod \ -remoteWrite.url= \ -remoteWrite.url= diff --git a/docs/keyConcepts.md b/docs/keyConcepts.md index 11ffef800..6d893228b 100644 --- a/docs/keyConcepts.md +++ b/docs/keyConcepts.md @@ -295,7 +295,7 @@ for [InfluxDB line protocol](https://docs.victoriametrics.com/Single-server-Vict Creating custom clients or instrumenting the application for metrics writing is as easy as sending a POST request: -```bash +```console curl -d '{"metric":{"__name__":"foo","job":"node_exporter"},"values":[0,1,2],"timestamps":[1549891472010,1549891487724,1549891503438]}' -X POST 'http://localhost:8428/api/v1/import' ``` @@ -441,7 +441,7 @@ plot this data sample on the system of coordinates, it will have the following f To get the value of `foo_bar` metric at some specific moment of time, for example `2022-05-10 10:03:00`, in VictoriaMetrics we need to issue an **instant query**: -```bash +```console curl "http:///api/v1/query?query=foo_bar&time=2022-05-10T10:03:00.000Z" ``` @@ -504,7 +504,7 @@ step - step in seconds for evaluating query expression on the time range. If omi To get the values of `foo_bar` on time range from `2022-05-10 09:59:00` to `2022-05-10 10:17:00`, in VictoriaMetrics we need to issue a range query: -```bash +```console curl "http:///api/v1/query_range?query=foo_bar&step=1m&start=2022-05-10T09:59:00.000Z&end=2022-05-10T10:17:00.000Z" ``` diff --git a/docs/operator/VictoriaMetrics-Operator.md b/docs/operator/VictoriaMetrics-Operator.md index 8cfbd10f9..3bf2a288d 100644 --- a/docs/operator/VictoriaMetrics-Operator.md +++ b/docs/operator/VictoriaMetrics-Operator.md @@ -48,7 +48,7 @@ and disable CRD controller with flag: `--controller.disableCRDOwnership=true` ## Troubleshooting - cannot apply crd at kubernetes 1.18 + version and kubectl reports error: -```bash +```console Error from server (Invalid): error when creating "release/crds/crd.yaml": CustomResourceDefinition.apiextensions.k8s.io "vmalertmanagers.operator.victoriametrics.com" is invalid: [spec.validation.openAPIV3Schema.properties[spec].properties[initContainers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property, spec.validation.openAPIV3Schema.properties[spec].properties[containers].items.properties[ports].items.properties[protocol].default: Required value: this property is in x-kubernetes-list-map-keys, so it must have a default or be a required property] Error from server (Invalid): error when creating "release/crds/crd.yaml": CustomResourceDefinition.apiextensions.k8s.io "vmalerts.operator.victoriametrics.com" is invalid: [ ``` @@ -62,12 +62,12 @@ Error from server (Invalid): error when creating "release/crds/crd.yaml": Custom - minikube or kind start: -```bash +```console make run ``` for test execution run: -```bash +```console #unit tests make test diff --git a/docs/operator/high-availability.MD b/docs/operator/high-availability.MD index 229ffc825..57d6f1779 100644 --- a/docs/operator/high-availability.MD +++ b/docs/operator/high-availability.MD @@ -280,7 +280,7 @@ EOF Then wait for the cluster becomes ready -```bash +```console kubectl get vmclusters -w NAME INSERT COUNT STORAGE COUNT SELECT COUNT AGE STATUS example-vmcluster-persistent 2 2 2 2s expanding @@ -289,7 +289,7 @@ example-vmcluster-persistent 2 2 2 30s Get links for connection by executing the command: -```bash +```console kubectl get svc -l app.kubernetes.io/instance=example-vmcluster-persistent NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE vminsert-example-vmcluster-persistent ClusterIP 10.96.34.94 8480/TCP 69s diff --git a/docs/operator/quick-start.MD b/docs/operator/quick-start.MD index ede19fdd0..3f9dc5c75 100644 --- a/docs/operator/quick-start.MD +++ b/docs/operator/quick-start.MD @@ -13,7 +13,7 @@ Obtain release from releases page: We suggest use the latest release. -```bash +```console # Get latest release version from https://github.com/VictoriaMetrics/operator/releases/latest export VM_VERSION=`basename $(curl -fs -o/dev/null -w %{redirect_url} https://github.com/VictoriaMetrics/operator/releases/latest)` wget https://github.com/VictoriaMetrics/operator/releases/download/$VM_VERSION/bundle_crd.zip @@ -24,7 +24,7 @@ unzip bundle_crd.zip > sed -i "s/namespace: monitoring-system/namespace: YOUR_NAMESPACE/g" release/operator/* First of all, you have to create [custom resource definitions](https://github.com/VictoriaMetrics/operator) -```bash +```console kubectl apply -f release/crds ``` @@ -32,13 +32,13 @@ Then you need RBAC for operator, relevant configuration for the release can be f Change configuration for operator at `release/operator/manager.yaml`, possible settings: [operator-settings](/vars.MD) and apply it: -```bash +```console kubectl apply -f release/operator/ ``` Check the status of operator -```bash +```console kubectl get pods -n monitoring-system #NAME READY STATUS RESTARTS AGE @@ -74,19 +74,19 @@ You can change [operator-settings](/vars.MD), or use your custom namespace see [ Build template -```bash +```console kustomize build . -o monitoring.yaml ``` Apply manifests -```bash +```console kubectl apply -f monitoring.yaml ``` Check the status of operator -```bash +```console kubectl get pods -n monitoring-system #NAME READY STATUS RESTARTS AGE @@ -269,7 +269,7 @@ EOF It requires access to Kubernetes API and you can create RBAC for it first, it can be found at `release/examples/VMAgent_rbac.yaml` Or you can use default rbac account, that will be created for `VMAgent` by operator automatically. -```bash +```console kubectl apply -f release/examples/vmagent_rbac.yaml ``` @@ -538,7 +538,7 @@ EOF ``` Check status for pods: - ```bash + ```console kubectl get pods NAME READY STATUS RESTARTS AGE example-app-594f97677c-g72v8 1/1 Running 0 23s @@ -552,7 +552,7 @@ vmsingle-example-vmsingle-persisted-794b59ccc6-fnkpt 1/1 Running 0 ``` Checking logs for `VMAgent`: -```bash +```console kubectl logs vmagent-example-vmagent-5777fdf7bf-tctcv vmagent 2020-08-02T18:18:17.226Z info VictoriaMetrics/app/vmagent/remotewrite/remotewrite.go:98 Successfully reloaded relabel configs 2020-08-02T18:18:17.229Z info VictoriaMetrics/lib/promscrape/scraper.go:137 found changes in "/etc/vmagent/config_out/vmagent.env.yaml"; applying these changes @@ -606,7 +606,7 @@ EOF Let's check `VMAgent` logs (you have to wait some time for config sync, usually its around 1 min): - ```bash + ```console kubectl logs vmagent-example-vmagent-5777fdf7bf-tctcv vmagent --tail 100 2020-08-03T08:24:13.312Z info VictoriaMetrics/lib/promscrape/scraper.go:106 SIGHUP received; reloading Prometheus configs from "/etc/vmagent/config_out/vmagent.env.yaml" 2020-08-03T08:24:13.312Z info VictoriaMetrics/app/vmagent/remotewrite/remotewrite.go:98 Successfully reloaded relabel configs @@ -668,7 +668,7 @@ EOF ``` Ensure, that pods started: - ```bash + ```console kubectl get pods NAME READY STATUS RESTARTS AGE example-app-594f97677c-g72v8 1/1 Running 0 3m40s @@ -700,7 +700,7 @@ EOF ``` Lets check `VMAgent` logs: - ```bash + ```console kubectl logs vmagent-example-vmagent-5777fdf7bf-tctcv vmagent --tail 100 2020-08-03T08:51:13.582Z info VictoriaMetrics/app/vmagent/remotewrite/remotewrite.go:98 Successfully reloaded relabel configs 2020-08-03T08:51:13.585Z info VictoriaMetrics/lib/promscrape/scraper.go:137 found changes in "/etc/vmagent/config_out/vmagent.env.yaml"; applying these changes @@ -736,7 +736,7 @@ EOF ``` Ensure, that it started and ready: -```bash +```console kubectl get pods -l app.kubernetes.io/name=vmalert NAME READY STATUS RESTARTS AGE vmalert-example-vmalert-6f8748c6f9-hcfrr 2/2 Running 0 2m26s @@ -779,7 +779,7 @@ EOF {% endraw %} Ensure, that new alert was started: - ```bash + ```console kubectl logs vmalert-example-vmalert-6f8748c6f9-hcfrr vmalert 2020-08-03T09:07:49.772Z info VictoriaMetrics/app/vmalert/web.go:45 api config reload was called, sending sighup 2020-08-03T09:07:49.772Z info VictoriaMetrics/app/vmalert/main.go:115 SIGHUP received. Going to reload rules ["/etc/vmalert/config/vm-example-vmalert-rulefiles-0/*.yaml"] ... @@ -817,14 +817,14 @@ EOF {% endraw %} `VMAlert` will report incorrect rule config and fire alert: -```bash +```console 2020-08-03T09:11:40.672Z info VictoriaMetrics/app/vmalert/main.go:115 SIGHUP received. Going to reload rules ["/etc/vmalert/config/vm-example-vmalert-rulefiles-0/*.yaml"] ... 2020-08-03T09:11:40.672Z info VictoriaMetrics/app/vmalert/manager.go:83 reading rules configuration file from "/etc/vmalert/config/vm-example-vmalert-rulefiles-0/*.yaml" 2020-08-03T09:11:40.673Z error VictoriaMetrics/app/vmalert/main.go:119 error while reloading rules: cannot parse configuration file: invalid group "incorrect rule" in file "/etc/vmalert/config/vm-example-vmalert-rulefiles-0/default-example-vmrule-incorrect-rule.yaml": invalid rule "incorrect rule"."vmalert bad config": invalid expression: unparsed data left: "expression" ``` Clean up incorrect rule: -```bash +```console kubectl delete vmrule example-vmrule-incorrect-rule ``` @@ -976,7 +976,7 @@ EOF Ensure, that pods are ready: -```bash +```console kubectl get pods NAME READY STATUS RESTARTS AGE prometheus-blackbox-exporter-5b5f44bd9c-2szdj 1/1 Running 0 3m3s @@ -986,7 +986,7 @@ vmsingle-example-vmsingle-persisted-8584486b68-mqg6b 1/1 Running 0 Now define some `VMProbe`, lets start with basic static target and probe `VMAgent` with its service address, for accessing blackbox exporter, you have to specify its url at `VMProbe` config. Lets get both services names: -```bash +```console kubectl get svc NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE kubernetes ClusterIP 10.96.0.1 443/TCP 4h21m @@ -1095,7 +1095,7 @@ spec: EOF ``` 2 targets must be added to `VMAgent` scrape config: -```bash +```console static_configs: added targets: 2, removed targets: 0; total targets: 2 ``` @@ -1200,7 +1200,7 @@ EOF ``` Check its status -```bash +```console kubectl get pods NAME READY STATUS RESTARTS AGE @@ -1233,7 +1233,7 @@ EOF Configuration changes for `VMAuth` takes some time, coz of mounted secret, its eventually updated by kubelet. Check vmauth log for changes: -```bash +```console kubectl logs vmauth-example-ffcc78fcc-xddk7 vmauth -f --tail 10 2021-05-31T10:46:40.171Z info VictoriaMetrics/app/vmauth/auth_config.go:168 Loaded information about 1 users from "/opt/vmauth/config.yaml" 2021-05-31T10:46:40.171Z info VictoriaMetrics/app/vmauth/main.go:37 started vmauth in 0.000 seconds @@ -1249,7 +1249,7 @@ kubectl logs vmauth-example-ffcc78fcc-xddk7 vmauth -f --tail 10 Now lets try to access protected endpoints, i will use port-forward for that: -```bash +```console kubectl port-forward vmauth-example-ffcc78fcc-xddk7 8427 # at separate terminal execute: @@ -1263,7 +1263,7 @@ curl localhost:8427/api/v1/groups -u 'simple-user:simple-password' Check create secret for application access: -```bash +```console kubectl get secrets vmuser-example NAME TYPE DATA AGE vmuser-example Opaque 2 6m33s @@ -1275,7 +1275,7 @@ By default, the operator converts all existing prometheus-operator API objects i You can control this behaviour by setting env variable for operator: -```bash +```console #disable convertion for each object VM_ENABLEDPROMETHEUSCONVERTER_PODMONITOR=false VM_ENABLEDPROMETHEUSCONVERTER_SERVICESCRAPE=false @@ -1326,7 +1326,7 @@ spec: By default the operator doesn't make converted objects disappear after original ones are deleted. To change this behaviour configure adding `OwnerReferences` to converted objects: -```bash +```console VM_ENABLEDPROMETHEUSCONVERTEROWNERREFERENCES=true ``` Converted objects will be linked to the original ones and will be deleted by kubernetes after the original ones are deleted. @@ -1404,7 +1404,7 @@ to the rule config: Example for Kubernetes Nginx ingress [doc](https://kubernetes.github.io/ingress-nginx/examples/auth/basic/) -```bash +```console #generate creds htpasswd -c auth foo diff --git a/docs/url-examples.md b/docs/url-examples.md index d5c169eec..2d2905192 100644 --- a/docs/url-examples.md +++ b/docs/url-examples.md @@ -11,7 +11,7 @@ sort: 21 Single:
-```bash +```console curl 'http://:8428/api/v1/admin/tsdb/delete_series?match[]=vm_http_request_errors_total' ``` @@ -20,7 +20,7 @@ curl 'http://:8428/api/v1/admin/tsdb/delete_series?match[] Cluster:
-```bash +```console curl 'http://:8481/delete/0/prometheus/api/v1/admin/tsdb/delete_series?match[]=vm_http_request_errors_total' ``` @@ -37,7 +37,7 @@ Additional information: Single:
-```bash +```console curl 'http://:8428/api/v1/export/csv?format=__name__,__value__,__timestamp__:unix_s&match=vm_http_request_errors_total' > filename.txt ``` @@ -46,7 +46,7 @@ curl 'http://:8428/api/v1/export/csv?format=__name__,__val Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/export/csv?format=__name__,__value__,__timestamp__:unix_s&match=vm_http_request_errors_total' > filename.txt ``` @@ -64,7 +64,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://:8428/api/v1/export/native?match[]=vm_http_request_errors_total' > filename.txt ``` @@ -73,7 +73,7 @@ curl -G 'http://:8428/api/v1/export/native?match[]=vm_http Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/export/native?match=vm_http_request_errors_total' > filename.txt ``` @@ -90,7 +90,7 @@ More information: Single:
-```bash +```console curl --data-binary "@import.txt" -X POST 'http://destination-victoriametrics:8428/api/v1/import' ``` @@ -99,7 +99,7 @@ curl --data-binary "@import.txt" -X POST 'http://destination-victoriametrics:842 Cluster:
-```bash +```console curl --data-binary "@import.txt" -X POST 'http://:8480/insert/0/prometheus/api/v1/import' ``` @@ -107,7 +107,7 @@ curl --data-binary "@import.txt" -X POST 'http://:8480/insert/0/promet
-```bash +```console curl -d 'metric_name{foo="bar"} 123' -X POST 'http://:8480/insert/0/prometheus/api/v1/import/prometheus' ``` @@ -124,7 +124,7 @@ Additional information: Single:
-```bash +```console curl --data-binary "@import.txt" -X POST 'http://localhost:8428/api/v1/import/prometheus' curl -d "GOOG,1.23,4.56,NYSE" 'http://localhost:8428/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' ``` @@ -134,7 +134,7 @@ curl -d "GOOG,1.23,4.56,NYSE" 'http://localhost:8428/api/v1/import/csv?format=2: Cluster:
-```bash +```console curl --data-binary "@import.txt" -X POST 'http://:8480/insert/0/prometheus/api/v1/import/csv' curl -d "GOOG,1.23,4.56,NYSE" 'http://:8480/insert/0/prometheus/api/v1/import/csv?format=2:metric:ask,3:metric:bid,1:label:ticker,4:label:market' ``` @@ -153,7 +153,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/prometheus/api/v1/labels' ``` @@ -162,7 +162,7 @@ curl -G 'http://localhost:8428/prometheus/api/v1/labels' Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/labels' ``` @@ -179,7 +179,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/prometheus/api/v1/label/job/values' ``` @@ -188,7 +188,7 @@ curl -G 'http://localhost:8428/prometheus/api/v1/label/job/values' Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/label/job/values' ``` @@ -204,7 +204,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/prometheus/api/v1/query?query=vm_http_request_errors_total&time=2021-02-22T19:10:30.781Z' ``` @@ -213,7 +213,7 @@ curl -G 'http://localhost:8428/prometheus/api/v1/query?query=vm_http_request_err Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/query?query=vm_http_request_errors_total&time=2021-02-22T19:10:30.781Z' ``` @@ -231,7 +231,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/prometheus/api/v1/query_range?query=vm_http_request_errors_total&start=2021-02-22T19:10:30.781Z&step=20m' ``` @@ -240,7 +240,7 @@ curl -G 'http://localhost:8428/prometheus/api/v1/query_range?query=vm_http_reque Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/query_range?query=vm_http_request_errors_total&start=2021-02-22T19:10:30.781Z&step=20m' ``` @@ -248,11 +248,11 @@ curl -G 'http://:8481/select/0/prometheus/api/v1/query_range?query=vm_
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/query_range?query=vm_http_request_errors_total&start=-1h&step=10m' ``` -```bash +```console curl -G http://:8481/select/0/prometheus/api/v1/query_range --data-urlencode 'query=sum(increase(vm_http_request_errors_total{status=""}[5m])) by (status)' ``` @@ -270,7 +270,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/prometheus/api/v1/series?match[]=vm_http_request_errors_total&start=-1h' ``` @@ -279,7 +279,7 @@ curl -G 'http://localhost:8428/prometheus/api/v1/series?match[]=vm_http_request_ Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/series?match[]=vm_http_request_errors_total&start=-1h' ``` @@ -296,7 +296,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/prometheus/api/v1/status/tsdb' ``` @@ -305,7 +305,7 @@ curl -G 'http://localhost:8428/prometheus/api/v1/status/tsdb' Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/api/v1/status/tsdb' ``` @@ -324,7 +324,7 @@ Should be sent to vmagent/VMsingle Single:
-```bash +```console curl -G 'http://:8428/api/v1/targets' ``` @@ -332,7 +332,7 @@ curl -G 'http://:8428/api/v1/targets'
-```bash +```console curl -G 'http://:8429/api/v1/targets' ``` @@ -349,7 +349,7 @@ Additional information: Single:
-```bash +```console echo ' { "series": [ @@ -376,7 +376,7 @@ echo ' Cluster:
-```bash +```console echo ' { "series": [ @@ -411,7 +411,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/federate?match[]=vm_http_request_errors_total&start=2021-02-22T19:10:30.781Z' ``` @@ -420,7 +420,7 @@ curl -G 'http://localhost:8428/federate?match[]=vm_http_request_errors_total&sta Cluster:
-```bash +```console curl -G 'http://:8481/select/0/prometheus/federate?match[]=vm_http_request_errors_total&start=2021-02-22T19:10:30.781Z' ``` @@ -438,7 +438,7 @@ Additional information: Single:
-```bash +```console curl -G 'http://localhost:8428/graphite/metrics/find?query=vm_http_request_errors_total' ``` @@ -447,7 +447,7 @@ curl -G 'http://localhost:8428/graphite/metrics/find?query=vm_http_request_error Cluster:
-```bash +```console curl -G 'http://:8481/select/0/graphite/metrics/find?query=vm_http_request_errors_total' ``` @@ -466,7 +466,7 @@ Additional information: Single:
-```bash +```console curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://localhost:8428/write' ``` @@ -475,7 +475,7 @@ curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'ht Cluster:
-```bash +```console curl -d 'measurement,tag1=value1,tag2=value2 field1=123,field2=1.23' -X POST 'http://:8480/insert/0/influx/write' ``` @@ -495,7 +495,7 @@ Turned off by default. Enable OpenTSDB receiver in VictoriaMetrics by setting `- Single:
-```bash +```console echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2" | nc -N localhost 4242 ``` @@ -504,7 +504,7 @@ echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2" | nc -N localhost Cluster:
-```bash +```console echo "put foo.bar.baz `date +%s` 123 tag1=value1 tag2=value2 VictoriaMetrics_AccountID=0" | nc -N http:// 4242 ``` @@ -515,7 +515,7 @@ Enable HTTP server for OpenTSDB /api/put requests by setting `-opentsdbHTTPListe Single:
-```bash +```console curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' http://localhost:4242/api/put ``` @@ -524,7 +524,7 @@ curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"m Cluster:
-```bash +```console curl -H 'Content-Type: application/json' -d '[{"metric":"foo","value":45.34},{"metric":"bar","value":43}]' 'http://:8480/insert/42/opentsdb/api/put' ``` @@ -543,7 +543,7 @@ Enable Graphite receiver in VictoriaMetrics by setting `-graphiteListenAddr` com Single:
-```bash +```console echo "foo.bar.baz;tag1=value1;tag2=value2 123 `date +%s`" | nc -N localhost 2003 ``` @@ -553,7 +553,7 @@ echo "foo.bar.baz;tag1=value1;tag2=value2 123 `date +%s`" | Cluster:
-```bash +```console echo "foo.bar.baz;tag1=value1;tag2=value2;VictoriaMetrics_AccountID=42 123 `date +%s`" | nc -N http:// 2003 ``` diff --git a/docs/vmagent.md b/docs/vmagent.md index e886feb76..03e10b396 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -77,7 +77,7 @@ Pass `-help` to `vmagent` in order to see [the full list of supported command-li * Sending `SUGHUP` signal to `vmagent` process: - ```bash + ```console kill -SIGHUP `pidof vmagent` ``` @@ -597,7 +597,7 @@ Every Kafka message may contain multiple lines in `influx`, `prometheus`, `graph The following command starts `vmagent`, which reads metrics in InfluxDB line protocol format from Kafka broker at `localhost:9092` from the topic `metrics-by-telegraf` and sends them to remote storage at `http://localhost:8428/api/v1/write`: -```bash +```console ./bin/vmagent -remoteWrite.url=http://localhost:8428/api/v1/write \ -kafka.consumer.topic.brokers=localhost:9092 \ -kafka.consumer.topic.format=influx \ @@ -659,13 +659,13 @@ Two types of auth are supported: * sasl with username and password: -```bash +```console ./bin/vmagent -remoteWrite.url=kafka://localhost:9092/?topic=prom-rw&security.protocol=SASL_SSL&sasl.mechanisms=PLAIN -remoteWrite.basicAuth.username=user -remoteWrite.basicAuth.password=password ``` * tls certificates: -```bash +```console ./bin/vmagent -remoteWrite.url=kafka://localhost:9092/?topic=prom-rw&security.protocol=SSL -remoteWrite.tlsCAFile=/opt/ca.pem -remoteWrite.tlsCertFile=/opt/cert.pem -remoteWrite.tlsKeyFile=/opt/key.pem ``` @@ -694,7 +694,7 @@ The `` may be manually set via `PKG_TAG=foobar make package-vmagent`. The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is possible to use any other base image by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-vmagent ``` @@ -722,7 +722,7 @@ ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://b
-```bash +```console curl http://0.0.0.0:8429/debug/pprof/heap > mem.pprof ``` @@ -732,7 +732,7 @@ curl http://0.0.0.0:8429/debug/pprof/heap > mem.pprof
-```bash +```console curl http://0.0.0.0:8429/debug/pprof/profile > cpu.pprof ``` diff --git a/docs/vmalert.md b/docs/vmalert.md index b053709da..263bbfb75 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -40,7 +40,7 @@ implementation and aims to be compatible with its syntax. To build `vmalert` from sources: -```bash +```console git clone https://github.com/VictoriaMetrics/VictoriaMetrics cd VictoriaMetrics make vmalert @@ -62,7 +62,7 @@ To start using `vmalert` you will need the following things: Then configure `vmalert` accordingly: -```bash +```console ./bin/vmalert -rule=alert.rules \ # Path to the file with rules configuration. Supports wildcard -datasource.url=http://localhost:8428 \ # PromQL compatible datasource -notifier.url=http://localhost:9093 \ # AlertManager URL (required if alerting rules are used) @@ -1042,7 +1042,7 @@ It is recommended using You can build `vmalert` docker image from source and push it to your own docker repository. Run the following commands from the root folder of [the repository](https://github.com/VictoriaMetrics/VictoriaMetrics): -```bash +```console make package-vmalert docker tag victoria-metrics/vmalert:version my-repo:my-version-name docker push my-repo:my-version-name diff --git a/docs/vmauth.md b/docs/vmauth.md index aed0646c5..3d965ab9c 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -14,7 +14,7 @@ The `-auth.config` can point to either local file or to http url. Just download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), unpack it and pass the following flag to `vmauth` binary in order to start authorizing and routing requests: -```bash +```console /path/to/vmauth -auth.config=/path/to/auth/config.yml ``` @@ -133,7 +133,7 @@ It is expected that all the backend services protected by `vmauth` are located i Do not transfer Basic Auth headers in plaintext over untrusted networks. Enable https. This can be done by passing the following `-tls*` command-line flags to `vmauth`: -```bash +```console -tls Whether to enable TLS (aka HTTPS) for incoming requests. -tlsCertFile and -tlsKeyFile must be set if -tls is set -tlsCertFile string @@ -185,7 +185,7 @@ The `` may be manually set via `PKG_TAG=foobar make package-vmauth`. The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is possible to use any other base image by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-vmauth ``` @@ -197,7 +197,7 @@ ROOT_IMAGE=scratch make package-vmauth
-```bash +```console curl http://0.0.0.0:8427/debug/pprof/heap > mem.pprof ``` @@ -207,7 +207,7 @@ curl http://0.0.0.0:8427/debug/pprof/heap > mem.pprof
-```bash +```console curl http://0.0.0.0:8427/debug/pprof/profile > cpu.pprof ``` @@ -221,7 +221,7 @@ The collected profiles may be analyzed with [go tool pprof](https://github.com/g Pass `-help` command-line arg to `vmauth` in order to see all the configuration options: -```bash +```console ./vmauth -help vmauth authenticates and authorizes incoming requests and proxies them to VictoriaMetrics. diff --git a/docs/vmbackup.md b/docs/vmbackup.md index 64b160c49..8c48d6bd7 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -32,7 +32,7 @@ creation of hourly, daily, weekly and monthly backups. Regular backup can be performed with the following command: -```bash +```console vmbackup -storageDataPath= -snapshot.createURL=http://localhost:8428/snapshot/create -dst=gs:/// ``` @@ -47,7 +47,7 @@ vmbackup -storageDataPath= -snapshot.createURL=h If the destination GCS bucket already contains the previous backup at `-origin` path, then new backup can be sped up with the following command: -```bash +```console ./vmbackup -storageDataPath= -snapshot.createURL=http://localhost:8428/snapshot/create -dst=gs:/// -origin=gs:/// ``` @@ -58,7 +58,7 @@ It saves time and network bandwidth costs by performing server-side copy for the Incremental backups are performed if `-dst` points to an already existing backup. In this case only new data is uploaded to remote storage. It saves time and network bandwidth costs when working with big backups: -```bash +```console ./vmbackup -storageDataPath= -snapshot.createURL=http://localhost:8428/snapshot/create -dst=gs:/// ``` @@ -68,7 +68,7 @@ Smart backups mean storing full daily backups into `YYYYMMDD` folders and creati * Run the following command every hour: -```bash +```console ./vmbackup -storageDataPath= -snapshot.createURL=http://localhost:8428/snapshot/create -dst=gs:///latest ``` @@ -77,7 +77,7 @@ The command will upload only changed data to `gs:///latest`. * Run the following command once a day: -```bash +```console vmbackup -storageDataPath= -snapshot.createURL=http://localhost:8428/snapshot/create -dst=gs:/// -origin=gs:///latest ``` @@ -133,7 +133,7 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- for s3 (aws, minio or other s3 compatible storages): - ```bash + ```console [default] aws_access_key_id=theaccesskey aws_secret_access_key=thesecretaccesskeyvalue @@ -159,7 +159,7 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- * Usage with s3 custom url endpoint. It is possible to use `vmbackup` with s3 compatible storages like minio, cloudian, etc. You have to add a custom url endpoint via flag: -```bash +```console # for minio -customS3Endpoint=http://localhost:9000 @@ -169,7 +169,7 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- * Run `vmbackup -help` in order to see all the available options: -```bash +```console -concurrency int The number of concurrent workers. Higher concurrency may reduce backup duration (default 10) -configFilePath string @@ -284,6 +284,6 @@ The `` may be manually set via `PKG_TAG=foobar make package-vmbackup`. The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is possible to use any other base image by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-vmbackup ``` diff --git a/docs/vmctl.md b/docs/vmctl.md index 5eb5fac47..0960bcb3f 100644 --- a/docs/vmctl.md +++ b/docs/vmctl.md @@ -19,7 +19,7 @@ Features: To see the full list of supported modes run the following command: -```bash +```console $ ./vmctl --help NAME: vmctl - VictoriaMetrics command-line tool @@ -531,7 +531,7 @@ and specify `accountID` param. In this mode, `vmctl` allows verifying correctness and integrity of data exported via [native format](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-export-data-in-native-format) from VictoriaMetrics. You can verify exported data at disk before uploading it by `vmctl verify-block` command: -```bash +```console # export blocks from VictoriaMetrics curl localhost:8428/api/v1/export/native -g -d 'match[]={__name__!=""}' -o exported_data_block # verify block content @@ -654,7 +654,7 @@ The `` may be manually set via `PKG_TAG=foobar make package-vmctl`. The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is possible to use any other base image by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-vmctl ``` diff --git a/docs/vmgateway.md b/docs/vmgateway.md index a80e96a2c..6081b5773 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -58,7 +58,7 @@ Where: Start the single version of VictoriaMetrics -```bash +```console # single # start node ./bin/victoria-metrics --selfScrapeInterval=10s @@ -66,19 +66,19 @@ Start the single version of VictoriaMetrics Start vmgateway -```bash +```console ./bin/vmgateway -eula -enable.auth -read.url http://localhost:8428 --write.url http://localhost:8428 ``` Retrieve data from the database -```bash +```console curl 'http://localhost:8431/api/v1/series/count' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2bV9hY2Nlc3MiOnsidGVuYW50X2lkIjp7fSwicm9sZSI6MX0sImV4cCI6MTkzOTM0NjIxMH0.5WUxEfdcV9hKo4CtQdtuZYOGpGXWwaqM9VuVivMMrVg' ``` A request with an incorrect token or without any token will be rejected: -```bash +```console curl 'http://localhost:8431/api/v1/series/count' curl 'http://localhost:8431/api/v1/series/count' -H 'Authorization: Bearer incorrect-token' @@ -128,7 +128,7 @@ limits: cluster version of VictoriaMetrics is required for rate limiting. -```bash +```console # start datasource for cluster metrics cat << EOF > cluster.yaml diff --git a/docs/vmrestore.md b/docs/vmrestore.md index b70a290b7..6530407b5 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -14,7 +14,7 @@ when restarting `vmrestore` with the same args. VictoriaMetrics must be stopped during the restore process. -```bash +```console vmrestore -src=gs:/// -storageDataPath= ``` @@ -40,7 +40,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q for s3 (aws, minio or other s3 compatible storages): - ```bash + ```console [default] aws_access_key_id=theaccesskey aws_secret_access_key=thesecretaccesskeyvalue @@ -66,7 +66,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q * Usage with s3 custom url endpoint. It is possible to use `vmrestore` with s3 api compatible storages, like minio, cloudian and other. You have to add custom url endpoint with a flag: -```bash +```console # for minio: -customS3Endpoint=http://localhost:9000 @@ -76,7 +76,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q * Run `vmrestore -help` in order to see all the available options: -```bash +```console -concurrency int The number of concurrent workers. Higher concurrency may reduce restore duration (default 10) -configFilePath string @@ -184,6 +184,6 @@ The `` may be manually set via `PKG_TAG=foobar make package-vmrestore`. The base docker image is [alpine](https://hub.docker.com/_/alpine) but it is possible to use any other base image by setting it via `` environment variable. For example, the following command builds the image on top of [scratch](https://hub.docker.com/_/scratch) image: -```bash +```console ROOT_IMAGE=scratch make package-vmrestore ```