diff --git a/docs/anomaly-detection/FAQ.md b/docs/anomaly-detection/FAQ.md index 73d577be58..bc2dbfe74d 100644 --- a/docs/anomaly-detection/FAQ.md +++ b/docs/anomaly-detection/FAQ.md @@ -23,12 +23,14 @@ Among the metrics produced by `vmanomaly` (as detailed in [vmanomaly output metr The decision to set the changepoint at `1.0` is made to ensure consistency across various models and alerting configurations, such that a score above `1.0` consistently signifies an anomaly, thus, alerting rules are maintained more easily. -> Note: `anomaly_score` is a metric itself, which preserves all labels found in input data and (optionally) appends [custom labels, specified in writer](/anomaly-detection/components/writer.html#metrics-formatting) - follow the link detailed output example +> Note: `anomaly_score` is a metric itself, which preserves all labels found in input data and (optionally) appends [custom labels, specified in writer](/anomaly-detection/components/writer.html#metrics-formatting) - follow the link for detailed output example. ## How does vmanomaly work? `vmanomaly` applies built-in (or custom) [anomaly detection algorithms](/anomaly-detection/components/models.html), specified in a config file. Although a single config file supports one model, running multiple instances of `vmanomaly` with different configs is possible and encouraged for parallel processing or better support for your use case (i.e. simpler model for simple metrics, more sophisticated one for metrics with trends and seasonalities). -Please refer to [about](/anomaly-detection/overview.html#about) section to find out more. +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/README.md b/docs/anomaly-detection/README.md index 04e02ee3b1..f2dbdc55a1 100644 --- a/docs/anomaly-detection/README.md +++ b/docs/anomaly-detection/README.md @@ -26,7 +26,7 @@ Begin your VictoriaMetrics Anomaly Detection journey with ease using our guides ## Key Components Explore the integral components that configure VictoriaMetrics Anomaly Detection: -* [Get familiar with components](/anomaly-detection/components) +* [Explore components and their interation](/anomaly-detection/components) - [Models](/anomaly-detection/components/models.html) - [Reader](/anomaly-detection/components/reader.html) - [Scheduler](/anomaly-detection/components/scheduler.html) diff --git a/docs/anomaly-detection/components/README.md b/docs/anomaly-detection/components/README.md index e79c54c14e..0c00f65edf 100644 --- a/docs/anomaly-detection/components/README.md +++ b/docs/anomaly-detection/components/README.md @@ -21,5 +21,10 @@ This chapter describes different components, that correspond to respective secti - [Writer section](writer.html) - Required - [Monitoring section](monitoring.html) - Optional +> **Note**: starting from [v1.7.0](/anomaly-detection/CHANGELOG.html#v172), once the service starts, automated config validation is performed. Please see container logs for errors that need to be fixed to create fully valid config, visiting sections above for examples and documentation. -> **Note**: starting from [v1.7.0](../CHANGELOG.md#v172), once the service starts, automated config validation is performed. Please see container logs for errors that need to be fixed to create fully valid config, visiting sections above for examples and documentation. \ No newline at end of file +Below, you will find an example illustrating how the components of `vmanomaly` interact with each other and with a single-node VictoriaMetrics setup. + +> **Note**: [Reader](/anomaly-detection/components/reader.html#vm-reader) and [Writer](/anomaly-detection/components/writer.html#vm-writer) also support [multitenancy](/Cluster-VictoriaMetrics.html#multitenancy), so you can read/write from/to different locations - see `tenant_id` param description. + +vmanomaly-components \ No newline at end of file diff --git a/docs/anomaly-detection/components/vmanomaly-components.webp b/docs/anomaly-detection/components/vmanomaly-components.webp new file mode 100644 index 0000000000..ac9e875288 Binary files /dev/null and b/docs/anomaly-detection/components/vmanomaly-components.webp differ diff --git a/docs/anomaly-detection/components/writer.md b/docs/anomaly-detection/components/writer.md index 29a14ac360..aa8cea1880 100644 --- a/docs/anomaly-detection/components/writer.md +++ b/docs/anomaly-detection/components/writer.md @@ -12,7 +12,7 @@ aliases: # Writer -For exporting data, VictoriaMetrics Anomaly Detection (`vmanomaly`) primarily employs the [VmWriter](#vm-writer), which writes produces anomaly scores (preserving initial labelset and optionally applying additional ones) back to VictoriaMetrics. This writer is tailored for smooth data export within the VictoriaMetrics ecosystem. +For exporting data, VictoriaMetrics Anomaly Detection (`vmanomaly`) primarily employs the [VmWriter](#vm-writer), which writes produced anomaly scores **(preserving initial labelset and optionally applying additional ones)** back to VictoriaMetrics. This writer is tailored for smooth data export within the VictoriaMetrics ecosystem. Future updates will introduce additional export methods, offering users more flexibility in data handling and integration. @@ -141,7 +141,7 @@ custom_label_1: label_name_1 custom_label_2: label_name_2 ``` -Apart from specified labels, output metrics will return labels inherited from input metrics returned by [queries](/anomaly-detection/components/reader.html#config-parameters). +Apart from specified labels, output metrics will return **labels inherited from input metrics returned by [queries](/anomaly-detection/components/reader.html#config-parameters)**. For example if input data contains labels such as `cpu=1, device=eth0, instance=node-exporter:9100` all these labels will be present in vmanomaly output metrics. So if metric_format section was set up like this: diff --git a/docs/anomaly-detection/guides/README.md b/docs/anomaly-detection/guides/README.md index deabdf3998..d72bb9a944 100644 --- a/docs/anomaly-detection/guides/README.md +++ b/docs/anomaly-detection/guides/README.md @@ -16,4 +16,4 @@ This section holds guides of how to set up and use VictoriaMetrics Anomaly Detec Guides: -* [vmanomaly integration](/anomaly-detection/guides/guide-vmanomaly-vmalert.html) \ No newline at end of file +* [Anomaly Detection & Alerting Setup](/anomaly-detection/guides/guide-vmanomaly-vmalert.html) \ No newline at end of file diff --git a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md index e52a8147f0..b0d1b738bb 100644 --- a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md +++ b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md @@ -1,7 +1,7 @@ --- weight: 1 sort: 1 -title: vmanomaly integration +title: Anomaly Detection and Alerting Setup menu: docs: parent: "anomaly-detection-guides" @@ -10,9 +10,10 @@ aliases: - /anomaly-detection/guides/guide-vmanomaly-vmalert.html - /guides/guide-vmanomaly-vmalert.html - /gides/vmanomaly-integration.html +- /guides/anomaly-detection-and-alerting-setup.html --- -# vmanomaly integration +# Anomaly Detection and Alerting Setup **Prerequisites**: