github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-11 14:53:49 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/anomaly-detection/components/reader.md
Fred Navruzov 0219d34b21
docs/vmanomaly - release 1.13.0 preparation (#6436) 
### Describe Your Changes

[vmanomaly docs](https://docs.victoriametrics.com/anomaly-detection/)
update for changes, introduced in v1.13.0

### Checklist

The following checks are **mandatory**:

- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).

(cherry picked from commit 1feb5d04d7)
2024-06-11 17:05:07 +02:00

4.8 KiB
Raw Blame History

sort title weight menu aliases
2 Reader 2
docs
parent weight
vmanomaly-components 2
/anomaly-detection/components/reader.html

Reader

VictoriaMetrics Anomaly Detection (vmanomaly) primarily uses VmReader to ingest data. This reader focuses on fetching time-series data directly from VictoriaMetrics with the help of powerful MetricsQL expressions for aggregating, filtering and grouping your data, ensuring seamless integration and efficient data handling.

Future updates will introduce additional readers, expanding the range of data sources vmanomaly can work with.

VM reader

Config parameters

Parameter Example Description
class "reader.vm.VmReader" (or "vm" starting from v1.13.0) Name of the class needed to enable reading from VictoriaMetrics or Prometheus. VmReader is the default option, if not specified.
queries "ingestion_rate: 'sum(rate(vm_rows_inserted_total[5m])) by (type) > 0'" PromQL/MetricsQL query to select data in format: QUERY_ALIAS: "QUERY". As accepted by "/query_range?query=%s".
datasource_url "http://localhost:8481/" Datasource URL address
tenant_id "0:0" For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs
sampling_period "1h" Frequency of the points returned. Will be converted to "/query_range?step=%s" param (in seconds). Required since v1.9.0.
query_range_path "api/v1/query_range" Performs PromQL/MetricsQL range query. Default "api/v1/query_range"
health_path "health" Absolute or relative URL address where to check availability of the datasource. Default is "health".
user "USERNAME" BasicAuth username
password "PASSWORD" BasicAuth password
timeout "30s" Timeout for the requests, passed as a string. Defaults to "30s"
verify_tls "false" Allows disabling TLS verification of the remote certificate.
bearer_token "token" Token is passed in the standard format with header: "Authorization: bearer {token}"
extra_filters "[]" List of strings with series selector. See: Prometheus querying API enhancements

Config file example:

reader:
  class: "vm"  # or "reader.vm.VmReader" until v1.13.0
  datasource_url: "http://localhost:8428/"
  tenant_id: "0:0"
  queries:
    ingestion_rate: 'sum(rate(vm_rows_inserted_total[5m])) by (type) > 0'
  sampling_period: '1m'

Healthcheck metrics

VmReader exposes several healthchecks metrics.