Some fixes to ID gen docs #1385
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
benraskin92
commented
Feb 19, 2019
docs/how_to/query.md
Outdated
| @@ -69,15 +69,15 @@ prepend_meta: 4,2,2,4,2,2,2,2!"t1"v1t2"v2"t3v3t4v4 | |||
| quoted: {\"t1\"="v1",t2="\"v2\"",t3="v3",t4="v4"} | |||
| ``` | |||
|
|
|||
| If there is a chance that your metric tags will contain "control" characters, specifically `,` and `=`, it is highly recommended that one of either the `quoted` or `prepend_meta` schemes are specified, as the `legacy` scheme may cause ID collisions. As a general guideline, we suggest `quoted`, as it mirrors the more familiar Prometheus style IDs. | |||
| If there is a chance that your metric tags will contain "control" characters (WHAT ARE THE CONTROL CHARACTERS?), specifically `,` and `=`, it is highly recommended that one of either the `quoted` or `prepend_meta` schemes are specified, as the `legacy` scheme may cause ID collisions. As a general guideline, we suggest `quoted`, as it mirrors the more familiar Prometheus style IDs. | |||
There was a problem hiding this comment.
What are the "control" characters here? @robskillington @arnikola
There was a problem hiding this comment.
Standard control chars http://ascii-table.com/control-chars.php but , and = specifically
arnikola
reviewed
Feb 19, 2019
docs/how_to/query.md
Outdated
| @@ -53,7 +53,7 @@ If you run Statsite, m3agg, or some other aggregation tier, you will want to set | |||
|
|
|||
| ## ID generation | |||
|
|
|||
| The default generation scheme for IDs is unfortunately prone to collisions, but remains the default for backwards compatibility reasons. It is suggested to set the ID generation scheme to one of either `quoted` or `prepend_meta`. `quoted` generation scheme yields the most human-readable IDs, whereas `prepend_meta` is better for more compact IDS, or if tags are expected to contain non-ASCII characters. To set the ID generation scheme, add the following to your coordinator configuration yaml file: | |||
| The default generation scheme for IDs (`legacy`) is unfortunately prone to collisions, but remains the default for backwards compatibility reasons. It is suggested to set the ID generation scheme to one of either `quoted` or `prepend_meta`. `quoted` generation scheme yields the most human-readable IDs, whereas `prepend_meta` is better for more compact IDs, or if tags are expected to contain non-ASCII characters. To set the ID generation scheme, add the following to your m3coordinator configuration yaml file: | |||
There was a problem hiding this comment.
"... for IDs, `legacy`, ..."
Codecov Report
@@ Coverage Diff @@
## master #1385 +/- ##
========================================
+ Coverage 70.7% 70.7% +<.1%
========================================
Files 827 827
Lines 71224 71224
========================================
+ Hits 50384 50391 +7
+ Misses 17539 17530 -9
- Partials 3301 3303 +2
Continue to review full report at Codecov.
|
arnikola
approved these changes
Feb 19, 2019
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.
No description provided.