Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add M3-Restrict-By-Tags-JSON example to docs #2437

Merged
merged 1 commit into from
Jul 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/common/headers_optional_read_all.md
Original file line number Diff line number Diff line change
@@ -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"]}'
```
<br /><br />
2 changes: 1 addition & 1 deletion docs/m3coordinator/api/remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/m3query/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down