github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/vmgateway.md: update docs, since vmgateway now supports extra_filters

Browse source 
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1863
This commit is contained in:
Aliaksandr Valialkin 2022-01-18 12:36:15 +02:00
parent 74a4c29729
commit dbfa1421ac
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/vmgateway.md
View file

@ -40,6 +40,7 @@ jwt token must be in following format:
"team": "dev", "team": "dev",
"project": "mobile" "project": "mobile"
}, },
"extra_filters": ["{env~=\"prod|dev\",team!=\"test\"}"],
"mode": 1 "mode": 1
} }
} }
@ -48,7 +49,8 @@ Where:
- `exp` - required, expire time in unix_timestamp. If the token expires then `vmgateway` rejects the request. - `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": {}}` - `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. - `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. - `mode` - optional, access mode for api - read, write, or full. Supported values: 0 - full (default value), 1 - read, 2 - write.
## QuickStart ## QuickStart