docs: updated guides structure, removed deprecated sort option (#6767)

### Describe Your Changes

* `sort` param is unused by the current website engine, and was present only for compatibility
with previous website engine. It is time to remove it as it makes no effect
* re-structure guides content into folders to simplify assets management

### Checklist

The following checks are **mandatory**:

- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
This commit is contained in:
Andrii Chubatiuk 2024-08-07 17:48:08 +03:00 committed by GitHub
parent 1154f90d2d
commit 35d77a3bed
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
121 changed files with 144 additions and 207 deletions

View file

@ -1,5 +1,4 @@
--- ---
sort: 29
weight: 29 weight: 29
title: Articles title: Articles
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 32
weight: 32 weight: 32
title: Best practices title: Best practices
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 100
weight: 100 weight: 100
title: CHANGELOG title: CHANGELOG
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 6
weight: 6 weight: 6
title: Year 2020 title: Year 2020
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 5
weight: 5 weight: 5
title: Year 2021 title: Year 2021
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 4
weight: 4 weight: 4
title: Year 2022 title: Year 2022
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 3
weight: 3 weight: 3
title: Year 2023 title: Year 2023
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 400
weight: 400 weight: 400
title: Contributing title: Contributing
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 21
weight: 21 weight: 21
title: Case studies and talks title: Case studies and talks
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 2
weight: 2 weight: 2
menu: menu:
docs: docs:
@ -1896,4 +1895,4 @@ Below is the output for `/path/to/vmstorage -help`:
TCP address to accept connections from vminsert services (default ":8400") TCP address to accept connections from vminsert services (default ":8400")
-vmselectAddr string -vmselectAddr string
TCP address to accept connections from vmselect services (default ":8401") TCP address to accept connections from vmselect services (default ":8401")
``` ```

View file

@ -1,5 +1,4 @@
--- ---
sort: -1 # hide page from menu
weight: 100 weight: 100
--- ---

View file

@ -1,5 +1,4 @@
--- ---
sort: 24
weight: 24 weight: 24
title: FAQ title: FAQ
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 300
weight: 300 weight: 300
title: Long-term support releases title: Long-term support releases
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 23
weight: 23 weight: 23
title: MetricsQL title: MetricsQL
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 31
weight: 31 weight: 31
title: Cluster Per Tenant Statistic title: Cluster Per Tenant Statistic
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 22
weight: 22 weight: 22
title: Quick start title: Quick start
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 30
weight: 30 weight: 30
title: Release process guidance title: Release process guidance
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 1
weight: 1 weight: 1
menu: menu:
docs: docs:
@ -10,4 +9,4 @@ title: Single version
aliases: aliases:
- /Single-server-VictoriaMetrics.html - /Single-server-VictoriaMetrics.html
--- ---
{{% content "README.md" %}} {{% content "README.md" %}}

View file

@ -1,5 +1,4 @@
--- ---
sort: 35
weight: 35 weight: 35
title: Troubleshooting title: Troubleshooting
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 7
weight: 7 weight: 7
title: CHANGELOG title: CHANGELOG
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 6
weight: 6 weight: 6
title: FAQ title: FAQ
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 5
weight: 5 weight: 5
title: LogsQL title: LogsQL
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 1
weight: 1 weight: 1
title: Quick Start title: Quick Start
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 8
weight: 8 weight: 8
title: Roadmap title: Roadmap
disableToc: true disableToc: true

View file

@ -1,5 +1,4 @@
--- ---
sort: 3
title: Data ingestion title: Data ingestion
weight: 3 weight: 3
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 2
weight: 2 weight: 2
title: Key concepts title: Key concepts
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 100
weight: 100 weight: 100
title: LogsQL examples title: LogsQL examples
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 4
title: Querying title: Querying
weight: 4 weight: 4
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 3
weight: 5 weight: 5
title: CHANGELOG title: CHANGELOG
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 2
weight: 4 weight: 4
title: FAQ title: FAQ
menu: menu:

View file

@ -1,7 +1,6 @@
--- ---
title: Overview title: Overview
weight: 1 weight: 1
sort: 1
menu: menu:
docs: docs:
identifier: "vmanomaly-overview" identifier: "vmanomaly-overview"

View file

@ -1,5 +1,4 @@
--- ---
sort: 3
weight: 1 weight: 1
title: Presets title: Presets
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 1
weight: 1 weight: 1
title: VictoriaMetrics Anomaly Detection Quick Start title: VictoriaMetrics Anomaly Detection Quick Start
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
# sort: 14
title: VictoriaMetrics Anomaly Detection title: VictoriaMetrics Anomaly Detection
weight: 0 weight: 0
aliases: aliases:

View file

@ -1,13 +1,11 @@
--- ---
title: Models title: Models
weight: 1 weight: 1
sort: 1
menu: menu:
docs: docs:
identifier: "vmanomaly-models" identifier: "vmanomaly-models"
parent: "vmanomaly-components" parent: "vmanomaly-components"
weight: 1 weight: 1
# sort: 1
aliases: aliases:
- /anomaly-detection/components/models.html - /anomaly-detection/components/models.html
- /anomaly-detection/components/models/custom_model.html - /anomaly-detection/components/models/custom_model.html

View file

@ -1,5 +1,4 @@
--- ---
sort: 5
title: Monitoring title: Monitoring
weight: 5 weight: 5
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 2
title: Reader title: Reader
weight: 2 weight: 2
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 3
title: Scheduler title: Scheduler
weight: 3 weight: 3
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 4
title: Writer title: Writer
weight: 4 weight: 4
menu: menu:

View file

@ -1,6 +1,5 @@
--- ---
weight: 1 weight: 1
sort: 1
title: Anomaly Detection and Alerting Setup title: Anomaly Detection and Alerting Setup
menu: menu:
docs: docs:

View file

@ -1,7 +1,6 @@
--- ---
title: Grafana Alloy title: Grafana Alloy
weight: 3 weight: 3
sort: 3
menu: menu:
docs: docs:
identifier: "alloy" identifier: "alloy"

View file

@ -1,7 +1,6 @@
--- ---
title: Prometheus title: Prometheus
weight: 1 weight: 1
sort: 1
menu: menu:
docs: docs:
identifier: "prometheus" identifier: "prometheus"

View file

@ -1,7 +1,6 @@
--- ---
title: Proxmox title: Proxmox
weight: 6 weight: 6
sort: 6
menu: menu:
docs: docs:
identifier: "proxmox" identifier: "proxmox"

View file

@ -1,7 +1,6 @@
--- ---
title: Telegraf title: Telegraf
weight: 5 weight: 5
sort: 5
menu: menu:
docs: docs:
identifier: "telegraf" identifier: "telegraf"

View file

@ -1,7 +1,6 @@
--- ---
title: Vector title: Vector
weight: 4 weight: 4
sort: 4
menu: menu:
docs: docs:
identifier: "Vector" identifier: "Vector"

View file

@ -1,5 +1,4 @@
--- ---
# sort: 14
title: Data Ingestion title: Data Ingestion
weight: 0 weight: 0
menu: menu:

View file

@ -1,7 +1,6 @@
--- ---
title: vmagent title: vmagent
weight: 2 weight: 2
sort: 2
menu: menu:
docs: docs:
identifier: data-ingestion-vmagent identifier: data-ingestion-vmagent

View file

@ -1,5 +1,4 @@
--- ---
sort: 99
weight: 99 weight: 99
title: Enterprise title: Enterprise
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 500
weight: 500 weight: 500
title: Development goals title: Development goals
menu: menu:

View file

@ -1,11 +1,3 @@
---
weight: 5
title: How to use OpenTelemetry metrics with VictoriaMetrics
menu:
docs:
parent: "guides"
weight: 5
---
VictoriaMetrics supports metrics ingestion with [OpenTelemetry metrics format](https://opentelemetry.io/docs/specs/otel/metrics/). VictoriaMetrics supports metrics ingestion with [OpenTelemetry metrics format](https://opentelemetry.io/docs/specs/otel/metrics/).
This guide covers data ingestion via [opentelemetry-collector](https://opentelemetry.io/docs/collector/) and direct metrics push from application. This guide covers data ingestion via [opentelemetry-collector](https://opentelemetry.io/docs/collector/) and direct metrics push from application.
@ -44,7 +36,7 @@ Read Data:
## Using opentelemetry-collector with VictoriaMetrics ## Using opentelemetry-collector with VictoriaMetrics
![OTEL Collector](getting-started-with-opentelemetry-collector.webp) ![OTEL Collector](collector.webp)
### Deploy opentelemetry-collector and configure metrics forwarding ### Deploy opentelemetry-collector and configure metrics forwarding
@ -108,7 +100,7 @@ Metrics could be sent to VictoriaMetrics via OpenTelemetry instrumentation libra
In our example, we'll create a WEB server in [Golang](https://go.dev/) and instrument it with metrics. In our example, we'll create a WEB server in [Golang](https://go.dev/) and instrument it with metrics.
### Building the Go application instrumented with metrics ### Building the Go application instrumented with metrics
Copy the go file from [here](/guides/getting-started-with-opentelemetry-app.go-collector.example). This will give you a basic implementation of a dice roll WEB server with the urls for opentelemetry-collector pointing to localhost:4318. Copy the go file from [here](/guides/app.go-collector.example). This will give you a basic implementation of a dice roll WEB server with the urls for opentelemetry-collector pointing to localhost:4318.
In the same directory run the following command to create the `go.mod` file: In the same directory run the following command to create the `go.mod` file:
```sh ```sh
go mod init vm/otel go mod init vm/otel
@ -170,12 +162,12 @@ Metrics could be ingested into VictoriaMetrics directly with HTTP requests. You
instrumentation [clients](https://opentelemetry.io/docs/languages/). instrumentation [clients](https://opentelemetry.io/docs/languages/).
In our example, we'll create a WEB server in [Golang](https://go.dev/) and instrument it with metrics. In our example, we'll create a WEB server in [Golang](https://go.dev/) and instrument it with metrics.
![OTEL direct](getting-started-with-opentelemetry-direct.webp) ![OTEL direct](direct.webp)
### Building the Go application instrumented with metrics ### Building the Go application instrumented with metrics
See the full source code of the example [here](/guides/getting-started-with-opentelemetry-app.go.example). See the full source code of the example [here](/guides/app.go.example).
The list of OpenTelemetry dependencies for `go.mod` is the following: The list of OpenTelemetry dependencies for `go.mod` is the following:
@ -322,7 +314,7 @@ func newMetricsController(ctx context.Context) (*controller.Controller, error) {
This controller will collect and push collected metrics to VictoriaMetrics address with interval of `10s`. This controller will collect and push collected metrics to VictoriaMetrics address with interval of `10s`.
See the full source code of the example [here](/guides/getting-started-with-opentelemetry-app.go.example). See the full source code of the example [here](/guides/app.go.example).
### Test metrics ingestion ### Test metrics ingestion
@ -349,7 +341,7 @@ curl http://localhost:8081/api/slow
Open [vmui](https://docs.victoriametrics.com/#vmui) and query `http_requests_total` or `http_active_requests` Open [vmui](https://docs.victoriametrics.com/#vmui) and query `http_requests_total` or `http_active_requests`
with [metricsql](https://docs.victoriametrics.com/metricsql/). with [metricsql](https://docs.victoriametrics.com/metricsql/).
![OTEL VMUI](getting-started-with-opentelemetry-vmui.webp) ![OTEL VMUI](vmui.webp)
## Limitations ## Limitations

View file

@ -0,0 +1,9 @@
---
weight: 5
title: How to use OpenTelemetry metrics with VictoriaMetrics
menu:
docs:
parent: "guides"
weight: 5
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View file

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View file

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View file

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

View file

@ -1,13 +1,3 @@
---
weight: 4
title: Getting started with VM Operator
menu:
docs:
parent: "guides"
weight: 4
aliases:
- /guides/getting-started-with-vm-operator.html
---
**The guide covers:** **The guide covers:**
* The setup of a [VM Operator](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator) via Helm in [Kubernetes](https://kubernetes.io/) with Helm charts. * The setup of a [VM Operator](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator) via Helm in [Kubernetes](https://kubernetes.io/) with Helm charts.
@ -213,7 +203,7 @@ Forwarding from [::1]:8429 -> 8429
To check that `VMAgent` collects metrics from the k8s cluster open in the browser `http://127.0.0.1:8429/targets`. To check that `VMAgent` collects metrics from the k8s cluster open in the browser `http://127.0.0.1:8429/targets`.
You will see something like this: You will see something like this:
![VMCluster](getting-started-with-vm-operator_vmcluster.webp) ![VMCluster](vmcluster.webp)
`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)
@ -287,11 +277,11 @@ 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` 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` and choose the `VictoriaMetrics - cluster` dashboard. Use `admin` for login and the `password` that you previously got from kubectl.
![Dashboards 1](getting-started-with-vm-operator_vmcluster-grafana1.webp) ![Dashboards 1](vmcluster-grafana1.webp)
The expected output is: The expected output is:
![Dashboards 2](getting-started-with-vm-operator_vmcluster-grafana2.webp) ![Dashboards 2](vmcluster-grafana2.webp)
## 6. Summary ## 6. Summary

View file

@ -0,0 +1,11 @@
---
weight: 4
title: Getting started with VM Operator
menu:
docs:
parent: "guides"
weight: 4
aliases:
- /guides/getting-started-with-vm-operator.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View file

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 74 KiB

View file

Before

Width:  |  Height:  |  Size: 119 KiB

After

Width:  |  Height:  |  Size: 119 KiB

View file

@ -1,13 +1,3 @@
---
weight: 7
title: How to delete or replace metrics in VictoriaMetrics
menu:
docs:
parent: "guides"
weight: 7
aliases:
- /guides/guide-delete-or-replace-metrics.html
---
Data deletion is an operation people expect a database to have. [VictoriaMetrics](https://victoriametrics.com) supports Data deletion is an operation people expect a database to have. [VictoriaMetrics](https://victoriametrics.com) supports
[delete operation](https://docs.victoriametrics.com/single-server-victoriametrics/#how-to-delete-time-series) but to a limited extent. Due to implementation details, VictoriaMetrics remains an [append-only database](https://en.wikipedia.org/wiki/Append-only), which perfectly fits the case for storing time series data. But the drawback of such architecture is that it is extremely expensive to mutate the data. Hence, `delete` or `update` operations support is very limited. In this guide, we'll walk through the possible workarounds for deleting or changing already written data in VictoriaMetrics. [delete operation](https://docs.victoriametrics.com/single-server-victoriametrics/#how-to-delete-time-series) but to a limited extent. Due to implementation details, VictoriaMetrics remains an [append-only database](https://en.wikipedia.org/wiki/Append-only), which perfectly fits the case for storing time series data. But the drawback of such architecture is that it is extremely expensive to mutate the data. Hence, `delete` or `update` operations support is very limited. In this guide, we'll walk through the possible workarounds for deleting or changing already written data in VictoriaMetrics.

View file

@ -0,0 +1,11 @@
---
weight: 7
title: How to delete or replace metrics in VictoriaMetrics
menu:
docs:
parent: "guides"
weight: 7
aliases:
- /guides/guide-delete-or-replace-metrics.html
---
{{% content "README.md" %}}

View file

@ -1,13 +1,3 @@
---
weight: 10
title: Multi Retention Setup within VictoriaMetrics Cluster
menu:
docs:
parent: "guides"
weight: 10
aliases:
- /guides/guide-vmcluster-multiple-retention-setup.html
---
**Objective** **Objective**
Setup Victoria Metrics Cluster with support of multiple retention periods within one installation. Setup Victoria Metrics Cluster with support of multiple retention periods within one installation.
@ -32,7 +22,7 @@ The [-retentionPeriod](https://docs.victoriametrics.com/#retention) sets how lon
The diagram below shows a proposed solution The diagram below shows a proposed solution
![Setup](guide-vmcluster-multiple-retention-setup.webp) ![Setup](setup.webp)
**Implementation Details** **Implementation Details**

View file

@ -0,0 +1,11 @@
---
weight: 10
title: Multi Retention Setup within VictoriaMetrics Cluster
menu:
docs:
parent: "guides"
weight: 10
aliases:
- /guides/guide-vmcluster-multiple-retention-setup.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View file

@ -1,13 +1,3 @@
---
weight: 9
title: HA monitoring setup in Kubernetes via VictoriaMetrics Cluster
menu:
docs:
parent: "guides"
weight: 9
aliases:
- /guides/k8s-ha-monitoring-via-vm-cluster.html
---
**The guide covers:** **The guide covers:**
* High availability monitoring via [VictoriaMetrics cluster](https://docs.victoriametrics.com/cluster-victoriametrics/) in [Kubernetes](https://kubernetes.io/) with Helm charts * High availability monitoring via [VictoriaMetrics cluster](https://docs.victoriametrics.com/cluster-victoriametrics/) in [Kubernetes](https://kubernetes.io/) with Helm charts
@ -25,7 +15,7 @@ aliases:
## 1. VictoriaMetrics Helm repository ## 1. VictoriaMetrics Helm repository
Please see the relevant [VictoriaMetrics Helm repository](https://docs.victoriametrics.com/guides/k8s-monitoring-via-vm-cluster.html#1-victoriametrics-helm-repository) section in previous guides. Please see the relevant [VictoriaMetrics Helm repository](https://docs.victoriametrics.com/guides/k8s-monitoring-via-vm-cluster#1-victoriametrics-helm-repository) section in previous guides.
## 2. Install VictoriaMetrics Cluster from the Helm chart ## 2. Install VictoriaMetrics Cluster from the Helm chart
@ -148,7 +138,7 @@ vmcluster-victoria-metrics-cluster-vmstorage-2 1/1 Running
To scrape metrics from Kubernetes with a VictoriaMetrics Cluster we will need to install [vmagent](https://docs.victoriametrics.com/vmagent/) with some additional configurations. To do so, please run the following command: To scrape metrics from Kubernetes with a VictoriaMetrics Cluster we will need to install [vmagent](https://docs.victoriametrics.com/vmagent/) with some additional configurations. To do so, please run the following command:
```yaml ```yaml
helm install vmagent vm/victoria-metrics-agent -f https://docs.victoriametrics.com/guides/guide-vmcluster-vmagent-values.yaml helm install vmagent vm/victoria-metrics-agent -f https://docs.victoriametrics.com/guides/examples/guide-vmcluster-vmagent-values.yaml
``` ```
Here is full file content `guide-vmcluster-vmagent-values.yaml` Here is full file content `guide-vmcluster-vmagent-values.yaml`
@ -356,18 +346,18 @@ The expected output is:
The expected result of the query `count(up{kubernetes_pod_name=~".*vmselect.*"})` should be equal to `3` - the number of replicas we set via `replicaCount` parameter. The expected result of the query `count(up{kubernetes_pod_name=~".*vmselect.*"})` should be equal to `3` - the number of replicas we set via `replicaCount` parameter.
To test via Grafana, we need to install it first. [Install and connect Grafana to VictoriaMetrics](https://docs.victoriametrics.com/guides/k8s-monitoring-via-vm-cluster.html#4-install-and-connect-grafana-to-victoriametrics-with-helm), login into Grafana and open the metrics explore page at `http://127.0.0.1:3000/explore`. To test via Grafana, we need to install it first. [Install and connect Grafana to VictoriaMetrics](https://docs.victoriametrics.com/guides/k8s-monitoring-via-vm-cluster#4-install-and-connect-grafana-to-victoriametrics-with-helm), login into Grafana and open the metrics explore page at `http://127.0.0.1:3000/explore`.
![Explore](k8s-ha-monitoring-via-vm-cluster_explore.webp) ![Explore](explore.webp)
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:
![Explore count up](k8s-ha-monitoring-via-vm-cluster_explore-count-up.webp) ![Explore count up](explore-count-up.webp)
The expected output is: The expected output is:
![Explore count up graph](k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph.webp) ![Explore count up graph](explore-count-up-graph.webp)
## 5. High Availability ## 5. High Availability
@ -395,13 +385,13 @@ Return to Grafana Explore and press the **Run query** button again.
The expected output is: The expected output is:
![Explore count up graph](k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph.webp) ![Explore count up graph](explore-count-up-graph.webp)
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.
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:
![Explore count up graph 2](k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph2.webp) ![Explore count up graph 2](explore-count-up-graph2.webp)
## 6. Final thoughts ## 6. Final thoughts

View file

@ -0,0 +1,11 @@
---
weight: 9
title: HA monitoring setup in Kubernetes via VictoriaMetrics Cluster
menu:
docs:
parent: "guides"
weight: 9
aliases:
- /guides/k8s-ha-monitoring-via-vm-cluster.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View file

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View file

@ -1,13 +1,3 @@
---
weight: 3
title: Kubernetes monitoring with VictoriaMetrics Cluster
menu:
docs:
parent: "guides"
weight: 3
aliases:
- /guides/k8s-monitoring-via-vm-cluster.html
---
**This guide covers:** **This guide covers:**
* The setup of a [VictoriaMetrics cluster](https://docs.victoriametrics.com/cluster-victoriametrics/) in [Kubernetes](https://kubernetes.io/) via Helm charts * The setup of a [VictoriaMetrics cluster](https://docs.victoriametrics.com/cluster-victoriametrics/) in [Kubernetes](https://kubernetes.io/) via Helm charts
@ -23,7 +13,7 @@ We will use:
* [Helm 3 ](https://helm.sh/docs/intro/install) * [Helm 3 ](https://helm.sh/docs/intro/install)
* [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl) * [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl)
![VMCluster on K8s](k8s-monitoring-via-vm-cluster_scheme.webp) ![VMCluster on K8s](scheme.webp)
## 1. VictoriaMetrics Helm repository ## 1. VictoriaMetrics Helm repository
@ -170,7 +160,7 @@ To scrape metrics from Kubernetes with a [VictoriaMetrics cluster](https://docs.
```shell ```shell
helm install vmagent vm/victoria-metrics-agent -f https://docs.victoriametrics.com/guides/guide-vmcluster-vmagent-values.yaml helm install vmagent vm/victoria-metrics-agent -f https://docs.victoriametrics.com/guides/examples/guide-vmcluster-vmagent-values.yaml
``` ```
Here is full file content `guide-vmcluster-vmagent-values.yaml` Here is full file content `guide-vmcluster-vmagent-values.yaml`
@ -503,19 +493,19 @@ 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.
![Dashboards](k8s-monitoring-via-vm-cluster_dashes-agent.webp) ![Dashboards](dashes-agent.webp)
You will see something like this: You will see something like this:
![VMCluster metrics](k8s-monitoring-via-vm-cluster_dashboard.webp) ![VMCluster metrics](dashboard.webp)
The VictoriaMetrics dashboard is also available to use: The VictoriaMetrics dashboard is also available to use:
![VMCluster dashboard](k8s-monitoring-via-vm-cluster_grafana-dash.webp) ![VMCluster dashboard](grafana-dash.webp)
vmagent has its own dashboard: vmagent has its own dashboard:
![VMAgent dashboard](k8s-monitoring-via-vm-cluster_vmagent-grafana-dash.webp) ![VMAgent dashboard](vmagent-grafana-dash.webp)
## 6. Final thoughts ## 6. Final thoughts

View file

@ -0,0 +1,11 @@
---
weight: 3
title: Kubernetes monitoring with VictoriaMetrics Cluster
menu:
docs:
parent: "guides"
weight: 3
aliases:
- /guides/k8s-monitoring-via-vm-cluster.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

View file

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View file

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View file

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

View file

@ -1,13 +1,3 @@
---
weight: 2
title: Kubernetes monitoring via VictoriaMetrics Single
menu:
docs:
parent: "guides"
weight: 2
aliases:
- /guides/k8s-monitoring-via-vm-single.html
---
**This guide covers:** **This guide covers:**
* The setup of a [VictoriaMetrics Single](https://docs.victoriametrics.com/single-server-victoriametrics/) in [Kubernetes](https://kubernetes.io/) via Helm charts * The setup of a [VictoriaMetrics Single](https://docs.victoriametrics.com/single-server-victoriametrics/) in [Kubernetes](https://kubernetes.io/) via Helm charts
@ -23,7 +13,7 @@ We will use:
* [Helm 3 ](https://helm.sh/docs/intro/install) * [Helm 3 ](https://helm.sh/docs/intro/install)
* [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl) * [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl)
![VictoriaMetrics Single on Kubernetes cluster](k8s-monitoring-via-vm-single_k8s-scheme.webp) ![VictoriaMetrics Single on Kubernetes cluster](k8s-scheme.webp)
## 1. VictoriaMetrics Helm repository ## 1. VictoriaMetrics Helm repository
@ -68,7 +58,7 @@ vm/victoria-metrics-single 0.7.5 1.62.0 Victoria Metrics Single
Run this command in your terminal: Run this command in your terminal:
```text ```text
helm install vmsingle vm/victoria-metrics-single -f https://docs.victoriametrics.com/guides/guide-vmsingle-values.yaml helm install vmsingle vm/victoria-metrics-single -f https://docs.victoriametrics.com/guides/examples/guide-vmsingle-values.yaml
``` ```
Here is full file content `guide-vmsingle-values.yaml` Here is full file content `guide-vmsingle-values.yaml`
@ -161,7 +151,7 @@ server:
* By running `helm install vmsingle vm/victoria-metrics-single` we install [VictoriaMetrics Single](https://docs.victoriametrics.com/single-server-victoriametrics/) to default [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) inside your cluster * By running `helm install vmsingle vm/victoria-metrics-single` we install [VictoriaMetrics Single](https://docs.victoriametrics.com/single-server-victoriametrics/) to default [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) inside your cluster
* By adding `scrape: enable: true` we add and enable autodiscovery scraping from kubernetes cluster to [VictoriaMetrics Single](https://docs.victoriametrics.com/single-server-victoriametrics/) * By adding `scrape: enable: true` we add and enable autodiscovery scraping from kubernetes cluster to [VictoriaMetrics Single](https://docs.victoriametrics.com/single-server-victoriametrics/)
* On line 166 from [https://docs.victoriametrics.com/guides/guide-vmsingle-values.yaml](https://docs.victoriametrics.com/guides/guide-vmsingle-values.yaml) we added `metric_relabel_configs` section that will help us to show Kubernetes metrics on Grafana dashboard. * On line 166 from [https://docs.victoriametrics.com/guides/examples/guide-vmsingle-values.yaml](https://docs.victoriametrics.com/guides/examples/guide-vmsingle-values.yaml) we added `metric_relabel_configs` section that will help us to show Kubernetes metrics on Grafana dashboard.
As a result of the command you will see the following output: As a result of the command you will see the following output:
@ -305,15 +295,15 @@ Now Grafana should be accessible on the `http://127.0.0.1:3000` address.
To check that VictoriaMetrics has collects metrics from the k8s cluster open in browser `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` and choose `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously obtained from kubectl.
![single dashboards](k8s-monitoring-via-vm-single_grafana-dashboards.webp) ![single dashboards](grafana-dashboards.webp)
You will see something like this: You will see something like this:
![k8s dashboards](k8s-monitoring-via-vm-single_grafana-k8s-dashboard.webp) ![k8s dashboards](grafana-k8s-dashboard.webp)
VictoriaMetrics dashboard also available to use: VictoriaMetrics dashboard also available to use:
![single](k8s-monitoring-via-vm-single_grafana.webp) ![single](grafana.webp)
## 5. Final thoughts ## 5. Final thoughts

View file

@ -0,0 +1,11 @@
---
weight: 2
title: Kubernetes monitoring via VictoriaMetrics Single
menu:
docs:
parent: "guides"
weight: 2
aliases:
- /guides/k8s-monitoring-via-vm-single.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View file

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View file

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View file

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View file

@ -1,13 +1,3 @@
---
title: Migrate from InfluxDB to VictoriaMetrics
weight: 8
menu:
docs:
parent: "guides"
weight: 8
aliases:
- /guides/migrate-from-influx.html
---
InfluxDB is a well-known time series database built for InfluxDB is a well-known time series database built for
[IoT](https://en.wikipedia.org/wiki/Internet_of_things) monitoring, Application Performance Monitoring (APM) and [IoT](https://en.wikipedia.org/wiki/Internet_of_things) monitoring, Application Performance Monitoring (APM) and
analytics. It has its query language, unique data model, and rich tooling for collecting and processing metrics. analytics. It has its query language, unique data model, and rich tooling for collecting and processing metrics.
@ -140,7 +130,7 @@ for serving read queries. This API is used in various integrations such as
by [VMUI](https://docs.victoriametrics.com/single-server-victoriametrics/#vmui) - a graphical User Interface for by [VMUI](https://docs.victoriametrics.com/single-server-victoriametrics/#vmui) - a graphical User Interface for
querying and visualizing metrics: querying and visualizing metrics:
![Migrate from Influx](migrate-from-influx_vmui.webp) ![Migrate from Influx](vmui.webp)
See more about [how to query data in VictoriaMetrics](https://docs.victoriametrics.com/keyconcepts/#query-data). See more about [how to query data in VictoriaMetrics](https://docs.victoriametrics.com/keyconcepts/#query-data).
@ -169,7 +159,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:
![Data sample in Influx](migrate-from-influx_data-sample-in-influx.webp) ![Data sample in 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/):
@ -204,7 +194,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:
![Data sample in VM](migrate-from-influx_data-sample-in-vm.webp) ![Data sample in VM](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

View file

@ -0,0 +1,11 @@
---
title: Migrate from InfluxDB to VictoriaMetrics
weight: 8
menu:
docs:
parent: "guides"
weight: 8
aliases:
- /guides/migrate-from-influx.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 5 KiB

After

Width:  |  Height:  |  Size: 5 KiB

View file

Before

Width:  |  Height:  |  Size: 6 KiB

After

Width:  |  Height:  |  Size: 6 KiB

View file

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View file

@ -1,20 +1,10 @@
---
weight: 11
title: 'VictoriaMetrics Multi-Regional Setup: Dedicated Monitoring'
menu:
docs:
parent: guides
weight: 11
aliases:
- /guides/multi-regional-setup-dedicated-regions.html
---
### Scenario ### Scenario
Let's cover the case. You have multiple regions with workloads and want to collect metrics. Let's cover the case. You have multiple regions with workloads and want to collect metrics.
The monitoring setup is in the dedicated regions as shown below: The monitoring setup is in the dedicated regions as shown below:
![Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring](multi-regional-setup-dedicated-regions.webp) ![Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring](setup.webp)
Every workload region (Earth, Mars, Venus) has a vmagent that sends data to multiple regions with a monitoring setup. Every workload region (Earth, Mars, Venus) has a vmagent that sends data to multiple regions with a monitoring setup.
The monitoring setup (Ground Control 1,2) contains VictoriaMetrics Time Series Database(TSDB) cluster or single. The monitoring setup (Ground Control 1,2) contains VictoriaMetrics Time Series Database(TSDB) cluster or single.

View file

@ -0,0 +1,11 @@
---
weight: 11
title: 'VictoriaMetrics Multi-Regional Setup: Dedicated Monitoring'
menu:
docs:
parent: guides
weight: 11
aliases:
- /guides/multi-regional-setup-dedicated-regions.html
---
{{% content "README.md" %}}

View file

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 80 KiB

View file

@ -1,13 +1,3 @@
---
weight: 9
title: Understand Your Setup Size
menu:
docs:
parent: "guides"
weight: 9
aliases:
- /guides/understand-your-setup-size.html
---
The docs provide a simple and high-level overview of Ingestion Rate, Active Time Series, and Query per Second. These terms are a part of capacity planning ([Single-Node](https://docs.victoriametrics.com/single-server-victoriametrics/#capacity-planning), [Cluster](https://docs.victoriametrics.com/cluster-victoriametrics/#capacity-planning)) and [VictoriaMetrics Cloud](https://docs.victoriametrics.com/victoriametrics-cloud/) pricing. The docs provide a simple and high-level overview of Ingestion Rate, Active Time Series, and Query per Second. These terms are a part of capacity planning ([Single-Node](https://docs.victoriametrics.com/single-server-victoriametrics/#capacity-planning), [Cluster](https://docs.victoriametrics.com/cluster-victoriametrics/#capacity-planning)) and [VictoriaMetrics Cloud](https://docs.victoriametrics.com/victoriametrics-cloud/) pricing.
## Terminology ## Terminology

View file

@ -0,0 +1,11 @@
---
weight: 9
title: Understand Your Setup Size
menu:
docs:
parent: "guides"
weight: 9
aliases:
- /guides/understand-your-setup-size.html
---
{{% content "README.md" %}}

View file

@ -1,5 +1,4 @@
--- ---
sort: 34
weight: 34 weight: 34
title: Key concepts title: Key concepts
menu: menu:

View file

@ -1,5 +1,4 @@
--- ---
sort: 37
weight: 37 weight: 37
title: Relabeling cookbook title: Relabeling cookbook
menu: menu:

Some files were not shown because too many files have changed in this diff Show more