Update filtering documentation #2631
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @phemmer |
phemmer
reviewed
Apr 5, 2017
docs/CONFIGURATION.md
Outdated
| * **namepass**: | ||
| An array of strings that is used to filter metrics generated by the | ||
| current input. Each string is tested as a glob match against measurement names | ||
| and only if it matches, the field is emitted. |
There was a problem hiding this comment.
only if it matches, the
fieldis emitted
the point is emitted
docs/CONFIGURATION.md
Outdated
| An array of strings that is used to filter metrics generated by the current | ||
| input. Each string in the array is matched as a glob pattern against field | ||
| names and if it matches, the field is emitted. `fieldpass` is not available | ||
| for outputs. |
There was a problem hiding this comment.
Should note that only fields which match are emitted. All other fields will be dropped.
docs/CONFIGURATION.md
Outdated
| `fielddrop` is not available for outputs. | ||
| * **tagpass**: | ||
| A table mapping tag keys to arrays of tag value patterns. Each pattern is | ||
| matched as a glob against the corresponding tag key and if the point contains |
There was a problem hiding this comment.
the
correspondingtagkey
the tag value
And clarification why to omit "corresponding"
Each pattern is matched ...
There is only one tag value. So each pattern corresponds to what?
docs/CONFIGURATION.md
Outdated
| pass an entire point based on its tag, `taginclude` passes only the specified | ||
| tags from the measurement. This filter can be used on both inputs & outputs, | ||
| but it is _recommended_ to be used on inputs, as it is more efficient to | ||
| filter out tags at the ingestion point. |
There was a problem hiding this comment.
The description doesn't cover how to format the config param. An array of tag names to glob. non-matching tag is dropped.
|
I rewrote it all again. Made sure to start with the type of the field and tried to simplify/clarify. |
phemmer
reviewed
Apr 6, 2017
docs/CONFIGURATION.md
Outdated
| The inverse of `namepass`. If a match is found the point is discarded. This | ||
| is tested on points after they have passed the `namepass` test. | ||
| * **fieldpass**: | ||
| An array of glob pattern strings. Only fields whose field key matches an |
danielnelson
force-pushed
the
update-filter-docs
branch
from
1bbc069
to
f8f546e
Compare
vlamug
pushed a commit
to vlamug/telegraf
that referenced
this pull request
May 30, 2017
maxunt
pushed a commit
that referenced
this pull request
Jun 26, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried to clarify some of the issues surrounding tagpass, reordered taginclude/tagexclude to match the other filters, and tried to correct some of the terminology.
Required for all PRs: