diff --git a/docs/Articles.md b/docs/Articles.md index 187535c71..c26e27faa 100644 --- a/docs/Articles.md +++ b/docs/Articles.md @@ -1,5 +1,4 @@ --- -sort: 29 weight: 29 title: Articles menu: diff --git a/docs/BestPractices.md b/docs/BestPractices.md index b28d5d3c9..e073733ed 100644 --- a/docs/BestPractices.md +++ b/docs/BestPractices.md @@ -1,5 +1,4 @@ --- -sort: 32 weight: 32 title: Best practices menu: diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index e16800ac1..833250b5d 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,5 +1,4 @@ --- -sort: 100 weight: 100 title: CHANGELOG menu: diff --git a/docs/CHANGELOG_2020.md b/docs/CHANGELOG_2020.md index 7c78e9ef1..c739ef638 100644 --- a/docs/CHANGELOG_2020.md +++ b/docs/CHANGELOG_2020.md @@ -1,5 +1,4 @@ --- -sort: 6 weight: 6 title: Year 2020 menu: diff --git a/docs/CHANGELOG_2021.md b/docs/CHANGELOG_2021.md index 2e188d7b5..9dff75379 100644 --- a/docs/CHANGELOG_2021.md +++ b/docs/CHANGELOG_2021.md @@ -1,5 +1,4 @@ --- -sort: 5 weight: 5 title: Year 2021 menu: diff --git a/docs/CHANGELOG_2022.md b/docs/CHANGELOG_2022.md index 0dded827c..e04dac981 100644 --- a/docs/CHANGELOG_2022.md +++ b/docs/CHANGELOG_2022.md @@ -1,5 +1,4 @@ --- -sort: 4 weight: 4 title: Year 2022 menu: diff --git a/docs/CHANGELOG_2023.md b/docs/CHANGELOG_2023.md index 878678add..ddd85c182 100644 --- a/docs/CHANGELOG_2023.md +++ b/docs/CHANGELOG_2023.md @@ -1,5 +1,4 @@ --- -sort: 3 weight: 3 title: Year 2023 menu: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1c05fe705..f57f06e69 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,5 +1,4 @@ --- -sort: 400 weight: 400 title: Contributing menu: diff --git a/docs/CaseStudies.md b/docs/CaseStudies.md index 8624e57c8..6129bdaaa 100644 --- a/docs/CaseStudies.md +++ b/docs/CaseStudies.md @@ -1,5 +1,4 @@ --- -sort: 21 weight: 21 title: Case studies and talks menu: diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 0c00617f5..7e6b8515c 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -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") -``` \ No newline at end of file +``` diff --git a/docs/ExtendedPromQL.md b/docs/ExtendedPromQL.md index 2c81204df..cee394ad1 100644 --- a/docs/ExtendedPromQL.md +++ b/docs/ExtendedPromQL.md @@ -1,5 +1,4 @@ --- -sort: -1 # hide page from menu weight: 100 --- diff --git a/docs/FAQ.md b/docs/FAQ.md index 58444d5e6..df6bd1a9f 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,5 +1,4 @@ --- -sort: 24 weight: 24 title: FAQ menu: diff --git a/docs/LTS-releases.md b/docs/LTS-releases.md index 628be4395..e04aa1297 100644 --- a/docs/LTS-releases.md +++ b/docs/LTS-releases.md @@ -1,5 +1,4 @@ --- -sort: 300 weight: 300 title: Long-term support releases menu: diff --git a/docs/MetricsQL.md b/docs/MetricsQL.md index 64b343f53..c562b7216 100644 --- a/docs/MetricsQL.md +++ b/docs/MetricsQL.md @@ -1,5 +1,4 @@ --- -sort: 23 weight: 23 title: MetricsQL menu: diff --git a/docs/PerTenantStatistic.md b/docs/PerTenantStatistic.md index 0433f9217..9bcb91fa8 100644 --- a/docs/PerTenantStatistic.md +++ b/docs/PerTenantStatistic.md @@ -1,5 +1,4 @@ --- -sort: 31 weight: 31 title: Cluster Per Tenant Statistic menu: diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index 2985ce32a..bc95860f0 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -1,5 +1,4 @@ --- -sort: 22 weight: 22 title: Quick start menu: diff --git a/docs/Release-Guide.md b/docs/Release-Guide.md index efc637d29..98dd32e28 100644 --- a/docs/Release-Guide.md +++ b/docs/Release-Guide.md @@ -1,5 +1,4 @@ --- -sort: 30 weight: 30 title: Release process guidance menu: diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 802982930..4ab008c8a 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -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" %}} \ No newline at end of file +{{% content "README.md" %}} diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index ece608d74..9c71b30c2 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -1,5 +1,4 @@ --- -sort: 35 weight: 35 title: Troubleshooting menu: diff --git a/docs/VictoriaLogs/CHANGELOG.md b/docs/VictoriaLogs/CHANGELOG.md index 77f69001d..8f577e98b 100644 --- a/docs/VictoriaLogs/CHANGELOG.md +++ b/docs/VictoriaLogs/CHANGELOG.md @@ -1,5 +1,4 @@ --- -sort: 7 weight: 7 title: CHANGELOG menu: diff --git a/docs/VictoriaLogs/FAQ.md b/docs/VictoriaLogs/FAQ.md index 160403cff..05625cad6 100644 --- a/docs/VictoriaLogs/FAQ.md +++ b/docs/VictoriaLogs/FAQ.md @@ -1,5 +1,4 @@ --- -sort: 6 weight: 6 title: FAQ menu: diff --git a/docs/VictoriaLogs/LogsQL.md b/docs/VictoriaLogs/LogsQL.md index 1cf4d3bdb..974ba9c24 100644 --- a/docs/VictoriaLogs/LogsQL.md +++ b/docs/VictoriaLogs/LogsQL.md @@ -1,5 +1,4 @@ --- -sort: 5 weight: 5 title: LogsQL menu: diff --git a/docs/VictoriaLogs/QuickStart.md b/docs/VictoriaLogs/QuickStart.md index 31e521dad..fa4cbc9d5 100644 --- a/docs/VictoriaLogs/QuickStart.md +++ b/docs/VictoriaLogs/QuickStart.md @@ -1,5 +1,4 @@ --- -sort: 1 weight: 1 title: Quick Start menu: diff --git a/docs/VictoriaLogs/Roadmap.md b/docs/VictoriaLogs/Roadmap.md index dbe7fb6e5..3c50b8ea1 100644 --- a/docs/VictoriaLogs/Roadmap.md +++ b/docs/VictoriaLogs/Roadmap.md @@ -1,5 +1,4 @@ --- -sort: 8 weight: 8 title: Roadmap disableToc: true diff --git a/docs/VictoriaLogs/data-ingestion/_index.md b/docs/VictoriaLogs/data-ingestion/_index.md index aab116b60..d63bce1b8 100644 --- a/docs/VictoriaLogs/data-ingestion/_index.md +++ b/docs/VictoriaLogs/data-ingestion/_index.md @@ -1,5 +1,4 @@ --- -sort: 3 title: Data ingestion weight: 3 menu: diff --git a/docs/VictoriaLogs/keyConcepts.md b/docs/VictoriaLogs/keyConcepts.md index d164a9069..bdd2dc30f 100644 --- a/docs/VictoriaLogs/keyConcepts.md +++ b/docs/VictoriaLogs/keyConcepts.md @@ -1,5 +1,4 @@ --- -sort: 2 weight: 2 title: Key concepts menu: diff --git a/docs/VictoriaLogs/logsql-examples.md b/docs/VictoriaLogs/logsql-examples.md index 878b4a0e2..82782a795 100644 --- a/docs/VictoriaLogs/logsql-examples.md +++ b/docs/VictoriaLogs/logsql-examples.md @@ -1,5 +1,4 @@ --- -sort: 100 weight: 100 title: LogsQL examples menu: diff --git a/docs/VictoriaLogs/querying/_index.md b/docs/VictoriaLogs/querying/_index.md index d7078b078..ad969fb7b 100644 --- a/docs/VictoriaLogs/querying/_index.md +++ b/docs/VictoriaLogs/querying/_index.md @@ -1,5 +1,4 @@ --- -sort: 4 title: Querying weight: 4 menu: diff --git a/docs/anomaly-detection/CHANGELOG.md b/docs/anomaly-detection/CHANGELOG.md index 85869ed55..726c4ff79 100644 --- a/docs/anomaly-detection/CHANGELOG.md +++ b/docs/anomaly-detection/CHANGELOG.md @@ -1,5 +1,4 @@ --- -sort: 3 weight: 5 title: CHANGELOG menu: diff --git a/docs/anomaly-detection/FAQ.md b/docs/anomaly-detection/FAQ.md index 12c42bc2e..e88ce499c 100644 --- a/docs/anomaly-detection/FAQ.md +++ b/docs/anomaly-detection/FAQ.md @@ -1,5 +1,4 @@ --- -sort: 2 weight: 4 title: FAQ menu: diff --git a/docs/anomaly-detection/Overview.md b/docs/anomaly-detection/Overview.md index 5e2ded6ce..8bee13cb4 100644 --- a/docs/anomaly-detection/Overview.md +++ b/docs/anomaly-detection/Overview.md @@ -1,7 +1,6 @@ --- title: Overview weight: 1 -sort: 1 menu: docs: identifier: "vmanomaly-overview" diff --git a/docs/anomaly-detection/Presets.md b/docs/anomaly-detection/Presets.md index ecf7c53bd..07c389bc8 100644 --- a/docs/anomaly-detection/Presets.md +++ b/docs/anomaly-detection/Presets.md @@ -1,5 +1,4 @@ --- -sort: 3 weight: 1 title: Presets menu: diff --git a/docs/anomaly-detection/QuickStart.md b/docs/anomaly-detection/QuickStart.md index ca6149c3e..7b8b2ff8c 100644 --- a/docs/anomaly-detection/QuickStart.md +++ b/docs/anomaly-detection/QuickStart.md @@ -1,5 +1,4 @@ --- -sort: 1 weight: 1 title: VictoriaMetrics Anomaly Detection Quick Start menu: diff --git a/docs/anomaly-detection/_index.md b/docs/anomaly-detection/_index.md index c208303f0..6adb047e0 100644 --- a/docs/anomaly-detection/_index.md +++ b/docs/anomaly-detection/_index.md @@ -1,5 +1,4 @@ --- -# sort: 14 title: VictoriaMetrics Anomaly Detection weight: 0 aliases: diff --git a/docs/anomaly-detection/components/models.md b/docs/anomaly-detection/components/models.md index f62a9dcef..1c25872de 100644 --- a/docs/anomaly-detection/components/models.md +++ b/docs/anomaly-detection/components/models.md @@ -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 diff --git a/docs/anomaly-detection/components/monitoring.md b/docs/anomaly-detection/components/monitoring.md index d7c4a879f..845ca31d5 100644 --- a/docs/anomaly-detection/components/monitoring.md +++ b/docs/anomaly-detection/components/monitoring.md @@ -1,5 +1,4 @@ --- -sort: 5 title: Monitoring weight: 5 menu: diff --git a/docs/anomaly-detection/components/reader.md b/docs/anomaly-detection/components/reader.md index bbc02cfc1..883d08778 100644 --- a/docs/anomaly-detection/components/reader.md +++ b/docs/anomaly-detection/components/reader.md @@ -1,5 +1,4 @@ --- -sort: 2 title: Reader weight: 2 menu: diff --git a/docs/anomaly-detection/components/scheduler.md b/docs/anomaly-detection/components/scheduler.md index 2a006cae6..12cd7b68c 100644 --- a/docs/anomaly-detection/components/scheduler.md +++ b/docs/anomaly-detection/components/scheduler.md @@ -1,5 +1,4 @@ --- -sort: 3 title: Scheduler weight: 3 menu: diff --git a/docs/anomaly-detection/components/writer.md b/docs/anomaly-detection/components/writer.md index 6c3b9a31c..75e4595ae 100644 --- a/docs/anomaly-detection/components/writer.md +++ b/docs/anomaly-detection/components/writer.md @@ -1,5 +1,4 @@ --- -sort: 4 title: Writer weight: 4 menu: diff --git a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert/_index.md b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert/_index.md index 3725875ab..8c260af07 100644 --- a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert/_index.md +++ b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert/_index.md @@ -1,6 +1,5 @@ --- weight: 1 -sort: 1 title: Anomaly Detection and Alerting Setup menu: docs: diff --git a/docs/data-ingestion/Alloy.md b/docs/data-ingestion/Alloy.md index 02c33019f..03cbcbe17 100644 --- a/docs/data-ingestion/Alloy.md +++ b/docs/data-ingestion/Alloy.md @@ -1,7 +1,6 @@ --- title: Grafana Alloy weight: 3 -sort: 3 menu: docs: identifier: "alloy" diff --git a/docs/data-ingestion/Prometheus.md b/docs/data-ingestion/Prometheus.md index a0cc1f9bb..11773306f 100644 --- a/docs/data-ingestion/Prometheus.md +++ b/docs/data-ingestion/Prometheus.md @@ -1,7 +1,6 @@ --- title: Prometheus weight: 1 -sort: 1 menu: docs: identifier: "prometheus" diff --git a/docs/data-ingestion/Proxmox.md b/docs/data-ingestion/Proxmox.md index 44bff2dff..0c4867eb6 100644 --- a/docs/data-ingestion/Proxmox.md +++ b/docs/data-ingestion/Proxmox.md @@ -1,7 +1,6 @@ --- title: Proxmox weight: 6 -sort: 6 menu: docs: identifier: "proxmox" diff --git a/docs/data-ingestion/Telegraf.md b/docs/data-ingestion/Telegraf.md index a716d0dc2..039f626ac 100644 --- a/docs/data-ingestion/Telegraf.md +++ b/docs/data-ingestion/Telegraf.md @@ -1,7 +1,6 @@ --- title: Telegraf weight: 5 -sort: 5 menu: docs: identifier: "telegraf" diff --git a/docs/data-ingestion/Vector.md b/docs/data-ingestion/Vector.md index e2c283d69..14b7a73aa 100644 --- a/docs/data-ingestion/Vector.md +++ b/docs/data-ingestion/Vector.md @@ -1,7 +1,6 @@ --- title: Vector weight: 4 -sort: 4 menu: docs: identifier: "Vector" diff --git a/docs/data-ingestion/_index.md b/docs/data-ingestion/_index.md index 337d726c0..8111d287d 100644 --- a/docs/data-ingestion/_index.md +++ b/docs/data-ingestion/_index.md @@ -1,5 +1,4 @@ --- -# sort: 14 title: Data Ingestion weight: 0 menu: diff --git a/docs/data-ingestion/vmagent.md b/docs/data-ingestion/vmagent.md index 840cb220a..a2de629ed 100644 --- a/docs/data-ingestion/vmagent.md +++ b/docs/data-ingestion/vmagent.md @@ -1,7 +1,6 @@ --- title: vmagent weight: 2 -sort: 2 menu: docs: identifier: data-ingestion-vmagent diff --git a/docs/enterprise.md b/docs/enterprise.md index df90d623e..bb8a25f6d 100644 --- a/docs/enterprise.md +++ b/docs/enterprise.md @@ -1,5 +1,4 @@ --- -sort: 99 weight: 99 title: Enterprise menu: diff --git a/docs/goals.md b/docs/goals.md index 6ee9b6683..09fd850a2 100644 --- a/docs/goals.md +++ b/docs/goals.md @@ -1,5 +1,4 @@ --- -sort: 500 weight: 500 title: Development goals menu: diff --git a/docs/guides/guide-vmcluster-vmagent-values.yaml b/docs/guides/examples/guide-vmcluster-vmagent-values.yaml similarity index 100% rename from docs/guides/guide-vmcluster-vmagent-values.yaml rename to docs/guides/examples/guide-vmcluster-vmagent-values.yaml diff --git a/docs/guides/guide-vmsingle-values.yaml b/docs/guides/examples/guide-vmsingle-values.yaml similarity index 100% rename from docs/guides/guide-vmsingle-values.yaml rename to docs/guides/examples/guide-vmsingle-values.yaml diff --git a/docs/guides/getting-started-with-opentelemetry.md b/docs/guides/getting-started-with-opentelemetry/README.md similarity index 94% rename from docs/guides/getting-started-with-opentelemetry.md rename to docs/guides/getting-started-with-opentelemetry/README.md index eb77aefef..563d82bc0 100644 --- a/docs/guides/getting-started-with-opentelemetry.md +++ b/docs/guides/getting-started-with-opentelemetry/README.md @@ -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 diff --git a/docs/guides/getting-started-with-opentelemetry/_index.md b/docs/guides/getting-started-with-opentelemetry/_index.md new file mode 100644 index 000000000..aac03c3e0 --- /dev/null +++ b/docs/guides/getting-started-with-opentelemetry/_index.md @@ -0,0 +1,9 @@ +--- +weight: 5 +title: How to use OpenTelemetry metrics with VictoriaMetrics +menu: + docs: + parent: "guides" + weight: 5 +--- +{{% content "README.md" %}} diff --git a/docs/guides/getting-started-with-opentelemetry-app.go-collector.example b/docs/guides/getting-started-with-opentelemetry/app.go-collector.example similarity index 100% rename from docs/guides/getting-started-with-opentelemetry-app.go-collector.example rename to docs/guides/getting-started-with-opentelemetry/app.go-collector.example diff --git a/docs/guides/getting-started-with-opentelemetry-app.go.example b/docs/guides/getting-started-with-opentelemetry/app.go.example similarity index 100% rename from docs/guides/getting-started-with-opentelemetry-app.go.example rename to docs/guides/getting-started-with-opentelemetry/app.go.example diff --git a/docs/guides/getting-started-with-opentelemetry-collector.webp b/docs/guides/getting-started-with-opentelemetry/collector.webp similarity index 100% rename from docs/guides/getting-started-with-opentelemetry-collector.webp rename to docs/guides/getting-started-with-opentelemetry/collector.webp diff --git a/docs/guides/getting-started-with-opentelemetry-direct.webp b/docs/guides/getting-started-with-opentelemetry/direct.webp similarity index 100% rename from docs/guides/getting-started-with-opentelemetry-direct.webp rename to docs/guides/getting-started-with-opentelemetry/direct.webp diff --git a/docs/guides/vmui-dice-roll.webp b/docs/guides/getting-started-with-opentelemetry/vmui-dice-roll.webp similarity index 100% rename from docs/guides/vmui-dice-roll.webp rename to docs/guides/getting-started-with-opentelemetry/vmui-dice-roll.webp diff --git a/docs/guides/getting-started-with-opentelemetry-vmui.webp b/docs/guides/getting-started-with-opentelemetry/vmui.webp similarity index 100% rename from docs/guides/getting-started-with-opentelemetry-vmui.webp rename to docs/guides/getting-started-with-opentelemetry/vmui.webp diff --git a/docs/guides/getting-started-with-vm-operator.md b/docs/guides/getting-started-with-vm-operator/README.md similarity index 96% rename from docs/guides/getting-started-with-vm-operator.md rename to docs/guides/getting-started-with-vm-operator/README.md index fcd0a7d65..aad280457 100644 --- a/docs/guides/getting-started-with-vm-operator.md +++ b/docs/guides/getting-started-with-vm-operator/README.md @@ -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 diff --git a/docs/guides/getting-started-with-vm-operator/_index.md b/docs/guides/getting-started-with-vm-operator/_index.md new file mode 100644 index 000000000..f1f9e33c5 --- /dev/null +++ b/docs/guides/getting-started-with-vm-operator/_index.md @@ -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" %}} diff --git a/docs/guides/getting-started-with-vm-operator_vmcluster-grafana1.webp b/docs/guides/getting-started-with-vm-operator/vmcluster-grafana1.webp similarity index 100% rename from docs/guides/getting-started-with-vm-operator_vmcluster-grafana1.webp rename to docs/guides/getting-started-with-vm-operator/vmcluster-grafana1.webp diff --git a/docs/guides/getting-started-with-vm-operator_vmcluster-grafana2.webp b/docs/guides/getting-started-with-vm-operator/vmcluster-grafana2.webp similarity index 100% rename from docs/guides/getting-started-with-vm-operator_vmcluster-grafana2.webp rename to docs/guides/getting-started-with-vm-operator/vmcluster-grafana2.webp diff --git a/docs/guides/getting-started-with-vm-operator_vmcluster.webp b/docs/guides/getting-started-with-vm-operator/vmcluster.webp similarity index 100% rename from docs/guides/getting-started-with-vm-operator_vmcluster.webp rename to docs/guides/getting-started-with-vm-operator/vmcluster.webp diff --git a/docs/guides/guide-delete-or-replace-metrics.md b/docs/guides/guide-delete-or-replace-metrics/README.md similarity index 97% rename from docs/guides/guide-delete-or-replace-metrics.md rename to docs/guides/guide-delete-or-replace-metrics/README.md index 90bf0e4da..584df51c2 100644 --- a/docs/guides/guide-delete-or-replace-metrics.md +++ b/docs/guides/guide-delete-or-replace-metrics/README.md @@ -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. diff --git a/docs/guides/guide-delete-or-replace-metrics/_index.md b/docs/guides/guide-delete-or-replace-metrics/_index.md new file mode 100644 index 000000000..c69b230ee --- /dev/null +++ b/docs/guides/guide-delete-or-replace-metrics/_index.md @@ -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" %}} diff --git a/docs/guides/guide-vmcluster-multiple-retention-setup.md b/docs/guides/guide-vmcluster-multiple-retention-setup/README.md similarity index 92% rename from docs/guides/guide-vmcluster-multiple-retention-setup.md rename to docs/guides/guide-vmcluster-multiple-retention-setup/README.md index 74cabbdfe..3790d1cfe 100644 --- a/docs/guides/guide-vmcluster-multiple-retention-setup.md +++ b/docs/guides/guide-vmcluster-multiple-retention-setup/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** diff --git a/docs/guides/guide-vmcluster-multiple-retention-setup/_index.md b/docs/guides/guide-vmcluster-multiple-retention-setup/_index.md new file mode 100644 index 000000000..139088bf5 --- /dev/null +++ b/docs/guides/guide-vmcluster-multiple-retention-setup/_index.md @@ -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" %}} diff --git a/docs/guides/guide-vmcluster-multiple-retention-setup.webp b/docs/guides/guide-vmcluster-multiple-retention-setup/setup.webp similarity index 100% rename from docs/guides/guide-vmcluster-multiple-retention-setup.webp rename to docs/guides/guide-vmcluster-multiple-retention-setup/setup.webp diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster.md b/docs/guides/k8s-ha-monitoring-via-vm-cluster/README.md similarity index 93% rename from docs/guides/k8s-ha-monitoring-via-vm-cluster.md rename to docs/guides/k8s-ha-monitoring-via-vm-cluster/README.md index e5f792a5a..efc8c4fb8 100644 --- a/docs/guides/k8s-ha-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-ha-monitoring-via-vm-cluster/README.md @@ -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 diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster/_index.md b/docs/guides/k8s-ha-monitoring-via-vm-cluster/_index.md new file mode 100644 index 000000000..060baf935 --- /dev/null +++ b/docs/guides/k8s-ha-monitoring-via-vm-cluster/_index.md @@ -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" %}} diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph.webp b/docs/guides/k8s-ha-monitoring-via-vm-cluster/explore-count-up-graph.webp similarity index 100% rename from docs/guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph.webp rename to docs/guides/k8s-ha-monitoring-via-vm-cluster/explore-count-up-graph.webp diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph2.webp b/docs/guides/k8s-ha-monitoring-via-vm-cluster/explore-count-up-graph2.webp similarity index 100% rename from docs/guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up-graph2.webp rename to docs/guides/k8s-ha-monitoring-via-vm-cluster/explore-count-up-graph2.webp diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up.webp b/docs/guides/k8s-ha-monitoring-via-vm-cluster/explore-count-up.webp similarity index 100% rename from docs/guides/k8s-ha-monitoring-via-vm-cluster_explore-count-up.webp rename to docs/guides/k8s-ha-monitoring-via-vm-cluster/explore-count-up.webp diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster_explore.webp b/docs/guides/k8s-ha-monitoring-via-vm-cluster/explore.webp similarity index 100% rename from docs/guides/k8s-ha-monitoring-via-vm-cluster_explore.webp rename to docs/guides/k8s-ha-monitoring-via-vm-cluster/explore.webp diff --git a/docs/guides/k8s-monitoring-via-vm-cluster.md b/docs/guides/k8s-monitoring-via-vm-cluster/README.md similarity index 97% rename from docs/guides/k8s-monitoring-via-vm-cluster.md rename to docs/guides/k8s-monitoring-via-vm-cluster/README.md index e05fd3e44..083d0010d 100644 --- a/docs/guides/k8s-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-monitoring-via-vm-cluster/README.md @@ -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 diff --git a/docs/guides/k8s-monitoring-via-vm-cluster/_index.md b/docs/guides/k8s-monitoring-via-vm-cluster/_index.md new file mode 100644 index 000000000..35f981254 --- /dev/null +++ b/docs/guides/k8s-monitoring-via-vm-cluster/_index.md @@ -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" %}} diff --git a/docs/guides/k8s-monitoring-via-vm-cluster_dashboard.webp b/docs/guides/k8s-monitoring-via-vm-cluster/dashboard.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-cluster_dashboard.webp rename to docs/guides/k8s-monitoring-via-vm-cluster/dashboard.webp diff --git a/docs/guides/k8s-monitoring-via-vm-cluster_dashes-agent.webp b/docs/guides/k8s-monitoring-via-vm-cluster/dashes-agent.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-cluster_dashes-agent.webp rename to docs/guides/k8s-monitoring-via-vm-cluster/dashes-agent.webp diff --git a/docs/guides/k8s-monitoring-via-vm-cluster_vmagent-grafana-dash.webp b/docs/guides/k8s-monitoring-via-vm-cluster/grafana-dash.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-cluster_vmagent-grafana-dash.webp rename to docs/guides/k8s-monitoring-via-vm-cluster/grafana-dash.webp diff --git a/docs/guides/k8s-monitoring-via-vm-cluster_scheme.webp b/docs/guides/k8s-monitoring-via-vm-cluster/scheme.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-cluster_scheme.webp rename to docs/guides/k8s-monitoring-via-vm-cluster/scheme.webp diff --git a/docs/guides/k8s-monitoring-via-vm-cluster_grafana-dash.webp b/docs/guides/k8s-monitoring-via-vm-cluster_grafana-dash.webp deleted file mode 100644 index f1f75d42a..000000000 Binary files a/docs/guides/k8s-monitoring-via-vm-cluster_grafana-dash.webp and /dev/null differ diff --git a/docs/guides/k8s-monitoring-via-vm-single.md b/docs/guides/k8s-monitoring-via-vm-single/README.md similarity index 93% rename from docs/guides/k8s-monitoring-via-vm-single.md rename to docs/guides/k8s-monitoring-via-vm-single/README.md index 0cdfa1d70..91343e6f7 100644 --- a/docs/guides/k8s-monitoring-via-vm-single.md +++ b/docs/guides/k8s-monitoring-via-vm-single/README.md @@ -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 diff --git a/docs/guides/k8s-monitoring-via-vm-single/_index.md b/docs/guides/k8s-monitoring-via-vm-single/_index.md new file mode 100644 index 000000000..be113bf01 --- /dev/null +++ b/docs/guides/k8s-monitoring-via-vm-single/_index.md @@ -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" %}} diff --git a/docs/guides/k8s-monitoring-via-vm-single_grafana-dashboards.webp b/docs/guides/k8s-monitoring-via-vm-single/grafana-dashboards.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-single_grafana-dashboards.webp rename to docs/guides/k8s-monitoring-via-vm-single/grafana-dashboards.webp diff --git a/docs/guides/k8s-monitoring-via-vm-single_grafana-k8s-dashboard.webp b/docs/guides/k8s-monitoring-via-vm-single/grafana-k8s-dashboard.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-single_grafana-k8s-dashboard.webp rename to docs/guides/k8s-monitoring-via-vm-single/grafana-k8s-dashboard.webp diff --git a/docs/guides/k8s-monitoring-via-vm-single_grafana.webp b/docs/guides/k8s-monitoring-via-vm-single/grafana.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-single_grafana.webp rename to docs/guides/k8s-monitoring-via-vm-single/grafana.webp diff --git a/docs/guides/k8s-monitoring-via-vm-single_k8s-scheme.webp b/docs/guides/k8s-monitoring-via-vm-single/k8s-scheme.webp similarity index 100% rename from docs/guides/k8s-monitoring-via-vm-single_k8s-scheme.webp rename to docs/guides/k8s-monitoring-via-vm-single/k8s-scheme.webp diff --git a/docs/guides/migrate-from-influx.md b/docs/guides/migrate-from-influx/README.md similarity index 97% rename from docs/guides/migrate-from-influx.md rename to docs/guides/migrate-from-influx/README.md index 998051edd..27626685b 100644 --- a/docs/guides/migrate-from-influx.md +++ b/docs/guides/migrate-from-influx/README.md @@ -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 diff --git a/docs/guides/migrate-from-influx/_index.md b/docs/guides/migrate-from-influx/_index.md new file mode 100644 index 000000000..49c737c56 --- /dev/null +++ b/docs/guides/migrate-from-influx/_index.md @@ -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" %}} diff --git a/docs/guides/migrate-from-influx_data-sample-in-vm.webp b/docs/guides/migrate-from-influx/data-sample-in-vm.webp similarity index 100% rename from docs/guides/migrate-from-influx_data-sample-in-vm.webp rename to docs/guides/migrate-from-influx/data-sample-in-vm.webp diff --git a/docs/guides/migrate-from-influx_data-sample-in-influx.webp b/docs/guides/migrate-from-influx/sample-in-influx.webp similarity index 100% rename from docs/guides/migrate-from-influx_data-sample-in-influx.webp rename to docs/guides/migrate-from-influx/sample-in-influx.webp diff --git a/docs/guides/migrate-from-influx_vmui.webp b/docs/guides/migrate-from-influx/vmui.webp similarity index 100% rename from docs/guides/migrate-from-influx_vmui.webp rename to docs/guides/migrate-from-influx/vmui.webp diff --git a/docs/guides/multi-regional-setup-dedicated-regions.md b/docs/guides/multi-regional-setup-dedicated-regions/README.md similarity index 94% rename from docs/guides/multi-regional-setup-dedicated-regions.md rename to docs/guides/multi-regional-setup-dedicated-regions/README.md index f3919c48d..6c3e5391e 100644 --- a/docs/guides/multi-regional-setup-dedicated-regions.md +++ b/docs/guides/multi-regional-setup-dedicated-regions/README.md @@ -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. diff --git a/docs/guides/multi-regional-setup-dedicated-regions/_index.md b/docs/guides/multi-regional-setup-dedicated-regions/_index.md new file mode 100644 index 000000000..4121f836a --- /dev/null +++ b/docs/guides/multi-regional-setup-dedicated-regions/_index.md @@ -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" %}} diff --git a/docs/guides/multi-regional-setup-dedicated-regions.webp b/docs/guides/multi-regional-setup-dedicated-regions/setup.webp similarity index 100% rename from docs/guides/multi-regional-setup-dedicated-regions.webp rename to docs/guides/multi-regional-setup-dedicated-regions/setup.webp diff --git a/docs/guides/understand-your-setup-size.md b/docs/guides/understand-your-setup-size/README.md similarity index 98% rename from docs/guides/understand-your-setup-size.md rename to docs/guides/understand-your-setup-size/README.md index 3986e5c58..39e343212 100644 --- a/docs/guides/understand-your-setup-size.md +++ b/docs/guides/understand-your-setup-size/README.md @@ -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 diff --git a/docs/guides/understand-your-setup-size/_index.md b/docs/guides/understand-your-setup-size/_index.md new file mode 100644 index 000000000..f7004f505 --- /dev/null +++ b/docs/guides/understand-your-setup-size/_index.md @@ -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" %}} diff --git a/docs/keyConcepts.md b/docs/keyConcepts.md index 3554b5bea..2ccc83018 100644 --- a/docs/keyConcepts.md +++ b/docs/keyConcepts.md @@ -1,5 +1,4 @@ --- -sort: 34 weight: 34 title: Key concepts menu: diff --git a/docs/relabeling.md b/docs/relabeling.md index 0c95ab192..2c631f63e 100644 --- a/docs/relabeling.md +++ b/docs/relabeling.md @@ -1,5 +1,4 @@ --- -sort: 37 weight: 37 title: Relabeling cookbook menu: diff --git a/docs/scrape_config_examples.md b/docs/scrape_config_examples.md index d11037985..d70dce3c5 100644 --- a/docs/scrape_config_examples.md +++ b/docs/scrape_config_examples.md @@ -1,5 +1,4 @@ --- -sort: 200 weight: 200 title: Scrape config examples menu: diff --git a/docs/sd_configs.md b/docs/sd_configs.md index 5772fb985..7f93526f7 100644 --- a/docs/sd_configs.md +++ b/docs/sd_configs.md @@ -1,5 +1,4 @@ --- -sort: 36 weight: 36 title: Prometheus service discovery menu: diff --git a/docs/stream-aggregation.md b/docs/stream-aggregation.md index 4530358f5..5107fd4fd 100644 --- a/docs/stream-aggregation.md +++ b/docs/stream-aggregation.md @@ -1,5 +1,4 @@ --- -sort: 98 weight: 98 title: Streaming aggregation menu: diff --git a/docs/url-examples.md b/docs/url-examples.md index aed654e6f..ad09bb7c4 100644 --- a/docs/url-examples.md +++ b/docs/url-examples.md @@ -1,5 +1,4 @@ --- -sort: 33 weight: 33 title: API examples menu: diff --git a/docs/victoriametrics-cloud/_index.md b/docs/victoriametrics-cloud/_index.md index 247ae64bf..6cb7e3412 100644 --- a/docs/victoriametrics-cloud/_index.md +++ b/docs/victoriametrics-cloud/_index.md @@ -1,5 +1,4 @@ --- -sort: 28 title: VictoriaMetrics Cloud weight: 01 disableToc: true diff --git a/docs/victoriametrics-cloud/alerting-vmalert-victoria-metrics-cloud.md b/docs/victoriametrics-cloud/alerting-vmalert-victoria-metrics-cloud.md index 842d7fb47..cea29b6cf 100644 --- a/docs/victoriametrics-cloud/alerting-vmalert-victoria-metrics-cloud.md +++ b/docs/victoriametrics-cloud/alerting-vmalert-victoria-metrics-cloud.md @@ -1,5 +1,4 @@ --- -sort: 5 weight: 5 title: Alerting with vmalert and VictoriaMetrics Cloud menu: diff --git a/docs/victoriametrics-cloud/alertmanager-setup-for-deployment.md b/docs/victoriametrics-cloud/alertmanager-setup-for-deployment.md index 818348932..7dfb0e1d9 100644 --- a/docs/victoriametrics-cloud/alertmanager-setup-for-deployment.md +++ b/docs/victoriametrics-cloud/alertmanager-setup-for-deployment.md @@ -1,5 +1,4 @@ --- -sort: 4 weight: 4 title: Setup Alertmanager & VMAlert for VictoriaMetrics Cloud menu: diff --git a/docs/victoriametrics-cloud/how-to-monitor-k8s.md b/docs/victoriametrics-cloud/how-to-monitor-k8s.md index d76de2aaf..18a9c704d 100644 --- a/docs/victoriametrics-cloud/how-to-monitor-k8s.md +++ b/docs/victoriametrics-cloud/how-to-monitor-k8s.md @@ -1,5 +1,4 @@ --- -sort: 3 weight: 3 title: Kubernetes Monitoring with VictoriaMetrics Cloud menu: diff --git a/docs/victoriametrics-cloud/overview.md b/docs/victoriametrics-cloud/overview.md index cc0c806ea..f0c849422 100644 --- a/docs/victoriametrics-cloud/overview.md +++ b/docs/victoriametrics-cloud/overview.md @@ -1,5 +1,4 @@ --- -sort: 1 weight: 1 title: Overview of VictoriaMetrics Cloud menu: diff --git a/docs/victoriametrics-cloud/quickstart.md b/docs/victoriametrics-cloud/quickstart.md index cf6abda70..6cc0a3be6 100644 --- a/docs/victoriametrics-cloud/quickstart.md +++ b/docs/victoriametrics-cloud/quickstart.md @@ -1,5 +1,4 @@ --- -sort: 2 weight: 2 title: Quick Start menu: diff --git a/docs/victoriametrics-cloud/setup-notifications.md b/docs/victoriametrics-cloud/setup-notifications.md index 41d8875ab..a57db074e 100644 --- a/docs/victoriametrics-cloud/setup-notifications.md +++ b/docs/victoriametrics-cloud/setup-notifications.md @@ -1,5 +1,4 @@ --- -sort: 7 weight: 7 title: Notifications in VictoriaMetrics Cloud menu: diff --git a/docs/victoriametrics-cloud/user-managment.md b/docs/victoriametrics-cloud/user-managment.md index 13c0d2669..25811ad5c 100644 --- a/docs/victoriametrics-cloud/user-managment.md +++ b/docs/victoriametrics-cloud/user-managment.md @@ -1,5 +1,4 @@ --- -sort: 6 weight: 6 title: User Management in VictoriaMetrics Cloud menu: diff --git a/docs/vmagent.md b/docs/vmagent.md index 01f308925..30b1b452c 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -1,5 +1,4 @@ --- -sort: 3 weight: 3 menu: docs: diff --git a/docs/vmalert-tool.md b/docs/vmalert-tool.md index ff8f6821f..92235cc1d 100644 --- a/docs/vmalert-tool.md +++ b/docs/vmalert-tool.md @@ -1,5 +1,4 @@ --- -sort: 12 weight: 12 menu: docs: diff --git a/docs/vmalert.md b/docs/vmalert.md index 8c05f53a5..11ded4093 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -1,5 +1,4 @@ --- -sort: 4 weight: 4 menu: docs: diff --git a/docs/vmauth.md b/docs/vmauth.md index 9247e4881..5a798c229 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -1,5 +1,4 @@ --- -sort: 5 weight: 5 menu: docs: diff --git a/docs/vmbackup.md b/docs/vmbackup.md index 99c588675..c4344bf06 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -1,5 +1,4 @@ --- -sort: 6 weight: 6 menu: docs: diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md index ac969d965..f2f0a69d6 100644 --- a/docs/vmbackupmanager.md +++ b/docs/vmbackupmanager.md @@ -1,5 +1,4 @@ --- -sort: 10 weight: 10 menu: docs: diff --git a/docs/vmctl.md b/docs/vmctl.md index 11b652828..ff0955721 100644 --- a/docs/vmctl.md +++ b/docs/vmctl.md @@ -1,5 +1,4 @@ --- -sort: 8 weight: 8 menu: docs: diff --git a/docs/vmgateway.md b/docs/vmgateway.md index 04656656b..064c26221 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -1,5 +1,4 @@ --- -sort: 9 weight: 9 menu: docs: diff --git a/docs/vmrestore.md b/docs/vmrestore.md index 8ffcc114f..afb57d05a 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -1,5 +1,4 @@ --- -sort: 7 weight: 7 menu: docs: