For exporting data, VictoriaMetrics Anomaly Detection (vmanomaly
) primarily employs the VmWriter, 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.
VM writer #
Config parameters #
Parameter | Example | Description |
---|---|---|
|
| Name of the class needed to enable writing to VictoriaMetrics or Prometheus. VmWriter is the default option, if not specified. |
|
| Datasource URL address |
|
| For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs |
|
| Metrics to save the output (in metric names or labels). Must have
|
| ||
| ||
| ||
|
| Optional, to override the default import path |
|
| Absolute or relative URL address where to check the availability of the datasource. Optional, to override the default |
|
| BasicAuth username |
|
| BasicAuth password |
|
| Timeout for the requests, passed as a string |
|
| Allows disabling TLS verification of the remote certificate. |
bearer_token | token | Token is passed in the standard format with header: Authorization: bearer {token} |
bearer_token_file | path_to_file | Path to a file, which contains token, that is passed in the standard format with header: Authorization: bearer {token} . Available since v1.15.9 |
Config example:
writer:
class: "vm" # or "writer.vm.VmWriter" until v1.13.0
datasource_url: "http://localhost:8428/"
tenant_id: "0:0"
metric_format:
__name__: "vmanomaly_$VAR"
for: "$QUERY_KEY"
run: "test_metric_format"
config: "io_vm_single.yaml"
import_json_path: "/api/v1/import"
health_path: "health"
user: "foo"
password: "bar"
Healthcheck metrics #
VmWriter
exposes several healthchecks metrics.
Metrics formatting #
There should be 2 mandatory parameters set in metric_format
- __name__
and for
.
__name__: PREFIX1_$VAR
for: PREFIX2_$QUERY_KEY
- for
__name__
parameter it will name metrics returned by models asPREFIX1_anomaly_score
,PREFIX1_yhat_lower
, etc. Vmanomaly output metrics names described here - for
for
parameter will add labelsPREFIX2_query_name_1
,PREFIX2_query_name_2
, etc. Query names are set as aliases in configreader
section inqueries
parameter.
It is possible to specify other custom label names needed. For example:
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.
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:
metric_format:
__name__: "PREFIX1_$VAR"
for: "PREFIX2_$QUERY_KEY"
custom_label_1: label_name_1
custom_label_2: label_name_2
It will return metrics that will look like:
{__name__="PREFIX1_anomaly_score", for="PREFIX2_query_name_1", custom_label_1="label_name_1", custom_label_2="label_name_2", cpu=1, device="eth0", instance="node-exporter:9100"}
{__name__="PREFIX1_yhat_lower", for="PREFIX2_query_name_1", custom_label_1="label_name_1", custom_label_2="label_name_2", cpu=1, device="eth0", instance="node-exporter:9100"}
{__name__="PREFIX1_anomaly_score", for="PREFIX2_query_name_2", custom_label_1="label_name_1", custom_label_2="label_name_2", cpu=1, device="eth0", instance="node-exporter:9100"}
{__name__="PREFIX1_yhat_lower", for="PREFIX2_query_name_2", custom_label_1="label_name_1", custom_label_2="label_name_2", cpu=1, device="eth0", instance="node-exporter:9100"}