There are 2 models to monitor VictoriaMetrics Anomaly Detection behavior - push and pull. Parameters for each of them should be specified in the config file, monitoring section.
Pull Model Config parameters #
| Parameter | Default | Description |
|---|---|---|
|
| Server IP Address |
|
| Port |
Push Config parameters #
| Parameter | Default | Description |
|---|---|---|
| Link where to push metrics to. Example: | |
| Tenant ID for cluster version. Example: | |
|
| Deprecated since v1.8.0. Absolute, to override |
| BasicAuth username | |
| BasicAuth password | |
bearer_token | token | Token is passed in the standard format with header: Authorization: bearer {token}. Available since v1.15.9 |
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 |
|
| Allows disabling TLS verification of the remote certificate. |
|
| Stop waiting for a response after a given number of seconds. |
| Section for custom labels specified by user. |
Monitoring section config example #
monitoring:
pull: # Enable /metrics endpoint.
addr: "0.0.0.0"
port: 8080
push:
url: "http://localhost:8480/"
tenant_id: "0:0" # For cluster version only
user: "USERNAME"
password: "PASSWORD"
verify_tls: False
timeout: "5s"
extra_labels:
job: "vmanomaly-push"
test: "test-1"
Metrics generated by vmanomaly #
| Metric | Type | Description |
|---|---|---|
| Gauge | vmanomaly start time in UNIX time |
Models Behaviour Metrics #
Label names description
Note: There is a new label key
model_aliasintroduced in multi-model support v1.10.0. This label key adjustment was made to preserve unique label set production during writing produced metrics back to VictoriaMetrics.
| Metric | Type | Description | Labelnames |
|---|---|---|---|
| Counter | How many times models ran (per model) |
|
| Summary | How much time (in seconds) model invocations took |
|
| Counter | How many datapoints did models accept |
|
| Counter | How many datapoints were generated by models |
|
| Gauge | How many models are currently inferring |
|
| Counter | How many times a run was skipped (per model) |
|
Writer Behaviour Metrics #
Label names description
| Metric | Type | Description | Labelnames |
|---|---|---|---|
| Summary | How much time (in seconds) did requests to VictoriaMetrics take |
|
| Counter | Response code counts we got from VictoriaMetrics |
|
| Counter | How much bytes were sent to VictoriaMetrics |
|
| Summary | How much time (in seconds) did serializing take |
|
| Counter | How many datapoints were sent to VictoriaMetrics |
|
| Counter | How many timeseries were sent to VictoriaMetrics |
|
Reader Behaviour Metrics #
Label names description
| Metric | Type | Description | Labelnames |
|---|---|---|---|
| Summary | How much time (in seconds) did queries to VictoriaMetrics take |
|
| Counter | Response code counts we got from VictoriaMetrics |
|
| Counter | How much bytes were received in responses |
|
| Summary | How much time (in seconds) did parsing take for each step |
|
| Counter | How many timeseries were received from VictoriaMetrics |
|
| Counter | How many rows were received from VictoriaMetrics |
|
Labelnames #
stage- stage of model - ‘fit’, ‘infer’ or ‘fit_infer’ for models that do it simultaneously, see model types.query_key- query alias fromreaderconfig section.model_alias- model alias frommodelsconfig section. Introduced in v1.10.0.scheduler_alias- scheduler alias fromschedulersconfig section. Introduced in v1.11.0.preset- preset alias for forthcomingpresetsection compatibility. Introduced in v1.12.0.url- writer or reader url endpoint.code- response status code orconnection_error,timeout.step- json or dataframe reading step.