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/).
(cherry picked from commit 35d77a3bed
)
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 29
|
||||
weight: 29
|
||||
title: Articles
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 32
|
||||
weight: 32
|
||||
title: Best practices
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 100
|
||||
weight: 100
|
||||
title: CHANGELOG
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 6
|
||||
weight: 6
|
||||
title: Year 2020
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 5
|
||||
weight: 5
|
||||
title: Year 2021
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 4
|
||||
weight: 4
|
||||
title: Year 2022
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 3
|
||||
weight: 3
|
||||
title: Year 2023
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 400
|
||||
weight: 400
|
||||
title: Contributing
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 21
|
||||
weight: 21
|
||||
title: Case studies and talks
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 2
|
||||
weight: 2
|
||||
menu:
|
||||
docs:
|
||||
|
@ -1896,4 +1895,4 @@ Below is the output for `/path/to/vmstorage -help`:
|
|||
TCP address to accept connections from vminsert services (default ":8400")
|
||||
-vmselectAddr string
|
||||
TCP address to accept connections from vmselect services (default ":8401")
|
||||
```
|
||||
```
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: -1 # hide page from menu
|
||||
weight: 100
|
||||
---
|
||||
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 24
|
||||
weight: 24
|
||||
title: FAQ
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 300
|
||||
weight: 300
|
||||
title: Long-term support releases
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 23
|
||||
weight: 23
|
||||
title: MetricsQL
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 31
|
||||
weight: 31
|
||||
title: Cluster Per Tenant Statistic
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 22
|
||||
weight: 22
|
||||
title: Quick start
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 30
|
||||
weight: 30
|
||||
title: Release process guidance
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 1
|
||||
weight: 1
|
||||
menu:
|
||||
docs:
|
||||
|
@ -10,4 +9,4 @@ title: Single version
|
|||
aliases:
|
||||
- /Single-server-VictoriaMetrics.html
|
||||
---
|
||||
{{% content "README.md" %}}
|
||||
{{% content "README.md" %}}
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 35
|
||||
weight: 35
|
||||
title: Troubleshooting
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 7
|
||||
weight: 7
|
||||
title: CHANGELOG
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 6
|
||||
weight: 6
|
||||
title: FAQ
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 5
|
||||
weight: 5
|
||||
title: LogsQL
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 1
|
||||
weight: 1
|
||||
title: Quick Start
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 8
|
||||
weight: 8
|
||||
title: Roadmap
|
||||
disableToc: true
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 3
|
||||
title: Data ingestion
|
||||
weight: 3
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 2
|
||||
weight: 2
|
||||
title: Key concepts
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 100
|
||||
weight: 100
|
||||
title: LogsQL examples
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 4
|
||||
title: Querying
|
||||
weight: 4
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 3
|
||||
weight: 5
|
||||
title: CHANGELOG
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 2
|
||||
weight: 4
|
||||
title: FAQ
|
||||
menu:
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Overview
|
||||
weight: 1
|
||||
sort: 1
|
||||
menu:
|
||||
docs:
|
||||
identifier: "vmanomaly-overview"
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 3
|
||||
weight: 1
|
||||
title: Presets
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 1
|
||||
weight: 1
|
||||
title: VictoriaMetrics Anomaly Detection Quick Start
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
# sort: 14
|
||||
title: VictoriaMetrics Anomaly Detection
|
||||
weight: 0
|
||||
aliases:
|
||||
|
|
|
@ -1,13 +1,11 @@
|
|||
---
|
||||
title: Models
|
||||
weight: 1
|
||||
sort: 1
|
||||
menu:
|
||||
docs:
|
||||
identifier: "vmanomaly-models"
|
||||
parent: "vmanomaly-components"
|
||||
weight: 1
|
||||
# sort: 1
|
||||
aliases:
|
||||
- /anomaly-detection/components/models.html
|
||||
- /anomaly-detection/components/models/custom_model.html
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 5
|
||||
title: Monitoring
|
||||
weight: 5
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 2
|
||||
title: Reader
|
||||
weight: 2
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 3
|
||||
title: Scheduler
|
||||
weight: 3
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 4
|
||||
title: Writer
|
||||
weight: 4
|
||||
menu:
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
---
|
||||
weight: 1
|
||||
sort: 1
|
||||
title: Anomaly Detection and Alerting Setup
|
||||
menu:
|
||||
docs:
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Grafana Alloy
|
||||
weight: 3
|
||||
sort: 3
|
||||
menu:
|
||||
docs:
|
||||
identifier: "alloy"
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Prometheus
|
||||
weight: 1
|
||||
sort: 1
|
||||
menu:
|
||||
docs:
|
||||
identifier: "prometheus"
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Proxmox
|
||||
weight: 6
|
||||
sort: 6
|
||||
menu:
|
||||
docs:
|
||||
identifier: "proxmox"
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Telegraf
|
||||
weight: 5
|
||||
sort: 5
|
||||
menu:
|
||||
docs:
|
||||
identifier: "telegraf"
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Vector
|
||||
weight: 4
|
||||
sort: 4
|
||||
menu:
|
||||
docs:
|
||||
identifier: "Vector"
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
# sort: 14
|
||||
title: Data Ingestion
|
||||
weight: 0
|
||||
menu:
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: vmagent
|
||||
weight: 2
|
||||
sort: 2
|
||||
menu:
|
||||
docs:
|
||||
identifier: data-ingestion-vmagent
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 99
|
||||
weight: 99
|
||||
title: Enterprise
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 500
|
||||
weight: 500
|
||||
title: Development goals
|
||||
menu:
|
||||
|
|
|
@ -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/).
|
||||
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
|
||||
|
||||
![OTEL Collector](getting-started-with-opentelemetry-collector.webp)
|
||||
![OTEL Collector](collector.webp)
|
||||
|
||||
### 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.
|
||||
|
||||
### 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:
|
||||
```sh
|
||||
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/).
|
||||
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
|
||||
|
||||
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:
|
||||
|
||||
|
@ -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`.
|
||||
|
||||
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
|
||||
|
||||
|
@ -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`
|
||||
with [metricsql](https://docs.victoriametrics.com/metricsql/).
|
||||
|
||||
![OTEL VMUI](getting-started-with-opentelemetry-vmui.webp)
|
||||
![OTEL VMUI](vmui.webp)
|
||||
|
||||
## Limitations
|
||||
|
9
docs/guides/getting-started-with-opentelemetry/_index.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
weight: 5
|
||||
title: How to use OpenTelemetry metrics with VictoriaMetrics
|
||||
menu:
|
||||
docs:
|
||||
parent: "guides"
|
||||
weight: 5
|
||||
---
|
||||
{{% content "README.md" %}}
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
@ -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 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`.
|
||||
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)
|
||||
|
||||
|
@ -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.
|
||||
|
||||
![Dashboards 1](getting-started-with-vm-operator_vmcluster-grafana1.webp)
|
||||
![Dashboards 1](vmcluster-grafana1.webp)
|
||||
|
||||
The expected output is:
|
||||
|
||||
![Dashboards 2](getting-started-with-vm-operator_vmcluster-grafana2.webp)
|
||||
![Dashboards 2](vmcluster-grafana2.webp)
|
||||
|
||||
## 6. Summary
|
||||
|
11
docs/guides/getting-started-with-vm-operator/_index.md
Normal 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" %}}
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
Before Width: | Height: | Size: 119 KiB After Width: | Height: | Size: 119 KiB |
|
@ -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
|
||||
[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.
|
||||
|
11
docs/guides/guide-delete-or-replace-metrics/_index.md
Normal 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" %}}
|
|
@ -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**
|
||||
|
||||
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
|
||||
|
||||
![Setup](guide-vmcluster-multiple-retention-setup.webp)
|
||||
![Setup](setup.webp)
|
||||
|
||||
**Implementation Details**
|
||||
|
|
@ -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" %}}
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
@ -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:**
|
||||
|
||||
* 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
|
||||
|
||||
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
|
||||
|
@ -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:
|
||||
|
||||
```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`
|
||||
|
@ -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.
|
||||
|
||||
|
||||
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:
|
||||
|
||||
![Explore count up](k8s-ha-monitoring-via-vm-cluster_explore-count-up.webp)
|
||||
![Explore count up](explore-count-up.webp)
|
||||
|
||||
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
|
||||
|
||||
|
@ -395,13 +385,13 @@ Return to Grafana Explore and press the **Run query** button again.
|
|||
|
||||
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.
|
||||
|
||||
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
|
11
docs/guides/k8s-ha-monitoring-via-vm-cluster/_index.md
Normal 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" %}}
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
@ -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:**
|
||||
|
||||
* 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)
|
||||
* [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
|
||||
|
||||
|
@ -170,7 +160,7 @@ To scrape metrics from Kubernetes with a [VictoriaMetrics cluster](https://docs.
|
|||
|
||||
|
||||
```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`
|
||||
|
@ -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.
|
||||
|
||||
![Dashboards](k8s-monitoring-via-vm-cluster_dashes-agent.webp)
|
||||
![Dashboards](dashes-agent.webp)
|
||||
|
||||
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:
|
||||
|
||||
![VMCluster dashboard](k8s-monitoring-via-vm-cluster_grafana-dash.webp)
|
||||
![VMCluster dashboard](grafana-dash.webp)
|
||||
|
||||
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
|
||||
|
11
docs/guides/k8s-monitoring-via-vm-cluster/_index.md
Normal 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" %}}
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 45 KiB |
|
@ -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:**
|
||||
|
||||
* 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)
|
||||
* [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
|
||||
|
||||
|
@ -68,7 +58,7 @@ vm/victoria-metrics-single 0.7.5 1.62.0 Victoria Metrics Single
|
|||
Run this command in your terminal:
|
||||
|
||||
```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`
|
||||
|
@ -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 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:
|
||||
|
@ -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.
|
||||
|
||||
![single dashboards](k8s-monitoring-via-vm-single_grafana-dashboards.webp)
|
||||
![single dashboards](grafana-dashboards.webp)
|
||||
|
||||
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:
|
||||
|
||||
![single](k8s-monitoring-via-vm-single_grafana.webp)
|
||||
![single](grafana.webp)
|
||||
|
||||
## 5. Final thoughts
|
||||
|
11
docs/guides/k8s-monitoring-via-vm-single/_index.md
Normal 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" %}}
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
@ -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
|
||||
[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.
|
||||
|
@ -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
|
||||
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).
|
||||
|
||||
|
@ -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
|
||||
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
|
||||
[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
|
||||
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
|
||||
filling the gaps in the graph. This behavior is described in more
|
11
docs/guides/migrate-from-influx/_index.md
Normal 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" %}}
|
Before Width: | Height: | Size: 5 KiB After Width: | Height: | Size: 5 KiB |
Before Width: | Height: | Size: 6 KiB After Width: | Height: | Size: 6 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
|
@ -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
|
||||
|
||||
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:
|
||||
|
||||
![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.
|
||||
The monitoring setup (Ground Control 1,2) contains VictoriaMetrics Time Series Database(TSDB) cluster or single.
|
11
docs/guides/multi-regional-setup-dedicated-regions/_index.md
Normal 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" %}}
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
|
@ -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.
|
||||
|
||||
## Terminology
|
11
docs/guides/understand-your-setup-size/_index.md
Normal 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" %}}
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 34
|
||||
weight: 34
|
||||
title: Key concepts
|
||||
menu:
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
sort: 37
|
||||
weight: 37
|
||||
title: Relabeling cookbook
|
||||
menu:
|
||||
|
|