From f2cc4e043659ae4f440e0f79749fad8347a1ee29 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Tue, 18 Jan 2022 22:27:25 +0200 Subject: [PATCH] app/vmgateway/README.md: sync with enterprise vesion after adding `extra_filters` handling Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1863 --- app/vmgateway/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/vmgateway/README.md b/app/vmgateway/README.md index cd309eaab..ba60d8039 100644 --- a/app/vmgateway/README.md +++ b/app/vmgateway/README.md @@ -36,6 +36,7 @@ jwt token must be in following format: "team": "dev", "project": "mobile" }, + "extra_filters": ["{env~=\"prod|dev\",team!=\"test\"}"], "mode": 1 } } @@ -44,7 +45,8 @@ Where: - `exp` - required, expire time in unix_timestamp. If the token expires then `vmgateway` rejects the request. - `vm_access` - required, dict with claim info, minimum form: `{"vm_access": {"tenand_id": {}}` - `tenant_id` - optional, for cluster mode, routes requests to the corresponding tenant. -- `extra_labels` - optional, key-value pairs for label filters added to the ingested or selected metrics. +- `extra_labels` - optional, key-value pairs for label filters added to the ingested or selected metrics. Multiple filters are added with `and` operation. If defined, `extra_label` from original request removed. +- `extra_filters` - optional, [series selectors](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors) added to the select query requests. Multiple selectors are added with `or` operation. If defined, `extra_filter` from original request removed. - `mode` - optional, access mode for api - read, write, or full. Supported values: 0 - full (default value), 1 - read, 2 - write. ## QuickStart