update wiki pages
@ -11,7 +11,7 @@ aliases:
|
|||||||
---
|
---
|
||||||
# Cluster version
|
# Cluster version
|
||||||
|
|
||||||
<img alt="VictoriaMetrics" src="logo.png" width="300">
|
<img alt="VictoriaMetrics" src="logo.webp" width="300">
|
||||||
|
|
||||||
VictoriaMetrics is a fast, cost-effective and scalable time series database. It can be used as a long-term remote storage for Prometheus.
|
VictoriaMetrics is a fast, cost-effective and scalable time series database. It can be used as a long-term remote storage for Prometheus.
|
||||||
|
|
||||||
@ -57,7 +57,7 @@ This is a [shared nothing architecture](https://en.wikipedia.org/wiki/Shared-not
|
|||||||
It increases cluster availability, and simplifies cluster maintenance as well as cluster scaling.
|
It increases cluster availability, and simplifies cluster maintenance as well as cluster scaling.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="Cluster-VictoriaMetrics_cluster-scheme.png" width="800">
|
<img src="Cluster-VictoriaMetrics_cluster-scheme.webp" width="800">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Multitenancy
|
## Multitenancy
|
||||||
|
BIN
Cluster-VictoriaMetrics_cluster-scheme.webp
Normal file
After Width: | Height: | Size: 53 KiB |
38
Makefile
@ -1,34 +1,24 @@
|
|||||||
docs-install:
|
# run local server for documentation website at http://127.0.0.1:4000/
|
||||||
gem install jekyll bundler
|
|
||||||
bundle install --gemfile=Gemfile
|
|
||||||
|
|
||||||
# To run locally you need to use ruby version =< 2.7.6, but not >=3.x , see https://bbs.archlinux.org/viewtopic.php?pid=1976408#p1976408
|
|
||||||
#
|
|
||||||
# run local server for documentation website
|
|
||||||
# at http://127.0.0.1:4000/
|
|
||||||
# On first use, please run `make docs-install`
|
|
||||||
docs-up:
|
docs-up:
|
||||||
JEKYLL_GITHUB_TOKEN=blank PAGES_API_URL=http://0.0.0.0 bundle exec \
|
|
||||||
--gemfile=Gemfile \
|
|
||||||
jekyll server --livereload
|
|
||||||
|
|
||||||
docs-up-docker:
|
|
||||||
docker run --rm -it \
|
docker run --rm -it \
|
||||||
-e JEKYLL_GITHUB_TOKEN=blank \
|
-e JEKYLL_GITHUB_TOKEN=blank \
|
||||||
-e PAGES_API_URL=http://0.0.0.0 \
|
-e PAGES_API_URL=http://0.0.0.0 \
|
||||||
-e PAGES_REPO_NWO=VictoriaMetrics/VictoriaMetrics \
|
-e PAGES_REPO_NWO=VictoriaMetrics/VictoriaMetrics \
|
||||||
-p 4000:4000 \
|
-p 4000:4000 \
|
||||||
-v $(PWD):/srv/jekyll \
|
-v $(shell pwd)/docs:/srv/jekyll \
|
||||||
jekyll/jekyll:3.8 jekyll serve --livereload
|
jekyll/jekyll:3.8 jekyll serve --livereload --incremental
|
||||||
|
|
||||||
# Converts $IMAGES_EXTENSION in the specified $PATH_TO_IMAGES
|
# Converts images at docs folder to webp format
|
||||||
# to webp format with $IMAGE_QUALITY (0:small..100:big)
|
|
||||||
# See https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#images-in-documentation
|
# See https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#images-in-documentation
|
||||||
docs-images-to-webp:
|
docs-images-to-webp:
|
||||||
docker run -it --rm -v \
|
IMAGES_EXTENSION=jpg $(MAKE) docs-images-to-webp-by-extension
|
||||||
$(PWD)/$(PATH_TO_IMAGES):/data \
|
IMAGES_EXTENSION=jpeg $(MAKE) docs-images-to-webp-by-extension
|
||||||
elswork/cwebp \
|
IMAGES_EXTENSION=png $(MAKE) docs-images-to-webp-by-extension
|
||||||
find ./ -type f -name '*.$(IMAGES_EXTENSION)' -exec sh -c 'cwebp -q ${IMAGE_QUALITY} -m 6 $$1 -o "$${1%.png}.webp"' _ {} \;
|
|
||||||
|
|
||||||
docs-remove-old-images:
|
docs-images-to-webp-by-extension:
|
||||||
rm -f $(PWD)/$(PATH_TO_IMAGES)/*.$(IMAGES_EXTENSION)
|
docker run --rm -it \
|
||||||
|
-v $(shell pwd)/docs:/docs \
|
||||||
|
elswork/cwebp \
|
||||||
|
sh -c 'find /docs/ -type f ! -path "/docs/operator/*" ! -path "/docs/_site/*" -name "*.$(IMAGES_EXTENSION)" -print0 | \
|
||||||
|
xargs -0 -P $(MAKE_CONCURRENCY) -I {} sh -c '"'"'cwebp -preset drawing -m 6 -o "$${1%.*}.webp" $$1'"'"' _ {}'
|
||||||
|
find docs/ -type f ! -path 'docs/operator/*' ! -path 'docs/_site/*' -name '*.$(IMAGES_EXTENSION)' -print0 | xargs -0 rm -f
|
||||||
|
BIN
PerTenantStatistic-stats.webp
Normal file
After Width: | Height: | Size: 39 KiB |
@ -14,7 +14,7 @@ aliases:
|
|||||||
|
|
||||||
***The per-tenant statistic is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). You need to request a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.***
|
***The per-tenant statistic is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). You need to request a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.***
|
||||||
|
|
||||||
<img alt="cluster-per-tenant-stat" src="PerTenantStatistic-stats.jpg">
|
<img alt="cluster-per-tenant-stat" src="PerTenantStatistic-stats.webp">
|
||||||
|
|
||||||
VictoriaMetrics cluster for enterprise provides various metrics and statistics usage per tenant:
|
VictoriaMetrics cluster for enterprise provides various metrics and statistics usage per tenant:
|
||||||
|
|
||||||
|
21
README.md
@ -12,7 +12,7 @@ title: VictoriaMetrics
|
|||||||
[![Build Status](https://github.com/VictoriaMetrics/VictoriaMetrics/workflows/main/badge.svg)](https://github.com/VictoriaMetrics/VictoriaMetrics/actions)
|
[![Build Status](https://github.com/VictoriaMetrics/VictoriaMetrics/workflows/main/badge.svg)](https://github.com/VictoriaMetrics/VictoriaMetrics/actions)
|
||||||
[![codecov](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics/branch/master/graph/badge.svg)](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics)
|
[![codecov](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics/branch/master/graph/badge.svg)](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics)
|
||||||
|
|
||||||
<img src="logo.png" width="300" alt="VictoriaMetrics logo">
|
<img src="logo.webp" width="300" alt="VictoriaMetrics logo">
|
||||||
|
|
||||||
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.
|
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.
|
||||||
|
|
||||||
@ -521,7 +521,7 @@ DataDog agent allows configuring destinations for metrics sending via ENV variab
|
|||||||
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
|
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.png" width="800">
|
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.webp" width="800">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
To configure DataDog agent via ENV variable add the following prefix:
|
To configure DataDog agent via ENV variable add the following prefix:
|
||||||
@ -555,7 +555,7 @@ DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guid
|
|||||||
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
|
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.png" width="800">
|
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.webp" width="800">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
|
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
|
||||||
@ -2502,19 +2502,14 @@ Report bugs and propose new features [here](https://github.com/VictoriaMetrics/V
|
|||||||
Please, keep image size and number of images per single page low. Keep the docs page as lightweight as possible.
|
Please, keep image size and number of images per single page low. Keep the docs page as lightweight as possible.
|
||||||
|
|
||||||
If the page needs to have many images, consider using WEB-optimized image format [webp](https://developers.google.com/speed/webp).
|
If the page needs to have many images, consider using WEB-optimized image format [webp](https://developers.google.com/speed/webp).
|
||||||
When adding a new doc with many images use `webp` format right away. Or use a MAKEFILE command below to
|
When adding a new doc with many images use `webp` format right away. Or use a Makefile command below to
|
||||||
convert already existing images automatically:
|
convert already existing images at `docs` folder automatically to `web` format:
|
||||||
```console
|
|
||||||
PATH_TO_IMAGES=path/to/images IMAGES_EXTENSION={png|jpg|jpeg} IMAGE_QUALITY=0..100 make docs-images-to-webp
|
|
||||||
```
|
|
||||||
|
|
||||||
_// For this command to work ensure you run it when in `docs` dir (`cd docs`) and have Docker up&running._
|
```console
|
||||||
|
make docs-images-to-webp
|
||||||
|
```
|
||||||
|
|
||||||
Once conversion is done, update the path to images in your docs and verify everything is correct.
|
Once conversion is done, update the path to images in your docs and verify everything is correct.
|
||||||
When you're happy with result - remove the originals with the following command:
|
|
||||||
```console
|
|
||||||
PATH_TO_IMAGES=path/to/images IMAGES_EXTENSION={png|jpg|jpeg} make docs-remove-old-images
|
|
||||||
```
|
|
||||||
|
|
||||||
## VictoriaMetrics Logo
|
## VictoriaMetrics Logo
|
||||||
|
|
||||||
|
@ -173,7 +173,7 @@ Once updated, run the following commands:
|
|||||||
|
|
||||||
1. Commit and push changes to `master`.
|
1. Commit and push changes to `master`.
|
||||||
1. Run "Release" action on Github:
|
1. Run "Release" action on Github:
|
||||||
![image](Release-Guide_helm-release.png)
|
![image](Release-Guide_helm-release.webp)
|
||||||
1. Merge new PRs *"Automatic update CHANGELOGs and READMEs"* and *"Synchronize docs"* after pipelines are complete.
|
1. Merge new PRs *"Automatic update CHANGELOGs and READMEs"* and *"Synchronize docs"* after pipelines are complete.
|
||||||
|
|
||||||
## Ansible Roles
|
## Ansible Roles
|
||||||
|
BIN
Release-Guide_helm-release.webp
Normal file
After Width: | Height: | Size: 81 KiB |
BIN
Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.webp
Normal file
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 22 KiB |
@ -20,7 +20,7 @@ aliases:
|
|||||||
[![Build Status](https://github.com/VictoriaMetrics/VictoriaMetrics/workflows/main/badge.svg)](https://github.com/VictoriaMetrics/VictoriaMetrics/actions)
|
[![Build Status](https://github.com/VictoriaMetrics/VictoriaMetrics/workflows/main/badge.svg)](https://github.com/VictoriaMetrics/VictoriaMetrics/actions)
|
||||||
[![codecov](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics/branch/master/graph/badge.svg)](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics)
|
[![codecov](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics/branch/master/graph/badge.svg)](https://codecov.io/gh/VictoriaMetrics/VictoriaMetrics)
|
||||||
|
|
||||||
<img src="logo.png" width="300" alt="VictoriaMetrics logo">
|
<img src="logo.webp" width="300" alt="VictoriaMetrics logo">
|
||||||
|
|
||||||
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.
|
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.
|
||||||
|
|
||||||
@ -529,7 +529,7 @@ DataDog agent allows configuring destinations for metrics sending via ENV variab
|
|||||||
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
|
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.png" width="800">
|
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.webp" width="800">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
To configure DataDog agent via ENV variable add the following prefix:
|
To configure DataDog agent via ENV variable add the following prefix:
|
||||||
@ -563,7 +563,7 @@ DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guid
|
|||||||
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
|
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.png" width="800">
|
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.webp" width="800">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
|
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
|
||||||
@ -2510,19 +2510,14 @@ Report bugs and propose new features [here](https://github.com/VictoriaMetrics/V
|
|||||||
Please, keep image size and number of images per single page low. Keep the docs page as lightweight as possible.
|
Please, keep image size and number of images per single page low. Keep the docs page as lightweight as possible.
|
||||||
|
|
||||||
If the page needs to have many images, consider using WEB-optimized image format [webp](https://developers.google.com/speed/webp).
|
If the page needs to have many images, consider using WEB-optimized image format [webp](https://developers.google.com/speed/webp).
|
||||||
When adding a new doc with many images use `webp` format right away. Or use a MAKEFILE command below to
|
When adding a new doc with many images use `webp` format right away. Or use a Makefile command below to
|
||||||
convert already existing images automatically:
|
convert already existing images at `docs` folder automatically to `web` format:
|
||||||
```console
|
|
||||||
PATH_TO_IMAGES=path/to/images IMAGES_EXTENSION={png|jpg|jpeg} IMAGE_QUALITY=0..100 make docs-images-to-webp
|
|
||||||
```
|
|
||||||
|
|
||||||
_// For this command to work ensure you run it when in `docs` dir (`cd docs`) and have Docker up&running._
|
```console
|
||||||
|
make docs-images-to-webp
|
||||||
|
```
|
||||||
|
|
||||||
Once conversion is done, update the path to images in your docs and verify everything is correct.
|
Once conversion is done, update the path to images in your docs and verify everything is correct.
|
||||||
When you're happy with result - remove the originals with the following command:
|
|
||||||
```console
|
|
||||||
PATH_TO_IMAGES=path/to/images IMAGES_EXTENSION={png|jpg|jpeg} make docs-remove-old-images
|
|
||||||
```
|
|
||||||
|
|
||||||
## VictoriaMetrics Logo
|
## VictoriaMetrics Logo
|
||||||
|
|
||||||
|
@ -81,7 +81,7 @@ with `vl_http_requests_total{path="/select/logsql/query"}` metric.
|
|||||||
VictoriaLogs provides a simple Web UI for logs [querying](https://docs.victoriametrics.com/VictoriaLogs/LogsQL.html) and exploration
|
VictoriaLogs provides a simple Web UI for logs [querying](https://docs.victoriametrics.com/VictoriaLogs/LogsQL.html) and exploration
|
||||||
at `http://localhost:9428/select/vmui`. The UI allows exploring query results:
|
at `http://localhost:9428/select/vmui`. The UI allows exploring query results:
|
||||||
|
|
||||||
<img src="vmui.png" width="800" />
|
<img src="vmui.webp" width="800" />
|
||||||
|
|
||||||
There are three modes of displaying query results:
|
There are three modes of displaying query results:
|
||||||
|
|
||||||
|
BIN
VictoriaLogs/querying/vmui.webp
Normal file
After Width: | Height: | Size: 263 KiB |
@ -109,7 +109,7 @@ Please find the example of provisioning Grafana instance with VictoriaMetrics da
|
|||||||
|
|
||||||
1. Download the latest release:
|
1. Download the latest release:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/grafana-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
|
ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/grafana-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
|
||||||
curl -L https://github.com/VictoriaMetrics/grafana-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o plugin.tar.gz
|
curl -L https://github.com/VictoriaMetrics/grafana-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o plugin.tar.gz
|
||||||
tar -xf plugin.tar.gz -C ./victoriametrics-datasource
|
tar -xf plugin.tar.gz -C ./victoriametrics-datasource
|
||||||
@ -143,7 +143,7 @@ docker-compose -f docker-compose.yaml up
|
|||||||
When Grafana starts successfully datasources should be present on the datasources tab
|
When Grafana starts successfully datasources should be present on the datasources tab
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="provision_datasources.png" width="800" alt="Configuration">
|
<img src="grafana-datasource_provision_datasources.webp" width="800" alt="Configuration">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### Install in Kubernetes
|
### Install in Kubernetes
|
||||||
@ -248,7 +248,7 @@ This example uses init container to download and install plugin.
|
|||||||
|
|
||||||
1. To download plugin build and move contents into Grafana plugins directory:
|
1. To download plugin build and move contents into Grafana plugins directory:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/grafana-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
|
ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/grafana-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
|
||||||
curl -L https://github.com/VictoriaMetrics/grafana-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/plugin.tar.gz
|
curl -L https://github.com/VictoriaMetrics/grafana-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/plugin.tar.gz
|
||||||
tar -xf /var/lib/grafana/plugins/plugin.tar.gz -C /var/lib/grafana/plugins/
|
tar -xf /var/lib/grafana/plugins/plugin.tar.gz -C /var/lib/grafana/plugins/
|
||||||
@ -262,14 +262,19 @@ This example uses init container to download and install plugin.
|
|||||||
|
|
||||||
### 1. Configure Grafana
|
### 1. Configure Grafana
|
||||||
Installing dev version of Grafana plugin requires to change `grafana.ini` config to allow loading unsigned plugins:
|
Installing dev version of Grafana plugin requires to change `grafana.ini` config to allow loading unsigned plugins:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
``` ini
|
``` ini
|
||||||
# Directory where Grafana will automatically scan and look for plugins
|
# Directory where Grafana will automatically scan and look for plugins
|
||||||
plugins = {{path to directory with plugin}}
|
plugins = {{path to directory with plugin}}
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
``` ini
|
``` ini
|
||||||
[plugins]
|
[plugins]
|
||||||
allow_loading_unsigned_plugins = victoriametrics-datasource
|
allow_loading_unsigned_plugins = victoriametrics-datasource
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Run the plugin
|
### 2. Run the plugin
|
||||||
In the project directory, you can run:
|
In the project directory, you can run:
|
||||||
```
|
```
|
||||||
|
BIN
grafana-datasource_provision_datasources.webp
Normal file
After Width: | Height: | Size: 36 KiB |
@ -232,7 +232,7 @@ To check that `VMAgent` collects metrics from the k8s cluster open in the browse
|
|||||||
You will see something like this:
|
You will see something like this:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-via-vm-operator.png" width="800" alt="">
|
<img src="getting-started-with-vm-operator_vmcluster.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
`VMAgent` connects to [kubernetes service discovery](https://kubernetes.io/docs/concepts/services-networking/service/) and gets targets which needs to be scraped. This service discovery is controlled by [VictoriaMetrics Operator](https://github.com/VictoriaMetrics/operator)
|
`VMAgent` connects to [kubernetes service discovery](https://kubernetes.io/docs/concepts/services-networking/service/) and gets targets which needs to be scraped. This service discovery is controlled by [VictoriaMetrics Operator](https://github.com/VictoriaMetrics/operator)
|
||||||
@ -312,13 +312,13 @@ EOF
|
|||||||
To check that [VictoriaMetrics](https://victoriametrics.com) collecting metrics from the k8s cluster open in your browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose the `VictoriaMetrics - cluster` dashboard. Use `admin` for login and the `password` that you previously got from kubectl.
|
To check that [VictoriaMetrics](https://victoriametrics.com) collecting metrics from the k8s cluster open in your browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose the `VictoriaMetrics - cluster` dashboard. Use `admin` for login and the `password` that you previously got from kubectl.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-via-vm-operator-grafana1.png" width="800" alt="grafana dashboards">
|
<img src="getting-started-with-vm-operator_vmcluster-grafana1.webp" width="800" alt="grafana dashboards">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
The expected output is:
|
The expected output is:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-via-vm-operator-grafana2.png" width="800" alt="grafana dashboards">
|
<img src="getting-started-with-vm-operator_vmcluster-grafana2.webp" width="800" alt="grafana dashboards">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 6. Summary
|
## 6. Summary
|
||||||
|
BIN
guides/getting-started-with-vm-operator_vmcluster-grafana1.webp
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
guides/getting-started-with-vm-operator_vmcluster-grafana2.webp
Normal file
After Width: | Height: | Size: 74 KiB |
BIN
guides/getting-started-with-vm-operator_vmcluster.webp
Normal file
After Width: | Height: | Size: 119 KiB |
@ -48,21 +48,21 @@ See details about all supported options in the [vmgateway documentation](https:/
|
|||||||
Use `OpenID Connect` as `Client Type`.<br>
|
Use `OpenID Connect` as `Client Type`.<br>
|
||||||
Specify `grafana` as `Client ID`.<br>
|
Specify `grafana` as `Client ID`.<br>
|
||||||
Click `Next`.<br>
|
Click `Next`.<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/create-client-1.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/create-client-1.webp" width="800">
|
||||||
1. Enable `Client authentication`.<br>
|
1. Enable `Client authentication`.<br>
|
||||||
Enable `Authorization`.<br>
|
Enable `Authorization`.<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/create-client-2.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/create-client-2.webp" width="800"><br>
|
||||||
Click `Next`.<br>
|
Click `Next`.<br>
|
||||||
1. Add Grafana URL as `Root URL`. For example, `http://localhost:3000/`.<br>
|
1. Add Grafana URL as `Root URL`. For example, `http://localhost:3000/`.<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/create-client-3.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/create-client-3.webp" width="800"><br>
|
||||||
Click `Save`.<br>
|
Click `Save`.<br>
|
||||||
1. Go to `Clients` -> `grafana` -> `Credentials`.<br>
|
1. Go to `Clients` -> `grafana` -> `Credentials`.<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/client-secret.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/client-secret.webp" width="800"><br>
|
||||||
Copy the value of `Client secret`. It will be used later in Grafana configuration.<br>
|
Copy the value of `Client secret`. It will be used later in Grafana configuration.<br>
|
||||||
1. Go to `Clients` -> `grafana` -> `Client scopes`.<br>
|
1. Go to `Clients` -> `grafana` -> `Client scopes`.<br>
|
||||||
Click at `grafana-dedicated` -> `Add mapper` -> `By configuration` -> `User attribute`.<br>
|
Click at `grafana-dedicated` -> `Add mapper` -> `By configuration` -> `User attribute`.<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/create-mapper-1.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/create-mapper-1.webp" width="800"><br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/create-mapper-2.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/create-mapper-2.webp" width="800"><br>
|
||||||
Configure the mapper as follows<br>
|
Configure the mapper as follows<br>
|
||||||
- `Name` as `vm_access`.
|
- `Name` as `vm_access`.
|
||||||
- `Token Claim Name` as `vm_access`.
|
- `Token Claim Name` as `vm_access`.
|
||||||
@ -70,7 +70,7 @@ See details about all supported options in the [vmgateway documentation](https:/
|
|||||||
- `Claim JSON Type` as `JSON`.
|
- `Claim JSON Type` as `JSON`.
|
||||||
Enable `Add to ID token` and `Add to access token`.<br>
|
Enable `Add to ID token` and `Add to access token`.<br>
|
||||||
|
|
||||||
<img src="grafana-vmgateway-openid-configuration/create-mapper-3.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/create-mapper-3.webp" width="800"><br>
|
||||||
Click `Save`.<br>
|
Click `Save`.<br>
|
||||||
1. Go to `Users` -> select user to configure claims -> `Attributes`.<br>
|
1. Go to `Users` -> select user to configure claims -> `Attributes`.<br>
|
||||||
Specify `vm_access` as `Key`.<br>
|
Specify `vm_access` as `Key`.<br>
|
||||||
@ -78,7 +78,7 @@ See details about all supported options in the [vmgateway documentation](https:/
|
|||||||
- for the first user we will specify `{"tenant_id" : {"account_id": 0, "project_id": 0 },"extra_labels":{ "team": "admin" }}` as `Value`.
|
- for the first user we will specify `{"tenant_id" : {"account_id": 0, "project_id": 0 },"extra_labels":{ "team": "admin" }}` as `Value`.
|
||||||
- for the second user we will specify `{"tenant_id" : {"account_id": 0, "project_id": 1 },"extra_labels":{ "team": "dev" }}` as `Value`.
|
- for the second user we will specify `{"tenant_id" : {"account_id": 0, "project_id": 1 },"extra_labels":{ "team": "dev" }}` as `Value`.
|
||||||
<br>
|
<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/user-attributes.png" width="800"><br>
|
<img src="grafana-vmgateway-openid-configuration/user-attributes.webp" width="800"><br>
|
||||||
Click `Save`.
|
Click `Save`.
|
||||||
|
|
||||||
## Configure grafana
|
## Configure grafana
|
||||||
@ -201,7 +201,7 @@ You can also use VictoriaMetrics [Grafana datasource](https://github.com/Victori
|
|||||||
See installation instructions [here](https://github.com/VictoriaMetrics/grafana-datasource#installation).
|
See installation instructions [here](https://github.com/VictoriaMetrics/grafana-datasource#installation).
|
||||||
|
|
||||||
Enable `Forward OAuth identity` flag.<br>
|
Enable `Forward OAuth identity` flag.<br>
|
||||||
<img src="grafana-vmgateway-openid-configuration/grafana-ds.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/grafana-ds.webp" width="800">
|
||||||
|
|
||||||
Now you can use Grafana to query metrics from the specified tenant.
|
Now you can use Grafana to query metrics from the specified tenant.
|
||||||
Users with `vm_access` claim will be able to query metrics from the specified tenant.
|
Users with `vm_access` claim will be able to query metrics from the specified tenant.
|
||||||
@ -324,22 +324,22 @@ vmagent will write data into VictoriaMetrics single-node and cluster(with tenant
|
|||||||
|
|
||||||
Grafana datasources configuration will be the following:
|
Grafana datasources configuration will be the following:
|
||||||
|
|
||||||
<img src="grafana-vmgateway-openid-configuration/grafana-test-datasources.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/grafana-test-datasources.webp" width="800">
|
||||||
|
|
||||||
Let's login as user with `team=dev` labels limitation set via claims.
|
Let's login as user with `team=dev` labels limitation set via claims.
|
||||||
|
|
||||||
Using `vmgateway-cluster` results into `No data` response as proxied request will go to tenant `0:1`.
|
Using `vmgateway-cluster` results into `No data` response as proxied request will go to tenant `0:1`.
|
||||||
Since vmagent is only configured to write to `0:0` `No data` is an expected response.
|
Since vmagent is only configured to write to `0:0` `No data` is an expected response.
|
||||||
|
|
||||||
<img src="grafana-vmgateway-openid-configuration/dev-cluster-nodata.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/dev-cluster-nodata.webp" width="800">
|
||||||
|
|
||||||
Switching to `vmgateway-single` does have data. Note that it is limited to metrics with `team=dev` label.
|
Switching to `vmgateway-single` does have data. Note that it is limited to metrics with `team=dev` label.
|
||||||
|
|
||||||
<img src="grafana-vmgateway-openid-configuration/dev-single-data.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/dev-single-data.webp" width="800">
|
||||||
|
|
||||||
Now lets login as user with `team=admin`.
|
Now lets login as user with `team=admin`.
|
||||||
|
|
||||||
Both cluster and single node datasources now return metrics for `team=admin`.
|
Both cluster and single node datasources now return metrics for `team=admin`.
|
||||||
|
|
||||||
<img src="grafana-vmgateway-openid-configuration/admin-cluster-data.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/admin-cluster-data.webp" width="800">
|
||||||
<img src="grafana-vmgateway-openid-configuration/admin-single-data.png" width="800">
|
<img src="grafana-vmgateway-openid-configuration/admin-single-data.webp" width="800">
|
||||||
|
After Width: | Height: | Size: 50 KiB |
After Width: | Height: | Size: 48 KiB |
BIN
guides/grafana-vmgateway-openid-configuration/client-secret.webp
Normal file
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 9.5 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 13 KiB |
After Width: | Height: | Size: 42 KiB |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 39 KiB |
BIN
guides/grafana-vmgateway-openid-configuration/grafana-ds.webp
Normal file
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 11 KiB |
@ -82,7 +82,7 @@ These modes are mutually exclusive. A high _iowait_ means that you are disk or n
|
|||||||
|
|
||||||
The metric `node_cpu_seconds_total` is a [counter](https://docs.victoriametrics.com/keyConcepts.html#counter) type of metric. If we'd like to see how much time CPU spent in each of the nodes, we need to calculate the per-second values change via [rate function](https://docs.victoriametrics.com/MetricsQL.html#rate): `rate(node_cpu_seconds_total)`.
|
The metric `node_cpu_seconds_total` is a [counter](https://docs.victoriametrics.com/keyConcepts.html#counter) type of metric. If we'd like to see how much time CPU spent in each of the nodes, we need to calculate the per-second values change via [rate function](https://docs.victoriametrics.com/MetricsQL.html#rate): `rate(node_cpu_seconds_total)`.
|
||||||
Here is how this query may look like in Grafana:
|
Here is how this query may look like in Grafana:
|
||||||
<img alt="node_cpu_rate_graph" src="guide-vmanomaly-node-cpu-rate-graph.png">
|
<img alt="node_cpu_rate_graph" src="guide-vmanomaly-vmalert_node-cpu-rate-graph.webp">
|
||||||
|
|
||||||
This query result will generate 8 time series per each cpu, and we will use them as an input for our VM Anomaly Detection. vmanomaly will start learning configured model type separately for each of the time series.
|
This query result will generate 8 time series per each cpu, and we will use them as an input for our VM Anomaly Detection. vmanomaly will start learning configured model type separately for each of the time series.
|
||||||
|
|
||||||
@ -195,7 +195,7 @@ Now we are going to configure the `docker-compose.yml` file to run all needed se
|
|||||||
Here are all services we are going to run:
|
Here are all services we are going to run:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmanomaly-docker-compose.png" width="800" alt="Docker compose services">
|
<img src="guide-vmanomaly-vmalert_docker-compose.webp" width="800" alt="Docker compose services">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
* victoriametrics - VictoriaMetrics Time Series Database
|
* victoriametrics - VictoriaMetrics Time Series Database
|
||||||
@ -264,6 +264,7 @@ Let's wrap it all up together into the `docker-compose.yml` file.
|
|||||||
|
|
||||||
<div class="with-copy" markdown="1">
|
<div class="with-copy" markdown="1">
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
``` yaml
|
``` yaml
|
||||||
services:
|
services:
|
||||||
vmagent:
|
vmagent:
|
||||||
@ -378,13 +379,14 @@ volumes:
|
|||||||
networks:
|
networks:
|
||||||
vm_net:
|
vm_net:
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Before running our docker-compose make sure that your directory contains all required files:
|
Before running our docker-compose make sure that your directory contains all required files:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmanomaly-files.png" width="400" alt="all files">
|
<img src="guide-vmanomaly-vmalert_files.webp" width="400" alt="all files">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
This docker-compose file will pull docker images, set up each service and run them all together with the command:
|
This docker-compose file will pull docker images, set up each service and run them all together with the command:
|
||||||
@ -425,29 +427,29 @@ Each of these metrics will contain same labels our query `rate(node_cpu_seconds_
|
|||||||
### Anomaly scores for each metric with its according labels.
|
### Anomaly scores for each metric with its according labels.
|
||||||
|
|
||||||
Query: `anomaly_score`
|
Query: `anomaly_score`
|
||||||
<img alt="Anomaly score graph" src="guide-vmanomaly-anomaly-score.png">
|
<img alt="Anomaly score graph" src="guide-vmanomaly-vmalert_anomaly-score.webp">
|
||||||
|
|
||||||
<br>Check out if the anomaly score is high for datapoints you think are anomalies. If not, you can try other parameters in the config file or try other model type.
|
<br>Check out if the anomaly score is high for datapoints you think are anomalies. If not, you can try other parameters in the config file or try other model type.
|
||||||
|
|
||||||
As you may notice a lot of data shows anomaly score greater than 1. It is expected as we just started to scrape and store data and there are not enough datapoints to train on. Just wait for some more time for gathering more data to see how well this particular model can find anomalies. In our configs we put 2 days of data required.
|
As you may notice a lot of data shows anomaly score greater than 1. It is expected as we just started to scrape and store data and there are not enough datapoints to train on. Just wait for some more time for gathering more data to see how well this particular model can find anomalies. In our configs we put 2 days of data required.
|
||||||
### Actual value from input query with predicted `yhat` metric.
|
### Actual value from input query with predicted `yhat` metric.
|
||||||
Query: `yhat`
|
Query: `yhat`
|
||||||
<img alt="yhat" src="guide-vmanomaly-yhat.png">
|
<img alt="yhat" src="guide-vmanomaly-vmalert_yhat.webp">
|
||||||
|
|
||||||
<br>Here we are using one particular set of metrics for visualization. Check out the difference between model prediction and actual values. If values are very different from prediction, it can be considered as anomalous.
|
<br>Here we are using one particular set of metrics for visualization. Check out the difference between model prediction and actual values. If values are very different from prediction, it can be considered as anomalous.
|
||||||
|
|
||||||
### Lower and upper boundaries that model predicted.
|
### Lower and upper boundaries that model predicted.
|
||||||
Queries: `yhat_lower` and `yhat_upper`
|
Queries: `yhat_lower` and `yhat_upper`
|
||||||
<img alt="yhat lower and yhat upper" src="guide-vmanomaly-yhat-lower-upper.png">
|
<img alt="yhat lower and yhat upper" src="guide-vmanomaly-vmalert_yhat-lower-upper.webp">
|
||||||
Boundaries of 'normal' metric values according to model inference.
|
Boundaries of 'normal' metric values according to model inference.
|
||||||
|
|
||||||
### Alerting
|
### Alerting
|
||||||
On the page `http://localhost:8880/vmalert/groups` you can find our configured Alerting rule:
|
On the page `http://localhost:8880/vmalert/groups` you can find our configured Alerting rule:
|
||||||
|
|
||||||
<img alt="alert rule" src="guide-vmanomaly-alert-rule.png">
|
<img alt="alert rule" src="guide-vmanomaly-vmalert_alert-rule.webp">
|
||||||
|
|
||||||
According to the rule configured for vmalert we will see Alert when anomaly score exceed 1. You will see an alert on Alert tab. `http://localhost:8880/vmalert/alerts`
|
According to the rule configured for vmalert we will see Alert when anomaly score exceed 1. You will see an alert on Alert tab. `http://localhost:8880/vmalert/alerts`
|
||||||
<img alt="alerts firing" src="guide-vmanomaly-alerts-firing.png">
|
<img alt="alerts firing" src="guide-vmanomaly-vmalert_alerts-firing.webp">
|
||||||
|
|
||||||
## 10. Conclusion
|
## 10. Conclusion
|
||||||
Now we know how to set up Victoria Metric Anomaly Detection tool and use it together with vmalert. We also discovered core vmanomaly generated metrics and behaviour.
|
Now we know how to set up Victoria Metric Anomaly Detection tool and use it together with vmalert. We also discovered core vmanomaly generated metrics and behaviour.
|
||||||
|
BIN
guides/guide-vmanomaly-vmalert_alert-rule.webp
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
guides/guide-vmanomaly-vmalert_alerts-firing.webp
Normal file
After Width: | Height: | Size: 110 KiB |
BIN
guides/guide-vmanomaly-vmalert_anomaly-score.webp
Normal file
After Width: | Height: | Size: 99 KiB |
BIN
guides/guide-vmanomaly-vmalert_docker-compose.webp
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
guides/guide-vmanomaly-vmalert_files.webp
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
guides/guide-vmanomaly-vmalert_node-cpu-rate-graph.webp
Normal file
After Width: | Height: | Size: 184 KiB |
BIN
guides/guide-vmanomaly-vmalert_yhat-lower-upper.webp
Normal file
After Width: | Height: | Size: 90 KiB |
BIN
guides/guide-vmanomaly-vmalert_yhat.webp
Normal file
After Width: | Height: | Size: 105 KiB |
@ -34,7 +34,7 @@ Solution contains 3 groups of vmstorages + vminserts and one group of vmselects.
|
|||||||
The diagram below shows a proposed solution
|
The diagram below shows a proposed solution
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-multiple-retention-scheme.png" width="800">
|
<img src="guide-vmcluster-multiple-retention-setup.webp" width="800">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
**Implementation Details**
|
**Implementation Details**
|
||||||
|
BIN
guides/guide-vmcluster-multiple-retention-setup.webp
Normal file
After Width: | Height: | Size: 24 KiB |
@ -378,19 +378,19 @@ To test via Grafana, we need to install it first. [Install and connect Grafana t
|
|||||||
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-ha-explore.png" width="800" alt="grafana explore">
|
<img src="k8s-ha-monitoring-via-vm-cluster_explore.webp" width="800" alt="grafana explore">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Choose `victoriametrics` from the list of datasources and enter `count(up{kubernetes_pod_name=~".*vmselect.*"})` to the **Metric browser** field as shown on the screenshot, then press **Run query** button:
|
Choose `victoriametrics` from the list of datasources and enter `count(up{kubernetes_pod_name=~".*vmselect.*"})` to the **Metric browser** field as shown on the screenshot, then press **Run query** button:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-ha-explore-count-up.png" width="800" alt="">
|
<img src="k8s-ha-monitoring-via-vm-cluster_explore-count-up.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
The expected output is:
|
The expected output is:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-ha-explore-count-up-graph.png" width="800" alt="">
|
<img src="k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 5. High Availability
|
## 5. High Availability
|
||||||
@ -424,7 +424,7 @@ Return to Grafana Explore and press the **Run query** button again.
|
|||||||
The expected output is:
|
The expected output is:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-ha-explore-count-up-graph.png" width="800" alt="">
|
<img src="k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
As you can see, after we scaled down the `vmstorage` replicas number from three to two pods, metrics are still available and correct. The response is not partial as it was before scaling. Also we see that query `count(up{kubernetes_pod_name=~".*vmselect.*"})` returns the same value as before.
|
As you can see, after we scaled down the `vmstorage` replicas number from three to two pods, metrics are still available and correct. The response is not partial as it was before scaling. Also we see that query `count(up{kubernetes_pod_name=~".*vmselect.*"})` returns the same value as before.
|
||||||
@ -432,7 +432,7 @@ As you can see, after we scaled down the `vmstorage` replicas number from three
|
|||||||
To confirm that the number of `vmstorage` pods is equivalent to two, execute the following request in Grafana Explore:
|
To confirm that the number of `vmstorage` pods is equivalent to two, execute the following request in Grafana Explore:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-ha-explore-count-up-graph2.png" width="800" alt="">
|
<img src="k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph2.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
After Width: | Height: | Size: 20 KiB |
After Width: | Height: | Size: 21 KiB |
BIN
guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up.webp
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
guides/k8s-ha-monitoring-via-vm-cluster_explore.webp
Normal file
After Width: | Height: | Size: 15 KiB |
@ -27,7 +27,7 @@ We will use:
|
|||||||
* [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl)
|
* [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl)
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-scheme.png" width="800" alt="VictoriaMetrics Cluster on Kubernetes cluster">
|
<img src="k8s-monitoring-via-vm-cluster_scheme.webp" width="800" alt="VictoriaMetrics Cluster on Kubernetes cluster">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 1. VictoriaMetrics Helm repository
|
## 1. VictoriaMetrics Helm repository
|
||||||
@ -536,22 +536,22 @@ kubectl --namespace default port-forward $POD_NAME 3000
|
|||||||
To check that [VictoriaMetrics](https://victoriametrics.com) collects metrics from k8s cluster open in browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose the `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously got from kubectl.
|
To check that [VictoriaMetrics](https://victoriametrics.com) collects metrics from k8s cluster open in browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose the `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously got from kubectl.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-dashes-agent.png" width="800" alt="grafana dashboards">
|
<img src="k8s-monitoring-via-vm-cluster_dashes-agent.webp" width="800" alt="grafana dashboards">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
You will see something like this:
|
You will see something like this:
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-k8s-dashboard.png" width="800" alt="Kubernetes metrics provided by vmcluster">
|
<img src="k8s-monitoring-via-vm-cluster_dashboard.webp" width="800" alt="Kubernetes metrics provided by vmcluster">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
The VictoriaMetrics dashboard is also available to use:
|
The VictoriaMetrics dashboard is also available to use:
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-grafana-dash.png" width="800" alt="VictoriaMetrics cluster dashboard">
|
<img src="k8s-monitoring-via-vm-cluster_grafana-dash.webp" width="800" alt="VictoriaMetrics cluster dashboard">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
vmagent has its own dashboard:
|
vmagent has its own dashboard:
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmcluster-vmagent-grafana-dash.png" width="800" alt="vmagent dashboard">
|
<img src="k8s-monitoring-via-vm-cluster_vmagent-grafana-dash.webp" width="800" alt="vmagent dashboard">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 6. Final thoughts
|
## 6. Final thoughts
|
||||||
|
BIN
guides/k8s-monitoring-via-vm-cluster_dashboard.webp
Normal file
After Width: | Height: | Size: 60 KiB |
BIN
guides/k8s-monitoring-via-vm-cluster_dashes-agent.webp
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
guides/k8s-monitoring-via-vm-cluster_grafana-dash.webp
Normal file
After Width: | Height: | Size: 45 KiB |
BIN
guides/k8s-monitoring-via-vm-cluster_scheme.webp
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
guides/k8s-monitoring-via-vm-cluster_vmagent-grafana-dash.webp
Normal file
After Width: | Height: | Size: 44 KiB |
@ -27,7 +27,7 @@ We will use:
|
|||||||
* [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl)
|
* [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl)
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmsingle-k8s-scheme.png" width="800" alt="VictoriaMetrics Single on Kubernetes cluster">
|
<img src="k8s-monitoring-via-vm-single_k8s-scheme.webp" width="800" alt="VictoriaMetrics Single on Kubernetes cluster">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 1. VictoriaMetrics Helm repository
|
## 1. VictoriaMetrics Helm repository
|
||||||
@ -341,17 +341,17 @@ Now Grafana should be accessible on the [http://127.0.0.1:3000](http://127.0.0.1
|
|||||||
To check that VictoriaMetrics has collects metrics from the k8s cluster open in browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously obtained from kubectl.
|
To check that VictoriaMetrics has collects metrics from the k8s cluster open in browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously obtained from kubectl.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmsingle-grafana-dashboards.png" width="800" alt="">
|
<img src="k8s-monitoring-via-vm-single_grafana-dashboards.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
You will see something like this:
|
You will see something like this:
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmsingle-grafana-k8s-dashboard.png" width="800" alt="">
|
<img src="k8s-monitoring-via-vm-single_grafana-k8s-dashboard.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
VictoriaMetrics dashboard also available to use:
|
VictoriaMetrics dashboard also available to use:
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="guide-vmsingle-grafana.png" width="800" alt="">
|
<img src="k8s-monitoring-via-vm-single_grafana.webp" width="800" alt="">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 5. Final thoughts
|
## 5. Final thoughts
|
||||||
|
BIN
guides/k8s-monitoring-via-vm-single_grafana-dashboards.webp
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
guides/k8s-monitoring-via-vm-single_grafana-k8s-dashboard.webp
Normal file
After Width: | Height: | Size: 66 KiB |
BIN
guides/k8s-monitoring-via-vm-single_grafana.webp
Normal file
After Width: | Height: | Size: 53 KiB |
BIN
guides/k8s-monitoring-via-vm-single_k8s-scheme.webp
Normal file
After Width: | Height: | Size: 16 KiB |
@ -142,7 +142,7 @@ for serving read queries. This API is used in various integrations such as
|
|||||||
by [VMUI](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui) - a graphical User Interface for
|
by [VMUI](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui) - a graphical User Interface for
|
||||||
querying and visualizing metrics:
|
querying and visualizing metrics:
|
||||||
|
|
||||||
<img src="migrate-from-influx-vmui.png">
|
<img src="migrate-from-influx_vmui.webp">
|
||||||
|
|
||||||
See more about [how to query data in VictoriaMetrics](https://docs.victoriametrics.com/keyConcepts.html#query-data).
|
See more about [how to query data in VictoriaMetrics](https://docs.victoriametrics.com/keyConcepts.html#query-data).
|
||||||
|
|
||||||
@ -171,7 +171,7 @@ The data sample consists data points for a measurement `foo`
|
|||||||
and a field `bar` with additional tag `instance=localhost`. If we would like plot this data as a time series in Grafana
|
and a field `bar` with additional tag `instance=localhost`. If we would like plot this data as a time series in Grafana
|
||||||
it might have the following look:
|
it might have the following look:
|
||||||
|
|
||||||
<img src="migrate-from-influx-data-sample-in-influx.png">
|
<img src="migrate-from-influx_data-sample-in-influx.webp">
|
||||||
|
|
||||||
The query used for this panel is written in
|
The query used for this panel is written in
|
||||||
[InfluxQL](https://docs.influxdata.com/influxdb/v1.8/query_language/):
|
[InfluxQL](https://docs.influxdata.com/influxdb/v1.8/query_language/):
|
||||||
@ -206,7 +206,7 @@ InfluxQL query might be translated to MetricsQL let's break it into components f
|
|||||||
In result, executing the `foo_bar{instance="localhost"}` MetricsQL expression with `step=1m` for the same set of data in
|
In result, executing the `foo_bar{instance="localhost"}` MetricsQL expression with `step=1m` for the same set of data in
|
||||||
Grafana will have the following form:
|
Grafana will have the following form:
|
||||||
|
|
||||||
<img src="migrate-from-influx-data-sample-in-vm.png">
|
<img src="migrate-from-influx_data-sample-in-vm.webp">
|
||||||
|
|
||||||
Visualizations from both databases are a bit different - VictoriaMetrics shows some extra points
|
Visualizations from both databases are a bit different - VictoriaMetrics shows some extra points
|
||||||
filling the gaps in the graph. This behavior is described in more
|
filling the gaps in the graph. This behavior is described in more
|
||||||
|
BIN
guides/migrate-from-influx_data-sample-in-influx.webp
Normal file
After Width: | Height: | Size: 6.0 KiB |
BIN
guides/migrate-from-influx_data-sample-in-vm.webp
Normal file
After Width: | Height: | Size: 5.0 KiB |
BIN
guides/migrate-from-influx_vmui.webp
Normal file
After Width: | Height: | Size: 31 KiB |
@ -18,7 +18,7 @@ The monitoring setup is in the dedicated regions as shown below:
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img
|
<img
|
||||||
src="multi-regional-setup-dedicated-regions.png"
|
src="multi-regional-setup-dedicated-regions.webp"
|
||||||
width="800"
|
width="800"
|
||||||
alt="Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring">
|
alt="Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring">
|
||||||
</p>
|
</p>
|
||||||
|
BIN
guides/multi-regional-setup-dedicated-regions.webp
Normal file
After Width: | Height: | Size: 80 KiB |
@ -133,7 +133,7 @@ So, the `counter` metric shows the number of observed events since the service s
|
|||||||
|
|
||||||
In programming, `counter` is a variable that you **increment** each time something happens.
|
In programming, `counter` is a variable that you **increment** each time something happens.
|
||||||
|
|
||||||
<img src="keyConcepts_counter.png">
|
<img src="keyConcepts_counter.webp">
|
||||||
|
|
||||||
`vm_http_requests_total` is a typical example of a counter. The interpretation of a graph
|
`vm_http_requests_total` is a typical example of a counter. The interpretation of a graph
|
||||||
above is that time series `vm_http_requests_total{instance="localhost:8428", job="victoriametrics", path="api/v1/query_range"}`
|
above is that time series `vm_http_requests_total{instance="localhost:8428", job="victoriametrics", path="api/v1/query_range"}`
|
||||||
@ -159,7 +159,7 @@ by humans from other metric types.
|
|||||||
|
|
||||||
Gauge is used for measuring a value that can go up and down:
|
Gauge is used for measuring a value that can go up and down:
|
||||||
|
|
||||||
<img src="keyConcepts_gauge.png">
|
<img src="keyConcepts_gauge.webp">
|
||||||
|
|
||||||
The metric `process_resident_memory_anon_bytes` on the graph shows the memory usage of the application at every given time.
|
The metric `process_resident_memory_anon_bytes` on the graph shows the memory usage of the application at every given time.
|
||||||
It is changing frequently, going up and down showing how the process allocates and frees the memory.
|
It is changing frequently, going up and down showing how the process allocates and frees the memory.
|
||||||
@ -257,7 +257,7 @@ Such a combination of `counter` metrics allows
|
|||||||
plotting [Heatmaps in Grafana](https://grafana.com/docs/grafana/latest/visualizations/heatmap/)
|
plotting [Heatmaps in Grafana](https://grafana.com/docs/grafana/latest/visualizations/heatmap/)
|
||||||
and calculating [quantiles](https://prometheus.io/docs/practices/histograms/#quantiles):
|
and calculating [quantiles](https://prometheus.io/docs/practices/histograms/#quantiles):
|
||||||
|
|
||||||
<img src="keyConcepts_histogram.png">
|
<img src="keyConcepts_histogram.webp">
|
||||||
|
|
||||||
Grafana doesn't understand buckets with `vmrange` labels, so the [prometheus_buckets](https://docs.victoriametrics.com/MetricsQL.html#prometheus_buckets)
|
Grafana doesn't understand buckets with `vmrange` labels, so the [prometheus_buckets](https://docs.victoriametrics.com/MetricsQL.html#prometheus_buckets)
|
||||||
function must be used for converting buckets with `vmrange` labels to buckets with `le` labels before building heatmaps in Grafana.
|
function must be used for converting buckets with `vmrange` labels to buckets with `le` labels before building heatmaps in Grafana.
|
||||||
@ -299,7 +299,7 @@ go_gc_duration_seconds_count 83
|
|||||||
|
|
||||||
The visualisation of summaries is pretty straightforward:
|
The visualisation of summaries is pretty straightforward:
|
||||||
|
|
||||||
<img src="keyConcepts_summary.png">
|
<img src="keyConcepts_summary.webp">
|
||||||
|
|
||||||
Such an approach makes summaries easier to use but also puts significant limitations compared to [histograms](#histogram):
|
Such an approach makes summaries easier to use but also puts significant limitations compared to [histograms](#histogram):
|
||||||
|
|
||||||
@ -370,7 +370,7 @@ VictoriaMetrics supports both models used in modern monitoring applications: [pu
|
|||||||
|
|
||||||
Client regularly sends the collected metrics to the server in the push model:
|
Client regularly sends the collected metrics to the server in the push model:
|
||||||
|
|
||||||
<img src="keyConcepts_push_model.png">
|
<img src="keyConcepts_push_model.webp">
|
||||||
|
|
||||||
The client (application) decides when and where to send its metrics. VictoriaMetrics supports the following protocols
|
The client (application) decides when and where to send its metrics. VictoriaMetrics supports the following protocols
|
||||||
for data ingestion (aka `push protocols`):
|
for data ingestion (aka `push protocols`):
|
||||||
@ -430,7 +430,7 @@ The cons of push protocol:
|
|||||||
Pull model is an approach popularized by [Prometheus](https://prometheus.io/), where the monitoring system decides when
|
Pull model is an approach popularized by [Prometheus](https://prometheus.io/), where the monitoring system decides when
|
||||||
and where to pull metrics from:
|
and where to pull metrics from:
|
||||||
|
|
||||||
<img src="keyConcepts_pull_model.png">
|
<img src="keyConcepts_pull_model.webp">
|
||||||
|
|
||||||
In pull model, the monitoring system needs to be aware of all the applications it needs to monitor. The metrics are
|
In pull model, the monitoring system needs to be aware of all the applications it needs to monitor. The metrics are
|
||||||
scraped (pulled) from the known applications (aka `scrape targets`) via HTTP protocol on a regular basis (aka `scrape_interval`).
|
scraped (pulled) from the known applications (aka `scrape targets`) via HTTP protocol on a regular basis (aka `scrape_interval`).
|
||||||
@ -461,7 +461,7 @@ models for data collection. Many installations use exclusively one of these mode
|
|||||||
|
|
||||||
The most common approach for data collection is using both models:
|
The most common approach for data collection is using both models:
|
||||||
|
|
||||||
<img src="keyConcepts_data_collection.png">
|
<img src="keyConcepts_data_collection.webp">
|
||||||
|
|
||||||
In this approach the additional component is used - [vmagent](https://docs.victoriametrics.com/vmagent.html). Vmagent is
|
In this approach the additional component is used - [vmagent](https://docs.victoriametrics.com/vmagent.html). Vmagent is
|
||||||
a lightweight agent whose main purpose is to collect, filter, relabel and deliver metrics to VictoriaMetrics.
|
a lightweight agent whose main purpose is to collect, filter, relabel and deliver metrics to VictoriaMetrics.
|
||||||
@ -476,7 +476,7 @@ installation for querying collected data.
|
|||||||
|
|
||||||
VictoriaMetrics components allow building more advanced topologies. For example, vmagents can push metrics from separate datacenters to the central VictoriaMetrics:
|
VictoriaMetrics components allow building more advanced topologies. For example, vmagents can push metrics from separate datacenters to the central VictoriaMetrics:
|
||||||
|
|
||||||
<img src="keyConcepts_two_dcs.png">
|
<img src="keyConcepts_two_dcs.webp">
|
||||||
|
|
||||||
VictoriaMetrics in this example may be either [single-node VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html)
|
VictoriaMetrics in this example may be either [single-node VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html)
|
||||||
or [VictoriaMetrics Cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). Vmagent also allows
|
or [VictoriaMetrics Cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html). Vmagent also allows
|
||||||
@ -534,8 +534,8 @@ The data sample contains a list of samples for `foo_bar` time series with time i
|
|||||||
plot this data sample on the graph, it will have the following form:
|
plot this data sample on the graph, it will have the following form:
|
||||||
|
|
||||||
<p style="text-align: center">
|
<p style="text-align: center">
|
||||||
<a href="keyConcepts_data_samples.png" target="_blank">
|
<a href="keyConcepts_data_samples.webp" target="_blank">
|
||||||
<img src="keyConcepts_data_samples.png" width="500">
|
<img src="keyConcepts_data_samples.webp" width="500">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -572,8 +572,8 @@ we'll see that there is no raw sample at `2022-05-10 10:03`. What happens here i
|
|||||||
requested timestamp - VictoriaMetrics will try to locate the closest sample on the left to the requested timestamp:
|
requested timestamp - VictoriaMetrics will try to locate the closest sample on the left to the requested timestamp:
|
||||||
|
|
||||||
<p style="text-align: center">
|
<p style="text-align: center">
|
||||||
<a href="keyConcepts_instant_query.png" target="_blank">
|
<a href="keyConcepts_instant_query.webp" target="_blank">
|
||||||
<img src="keyConcepts_instant_query.png" width="500">
|
<img src="keyConcepts_instant_query.webp" width="500">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -708,8 +708,8 @@ an [instant query](#instant-query) executed `1 + (start-end)/step` times on the
|
|||||||
this request in VictoriaMetrics the graph will be shown as the following:
|
this request in VictoriaMetrics the graph will be shown as the following:
|
||||||
|
|
||||||
<p style="text-align: center">
|
<p style="text-align: center">
|
||||||
<a href="keyConcepts_range_query.png" target="_blank">
|
<a href="keyConcepts_range_query.webp" target="_blank">
|
||||||
<img src="keyConcepts_range_query.png" width="500">
|
<img src="keyConcepts_range_query.webp" width="500">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -752,12 +752,12 @@ This flag prevents from non-consistent results due to the fact that only part of
|
|||||||
|
|
||||||
Here is an illustration of a potential problem when `-search.latencyOffset` is set to zero:
|
Here is an illustration of a potential problem when `-search.latencyOffset` is set to zero:
|
||||||
|
|
||||||
<img src="keyConcepts_without_latencyOffset.png" width="1000">
|
<img src="keyConcepts_without_latencyOffset.webp" width="1000">
|
||||||
|
|
||||||
When this flag is set, the VM will return the last metric value collected before the `-search.latencyOffset`
|
When this flag is set, the VM will return the last metric value collected before the `-search.latencyOffset`
|
||||||
duration throughout the `-search.latencyOffset` duration:
|
duration throughout the `-search.latencyOffset` duration:
|
||||||
|
|
||||||
<img src="keyConcepts_with_latencyOffset.png" width="1000">
|
<img src="keyConcepts_with_latencyOffset.webp" width="1000">
|
||||||
|
|
||||||
It can be overridden on per-query basis via `latency_offset` query arg.
|
It can be overridden on per-query basis via `latency_offset` query arg.
|
||||||
|
|
||||||
@ -946,7 +946,7 @@ VictoriaMetrics has a built-in graphical User Interface for querying and visuali
|
|||||||
[VMUI](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui).
|
[VMUI](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui).
|
||||||
Open `http://victoriametrics:8428/vmui` page, type the query and see the results:
|
Open `http://victoriametrics:8428/vmui` page, type the query and see the results:
|
||||||
|
|
||||||
<img src="keyConcepts_vmui.png">
|
<img src="keyConcepts_vmui.webp">
|
||||||
|
|
||||||
VictoriaMetrics supports [Prometheus HTTP API](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#prometheus-querying-api-usage)
|
VictoriaMetrics supports [Prometheus HTTP API](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#prometheus-querying-api-usage)
|
||||||
which makes it possible to [query it with Grafana](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#grafana-setup)
|
which makes it possible to [query it with Grafana](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#grafana-setup)
|
||||||
|
BIN
keyConcepts_counter.webp
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
keyConcepts_data_collection.webp
Normal file
After Width: | Height: | Size: 6.0 KiB |
BIN
keyConcepts_data_samples.webp
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
keyConcepts_gauge.webp
Normal file
After Width: | Height: | Size: 30 KiB |
BIN
keyConcepts_histogram.webp
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
keyConcepts_instant_query.webp
Normal file
After Width: | Height: | Size: 22 KiB |
BIN
keyConcepts_pull_model.webp
Normal file
After Width: | Height: | Size: 9.2 KiB |
BIN
keyConcepts_push_model.webp
Normal file
After Width: | Height: | Size: 9.1 KiB |
BIN
keyConcepts_range_query.webp
Normal file
After Width: | Height: | Size: 41 KiB |
BIN
keyConcepts_summary.webp
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
keyConcepts_two_dcs.webp
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
keyConcepts_vmui.webp
Normal file
After Width: | Height: | Size: 22 KiB |
BIN
keyConcepts_with_latencyOffset.webp
Normal file
After Width: | Height: | Size: 360 KiB |
BIN
keyConcepts_without_latencyOffset.webp
Normal file
After Width: | Height: | Size: 334 KiB |
BIN
logo.webp
Normal file
After Width: | Height: | Size: 7.9 KiB |
@ -33,6 +33,7 @@ An example file with one alerting rule.
|
|||||||
|
|
||||||
alerts.yml
|
alerts.yml
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
groups:
|
groups:
|
||||||
- name: common
|
- name: common
|
||||||
@ -46,6 +47,7 @@ groups:
|
|||||||
summary: "{{ $labels.job }} instance: {{$labels.instance }} is not up"
|
summary: "{{ $labels.job }} instance: {{$labels.instance }} is not up"
|
||||||
description: "Job {{ $labels.job }} instance: {{$labels.instance }} is not up for the last 1 minute"
|
description: "Job {{ $labels.job }} instance: {{$labels.instance }} is not up for the last 1 minute"
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
### Managed VictoriaMetrics access token and deployment endpoint
|
### Managed VictoriaMetrics access token and deployment endpoint
|
||||||
|
|
||||||
@ -88,6 +90,7 @@ docker run -it -p 8080:8080 -v $(pwd)/alerts.yml:/etc/alerts/alerts.yml victoria
|
|||||||
|
|
||||||
##### Helm Chart
|
##### Helm Chart
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```console
|
```console
|
||||||
export TOKEN=81e8226e-****-****-****-************
|
export TOKEN=81e8226e-****-****-****-************
|
||||||
export MANAGED_VM_URL=https://gw-c15-1c.cloud.victoriametrics.com
|
export MANAGED_VM_URL=https://gw-c15-1c.cloud.victoriametrics.com
|
||||||
@ -125,6 +128,7 @@ server:
|
|||||||
description: "Job {{ $labels.job }} instance: {{$labels.instance }} is not up for the last 1 minute"
|
description: "Job {{ $labels.job }} instance: {{$labels.instance }} is not up for the last 1 minute"
|
||||||
EOF
|
EOF
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
##### VMalert CRD for vmoperator
|
##### VMalert CRD for vmoperator
|
||||||
|
|
||||||
@ -203,6 +207,7 @@ docker run -it -p 8080:8080 -v $(pwd)/alerts.yml:/etc/alerts/alerts.yml victoria
|
|||||||
|
|
||||||
##### Helm Chart
|
##### Helm Chart
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```console
|
```console
|
||||||
export TOKEN=76bc5470-****-****-****-************
|
export TOKEN=76bc5470-****-****-****-************
|
||||||
export MANAGED_VM_READ_URL=https://gw-c15-1a.cloud.victoriametrics.com/select/0/prometheus/
|
export MANAGED_VM_READ_URL=https://gw-c15-1a.cloud.victoriametrics.com/select/0/prometheus/
|
||||||
@ -241,6 +246,7 @@ server:
|
|||||||
description: "Job {{ $labels.job }} instance: {{$labels.instance }} is not up for the last 1 minute"
|
description: "Job {{ $labels.job }} instance: {{$labels.instance }} is not up for the last 1 minute"
|
||||||
EOF
|
EOF
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
##### VMalert CRD for vmoperator
|
##### VMalert CRD for vmoperator
|
||||||
|
|
||||||
|
@ -7,6 +7,9 @@ menu:
|
|||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 10
|
weight: 10
|
||||||
identifier: "operator-changelog"
|
identifier: "operator-changelog"
|
||||||
|
aliases:
|
||||||
|
- /operator/CHANGELOG.html
|
||||||
|
- /operator/changelog.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# CHANGELOG
|
# CHANGELOG
|
||||||
|
@ -7,6 +7,9 @@ menu:
|
|||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 9
|
weight: 9
|
||||||
identifier: "operator-faq"
|
identifier: "operator-faq"
|
||||||
|
aliases:
|
||||||
|
- /operator/FAQ.html
|
||||||
|
- /operator/faq.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# FAQ (Frequency Asked Questions)
|
# FAQ (Frequency Asked Questions)
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 7
|
weight: 7
|
||||||
|
aliases:
|
||||||
|
- /operator/auth.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# Authorization and exposing components
|
# Authorization and exposing components
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 4
|
weight: 4
|
||||||
|
aliases:
|
||||||
|
- /operator/configuration.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 13
|
weight: 13
|
||||||
|
aliases:
|
||||||
|
- /operator/enterprise.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# Using operator with enterprise features
|
# Using operator with enterprise features
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 8
|
weight: 8
|
||||||
|
aliases:
|
||||||
|
- /operator/high-availability.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# High Availability
|
# High Availability
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 5
|
weight: 5
|
||||||
|
aliases:
|
||||||
|
- /operator/migration.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# Migration from prometheus-operator
|
# Migration from prometheus-operator
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 6
|
weight: 6
|
||||||
|
aliases:
|
||||||
|
- /operator/monitoring.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# Monitoring of VictoriaMetrics Operator
|
# Monitoring of VictoriaMetrics Operator
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator"
|
parent: "operator"
|
||||||
weight: 1
|
weight: 1
|
||||||
|
aliases:
|
||||||
|
- /operator/quick-start.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VictoriaMetrics Operator QuickStart
|
# VictoriaMetrics Operator QuickStart
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 1
|
weight: 1
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmagent.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMAgent
|
# VMAgent
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 2
|
weight: 2
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmalert.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMAlert
|
# VMAlert
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 3
|
weight: 3
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmalertmanager.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMAlertmanager
|
# VMAlertmanager
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 4
|
weight: 4
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmalertmanagerconfig.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMAlertmanagerConfig
|
# VMAlertmanagerConfig
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 5
|
weight: 5
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmauth.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMAuth
|
# VMAuth
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 6
|
weight: 6
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmcluster.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMCluster
|
# VMCluster
|
||||||
|
@ -6,6 +6,8 @@ menu:
|
|||||||
docs:
|
docs:
|
||||||
parent: "operator-custom-resources"
|
parent: "operator-custom-resources"
|
||||||
weight: 7
|
weight: 7
|
||||||
|
aliases:
|
||||||
|
- /operator/resources/vmnodescrape.html
|
||||||
---
|
---
|
||||||
|
|
||||||
# VMNodeScrape
|
# VMNodeScrape
|
||||||
|