From 7b1325c3a3bd064ae309d2c2fa884a1985c41efa Mon Sep 17 00:00:00 2001 From: Fred Navruzov Date: Tue, 23 Jan 2024 10:56:42 +0100 Subject: [PATCH] - fix 404 errors after page remaning (#5664) - slight text fixes --- docs/anomaly-detection/CHANGELOG.md | 4 ++-- docs/anomaly-detection/Overview.md | 1 + docs/anomaly-detection/guides/README.md | 2 +- .../guides/guide-vmanomaly-vmalert.md | 14 ++++++++------ 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/anomaly-detection/CHANGELOG.md b/docs/anomaly-detection/CHANGELOG.md index cfe79b711f..845ef2479c 100644 --- a/docs/anomaly-detection/CHANGELOG.md +++ b/docs/anomaly-detection/CHANGELOG.md @@ -20,14 +20,14 @@ The following `tip` changes can be tested by building from the `latest` tag: docker pull us-docker.pkg.dev/victoriametrics-test/public/vmanomaly-trial:latest ``` -Please find [launch instructions here](/anomaly-detection/overview.html#run-vmanomaly-docker-container). +Please find [launch instructions here](/anomaly-detection/Overview.html#run-vmanomaly-docker-container). # tip ## v1.8.0 Released: 2024-01-15 -- FEATURE: Added Univariate [MAD (median absolute deviation)](/anomaly-detection/components/models.md#mad-median-absolute-deviation) model support. +- FEATURE: Added Univariate [MAD (median absolute deviation)](/anomaly-detection/components/models.html#mad-median-absolute-deviation) model support. - IMPROVEMENT: Update Python to 3.12.1 and all the dependencies. - IMPROVEMENT: Don't check /health endpoint, check the real /query_range or /import endpoints directly. Users kept getting problems with /health. - DEPRECATION: "health_path" param is deprecated and doesn't do anything in config ([reader](/anomaly-detection/components/reader.html#vm-reader), [writer](/anomaly-detection/components/writer.html#vm-writer), [monitoring.push](/anomaly-detection/components/monitoring.html#push-config-parameters)). diff --git a/docs/anomaly-detection/Overview.md b/docs/anomaly-detection/Overview.md index b16d0cbe31..993cffb29d 100644 --- a/docs/anomaly-detection/Overview.md +++ b/docs/anomaly-detection/Overview.md @@ -9,6 +9,7 @@ menu: weight: 1 aliases: - /anomaly-detection.html +- /anomaly-detection/overview.html --- diff --git a/docs/anomaly-detection/guides/README.md b/docs/anomaly-detection/guides/README.md index d72bb9a944..ace726f761 100644 --- a/docs/anomaly-detection/guides/README.md +++ b/docs/anomaly-detection/guides/README.md @@ -12,7 +12,7 @@ aliases: # Guides -This section holds guides of how to set up and use VictoriaMetrics Anomaly Detection (or simply [`vmanomaly`](/anomaly-detection/overview.html)) service, integrating it with different observability components. +This section holds guides of how to set up and use VictoriaMetrics Anomaly Detection (or simply [`vmanomaly`](/anomaly-detection/Overview.html)) service, integrating it with different observability components. Guides: diff --git a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md index b0d1b738bb..fcedc81b98 100644 --- a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md +++ b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md @@ -32,7 +32,7 @@ aliases: ## 1. What is vmanomaly? -*VictoriaMetrics Anomaly Detection* ([vmanomaly](https://docs.victoriametrics.com/anomaly-detection/overview.html)) is a service that continuously scans time series stored in VictoriaMetrics and detects unexpected changes within data patterns in real-time. It does so by utilizing user-configurable machine learning models. +*VictoriaMetrics Anomaly Detection* ([vmanomaly](https://docs.victoriametrics.com/anomaly-detection/Overview.html)) is a service that continuously scans time series stored in VictoriaMetrics and detects unexpected changes within data patterns in real-time. It does so by utilizing user-configurable machine learning models. All the service parameters are defined in a config file. @@ -67,8 +67,8 @@ Compared to classical alerting rules, anomaly detection is more "hands-off" and Practical use case is to put anomaly score generated by vmanomaly into alerting rules with some threshold. **In this tutorial we are going to:** - - Configure docker-compose file with all needed services ([VictoriaMetrics Single-Node](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html), [vmalert](https://docs.victoriametrics.com/vmalert.html), [vmagent](https://docs.victoriametrics.com/vmagent.html), [Grafana](https://grafana.com/), [Node Exporter](https://prometheus.io/docs/guides/node-exporter/) and [vmanomaly](https://docs.victoriametrics.com/anomaly-detection/overview.html) ). - - Explore configuration files for [vmanomaly](https://docs.victoriametrics.com/anomaly-detection/overview.html) and [vmalert](https://docs.victoriametrics.com/vmalert.html). + - Configure docker-compose file with all needed services ([VictoriaMetrics Single-Node](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html), [vmalert](https://docs.victoriametrics.com/vmalert.html), [vmagent](https://docs.victoriametrics.com/vmagent.html), [Grafana](https://grafana.com/), [Node Exporter](https://prometheus.io/docs/guides/node-exporter/) and [vmanomaly](https://docs.victoriametrics.com/anomaly-detection/Overview.html) ). + - Explore configuration files for [vmanomaly](https://docs.victoriametrics.com/anomaly-detection/Overview.html) and [vmalert](https://docs.victoriametrics.com/vmalert.html). - Run our own [VictoriaMetrics](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html) database with data scraped from [Node Exporter](https://prometheus.io/docs/guides/node-exporter/). - Explore data for analysis in [Grafana](https://grafana.com/). - Explore `vmanomaly` results. @@ -271,10 +271,12 @@ scrape_configs: -### vmanomaly licencing +### vmanomaly licensing + +We will utilize the license key stored locally in the file `vmanomaly_license.txt`. + +For additional licensing options, please refer to the [VictoriaMetrics Anomaly Detection documentation on licensing](https://docs.victoriametrics.com/anomaly-detection/Overview#licensing). -We are going to use license stored locally in file `vmanomaly_license.txt` with key in it. -You can explore other license options [here](https://docs.victoriametrics.com/anomaly-detection/overview#licensing) ### Alertmanager setup