mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-01 14:47:38 +00:00
e702321cdc
### Describe Your Changes - change links from relative to absolute under Anomaly Detection section ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).
89 lines
5.2 KiB
Markdown
89 lines
5.2 KiB
Markdown
This chapter describes different components, that correspond to respective sections of a config to launch VictoriaMetrics Anomaly Detection (or simply [`vmanomaly`](https://docs.victoriametrics.com/anomaly-detection/overview/)) service:
|
|
|
|
- [Model(s) section](https://docs.victoriametrics.com/anomaly-detection/components/models/) - Required
|
|
- [Reader section](https://docs.victoriametrics.com/anomaly-detection/components/reader/) - Required
|
|
- [Scheduler(s) section](https://docs.victoriametrics.com/anomaly-detection/components/scheduler/) - Required
|
|
- [Writer section](https://docs.victoriametrics.com/anomaly-detection/components/writer/) - Required
|
|
- [Monitoring section](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/) - Optional
|
|
|
|
> **Note**: starting from [v1.7.0](https://docs.victoriametrics.com/anomaly-detection/changelog/#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.13.0](https://docs.victoriametrics.com/anomaly-detection/changelog/#v1130), components' class can be referenced by a short alias instead of a full class path - i.e. `model.zscore.ZscoreModel` becomes `zscore`, `reader.vm.VmReader` becomes `vm`, `scheduler.periodic.PeriodicScheduler` becomes `periodic`, etc. Please see according sections for the details.
|
|
|
|
> **Note:** Starting from [v1.13.0](https://docs.victoriametrics.com/anomaly-detection/changelog/#v1130) `preset` modes are available for `vmanomaly`. Please find the guide [here](https://docs.victoriametrics.com/anomaly-detection/presets/).
|
|
|
|
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](https://docs.victoriametrics.com/anomaly-detection/components/reader/#vm-reader) and [Writer](https://docs.victoriametrics.com/anomaly-detection/components/writer/#vm-writer) also support [multitenancy](https://docs.victoriametrics.com/cluster-victoriametrics/#multitenancy), so you can read/write from/to different locations - see `tenant_id` param description.
|
|
|
|
|
|
|
|
Here's a minimalistic full config example, demonstrating many-to-many configuration (actual for [latest version](https://docs.victoriametrics.com/anomaly-detection/changelog/)):
|
|
|
|
```yaml
|
|
# how and when to run the models is defined by schedulers
|
|
# https://docs.victoriametrics.com/anomaly-detection/components/scheduler/
|
|
schedulers:
|
|
periodic_1d: # alias
|
|
class: 'periodic' # scheduler class
|
|
infer_every: "30s"
|
|
fit_every: "10m"
|
|
fit_window: "24h"
|
|
periodic_1w:
|
|
class: 'periodic'
|
|
infer_every: "15m"
|
|
fit_every: "1h"
|
|
fit_window: "7d"
|
|
|
|
# what model types and with what hyperparams to run on your data
|
|
# https://docs.victoriametrics.com/anomaly-detection/components/models/
|
|
models:
|
|
zscore: # we can set up alias for model
|
|
class: 'zscore' # model class
|
|
z_threshold: 3.5
|
|
provide_series: ['anomaly_score'] # what series to produce
|
|
queries: ['host_network_receive_errors'] # what queries to run particular model on
|
|
schedulers: ['periodic_1d'] # will be attached to 1-day schedule, fit every 10m and infer every 30s
|
|
min_dev_from_expected: 0.0 # turned off. if |y - yhat| < min_dev_from_expected, anomaly score will be 0
|
|
detection_direction: 'above_expected' # detect anomalies only when y > yhat, "peaks"
|
|
prophet: # we can set up alias for model
|
|
class: 'prophet'
|
|
provide_series: ['anomaly_score', 'yhat', 'yhat_lower', 'yhat_upper']
|
|
queries: ['cpu_seconds_total']
|
|
schedulers: ['periodic_1w'] # will be attached to 1-week schedule, fit every 1h and infer every 15m
|
|
min_dev_from_expected: 0.01 # if |y - yhat| < 0.01, anomaly score will be 0
|
|
detection_direction: 'above_expected'
|
|
args: # model-specific arguments
|
|
interval_width: 0.98
|
|
|
|
# where to read data from
|
|
# https://docs.victoriametrics.com/anomaly-detection/components/reader/#vm-reader
|
|
reader:
|
|
datasource_url: "https://play.victoriametrics.com/"
|
|
tenant_id: "0:0"
|
|
class: 'vm'
|
|
sampling_period: "30s" # what data resolution to fetch from VictoriaMetrics' /query_range endpoint
|
|
latency_offset: '1ms'
|
|
query_from_last_seen_timestamp: False
|
|
queries: # aliases to MetricsQL expressions
|
|
cpu_seconds_total:
|
|
expr: 'avg(rate(node_cpu_seconds_total[5m])) by (mode)'
|
|
# step: '30s' # if not set, will be equal to sampling_period
|
|
data_range: [0, 'inf'] # expected value range, anomaly_score > 1 if y (real value) is outside
|
|
host_network_receive_errors:
|
|
expr: 'rate(node_network_receive_errs_total[3m]) / rate(node_network_receive_packets_total[3m])'
|
|
step: '15m' # here we override per-query `sampling_period` to request way less data from VM TSDB
|
|
data_range: [0, 'inf']
|
|
|
|
# where to write data to
|
|
# https://docs.victoriametrics.com/anomaly-detection/components/writer/
|
|
writer:
|
|
datasource_url: "http://victoriametrics:8428/"
|
|
|
|
# enable self-monitoring in pull and/or push mode
|
|
# https://docs.victoriametrics.com/anomaly-detection/components/monitoring/
|
|
monitoring:
|
|
pull: # Enable /metrics endpoint.
|
|
addr: "0.0.0.0"
|
|
port: 8490
|
|
```
|