docs: document metrics-generator ring #1316
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
kvrhdn
requested review from
KMiller-Grafana,
joe-elliott,
annanay25,
mdisibio,
dgzlopes,
mapno and
zalegrala
as code owners
joe-elliott
approved these changes
Mar 1, 2022
KMiller-Grafana
previously requested changes
Mar 1, 2022
Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
|
Thank you for the suggestions @KMiller-Grafana. Should I apply the same changes to the other sections on these pages? |
zalegrala
approved these changes
Mar 3, 2022
zalegrala
approved these changes
Mar 3, 2022
| **Participants:** Metrics-generators | ||
| **Used by:** Distributors | ||
|
|
||
| This ring is used by distributors to load balance traffic to the metrics-generators. When spans are received, the trace ID is hashed, and the traces are sent to the appropriate metrics-generators based on token ownership in the ring. |
There was a problem hiding this comment.
Should we mention what the hash is?
There was a problem hiding this comment.
I think that's an implementation detail of the ring in dskit. How a hash ring works is explained here: https://cortexmetrics.io/docs/architecture/#the-hash-ring (this link is also on the top of this page in the docs)
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.
What this PR does:
Extend the API reference and the consistent hash ring page to list the new metrics-generator ring.
This is the first (of many) PRs to document the metrics-generator. We will also have to describe the new config options in the configuration section and update various other pages.
Which issue(s) this PR fixes:
Related to #1303
Checklist
Tests updatedCHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]