diff --git a/docs/anomaly-detection/FAQ.md b/docs/anomaly-detection/FAQ.md index bc2dbfe74..fca732a70 100644 --- a/docs/anomaly-detection/FAQ.md +++ b/docs/anomaly-detection/FAQ.md @@ -18,6 +18,8 @@ VictoriaMetrics Anomaly Detection, also known as `vmanomaly`, is a service for d Please refer to [our guide section](/anomaly-detection/#practical-guides-and-installation) to find out more. +> **Note: `vmanomaly` is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). You need to get a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.** + ## What is anomaly score? Among the metrics produced by `vmanomaly` (as detailed in [vmanomaly output metrics](/anomaly-detection/components/models.html#vmanomaly-output)), `anomaly_score` is a pivotal one. It is **a continuous score > 0**, calculated in such a way that **scores ranging from 0.0 to 1.0 usually represent normal data**, while **scores exceeding 1.0 are typically classified as anomalous**. However, it's important to note that the threshold for anomaly detection can be customized in the alert configuration settings. @@ -31,7 +33,6 @@ The decision to set the changepoint at `1.0` is made to ensure consistency acros 1. For more detailed information, please visit the [overview section](/anomaly-detection/Overview.html#about). 2. To view a diagram illustrating the interaction of components, please explore the [components section](/anomaly-detection/components/). - ## What data does vmanomaly operate on? `vmanomaly` operates on data fetched from VictoriaMetrics, where you can leverage full power of [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) for data selection, sampling, and processing. Users can also [apply global filters](https://docs.victoriametrics.com/#prometheus-querying-api-enhancements) for more targeted data analysis, enhancing scope limitation and tenant visibility. diff --git a/docs/anomaly-detection/Overview.md b/docs/anomaly-detection/Overview.md index 824ea01d2..b16d0cbe3 100644 --- a/docs/anomaly-detection/Overview.md +++ b/docs/anomaly-detection/Overview.md @@ -14,8 +14,6 @@ aliases: # Overview -**_vmanomaly_ is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). You need to request a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.** - ## About **VictoriaMetrics Anomaly Detection** (or shortly, `vmanomaly`) is a service that continuously scans VictoriaMetrics time @@ -36,6 +34,8 @@ In addition to that, setting up alerting rules manually has been proven to be te error-prone, while anomaly detection can be easier to set up, and use the same model for different metrics. +> **Note: `vmanomaly` is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). You need to get a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.** + ## How? VictoriaMetrics Anomaly Detection service (**vmanomaly**) allows you to apply several built-in diff --git a/docs/anomaly-detection/README.md b/docs/anomaly-detection/README.md index f2dbdc55a..07ae1591b 100644 --- a/docs/anomaly-detection/README.md +++ b/docs/anomaly-detection/README.md @@ -14,15 +14,15 @@ In the dynamic and complex world of system monitoring, VictoriaMetrics Anomaly D ## Practical Guides and Installation Begin your VictoriaMetrics Anomaly Detection journey with ease using our guides and installation instructions: -- **Overview**: Find out how `vmanomaly` service operates [here](/anomaly-detection/overview.html) +- **Overview**: Find out how `vmanomaly` service operates [here](/anomaly-detection/Overview.html) - **Integration**: Integrate anomaly detection into your observability ecosystem. Get started [**here**](/anomaly-detection/guides/guide-vmanomaly-vmalert.html). - **Installation Options**: Select the method that aligns with your technical requirements: - - **Docker Installation**: Suitable for containerized environments. See [Docker guide](/anomaly-detection/overview#run-vmanomaly-docker-container). + - **Docker Installation**: Suitable for containerized environments. See [Docker guide](/anomaly-detection/Overview.html#run-vmanomaly-docker-container). - **Helm Chart Installation**: Appropriate for those using Kubernetes. See our [Helm charts](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-anomaly). -> Note: starting from [v1.5.0](./CHANGELOG.md#v150) `vmanomaly` requires a [license key](/anomaly-detection/overview#licensing) to run. You can obtain a trial license key [**here**](https://victoriametrics.com/products/enterprise/trial/index.html). +> **Note**: starting from [v1.5.0](./CHANGELOG.md#v150) `vmanomaly` requires a [license key](/anomaly-detection/Overview.html#licensing) to run. You can obtain a trial license key [**here**](https://victoriametrics.com/products/enterprise/trial/index.html). ## Key Components Explore the integral components that configure VictoriaMetrics Anomaly Detection: diff --git a/docs/anomaly-detection/components/vmanomaly-components.webp b/docs/anomaly-detection/components/vmanomaly-components.webp index ac9e87528..d91c4921c 100644 Binary files a/docs/anomaly-detection/components/vmanomaly-components.webp and b/docs/anomaly-detection/components/vmanomaly-components.webp differ diff --git a/docs/vmanomaly.md b/docs/vmanomaly.md index ea44eaf2c..ed7d59c10 100644 --- a/docs/vmanomaly.md +++ b/docs/vmanomaly.md @@ -8,6 +8,6 @@ menu: weight: 11 --- -vmanomaly currently has own section. +vmanomaly currently has its own section. Please head to [Anomaly Detection section](/anomaly-detection) to find out more.