From e601e67f656ca61d5d16334f1aa151e67315d2f0 Mon Sep 17 00:00:00 2001 From: Rob Skillington Date: Wed, 1 Jul 2020 21:32:42 -0400 Subject: [PATCH] [docs] Add M3-Restrict-By-Tags-JSON example to docs (#2437) --- docs/common/headers_optional_read_all.md | 13 +++++++++++++ docs/m3coordinator/api/remote.md | 2 +- docs/m3query/api/index.md | 2 +- 3 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 docs/common/headers_optional_read_all.md diff --git a/docs/common/headers_optional_read_all.md b/docs/common/headers_optional_read_all.md new file mode 100644 index 0000000000..a21d0fbca6 --- /dev/null +++ b/docs/common/headers_optional_read_all.md @@ -0,0 +1,13 @@ +--8<-- +docs/common/headers_optional_read_limits.md +--8<-- +- `M3-Restrict-By-Tags-JSON`: + If this header is set it can ensure specific label matching is performed as part +of every query including series metadata endpoints. As an example, the following +header would unconditionally cause `globaltag=somevalue` to be a part of all queries +issued regardless of if they include the label or not in a query and also strip the +"globaltag" from appearing as a label in any of the resulting timeseries: +``` +M3-Restrict-By-Tags-JSON: '{"match":[{"name":"globaltag","type":"EQUAL","value":"somevalue"}],"strip":["globaltag"]}' +``` +

\ No newline at end of file diff --git a/docs/m3coordinator/api/remote.md b/docs/m3coordinator/api/remote.md index 7fc5f98d50..8553fc6115 100644 --- a/docs/m3coordinator/api/remote.md +++ b/docs/m3coordinator/api/remote.md @@ -100,7 +100,7 @@ None. docs/common/headers_optional_read_write_all.md --8<-- --8<-- -docs/common/headers_optional_read_limits.md +docs/common/headers_optional_read_all.md --8<-- ### Data Params diff --git a/docs/m3query/api/index.md b/docs/m3query/api/index.md index c123fbd13d..3dc23a17dc 100644 --- a/docs/m3query/api/index.md +++ b/docs/m3query/api/index.md @@ -36,7 +36,7 @@ Query using PromQL and returns JSON datapoints compatible with the Prometheus Gr docs/common/headers_optional_read_write_all.md --8<-- --8<-- -docs/common/headers_optional_read_limits.md +docs/common/headers_optional_read_all.md --8<-- ### Data Params