docs(metrics): add design doc#3569
Draft
cijothomas wants to merge 1 commit into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3569 +/- ##
=======================================
- Coverage 83.0% 83.0% -0.1%
=======================================
Files 130 130
Lines 27992 27992
=======================================
- Hits 23251 23250 -1
- Misses 4741 4742 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Adds
docs/design/metrics.md, a companion to the existing logs/traces/otlp/observability design docs.The intent is to capture the architectural choices behind the metrics API+SDK in one place: the instrument-based API surface, the per-stream
ValueMaphot path (empty-attribute fast path, caller-order lookup, sorted-key fallback, write-lock upgrade, lock-free aggregator updates), cardinality limit + overflow behavior, the known contention story and the prior attempts to relieve it (#1564, #2304, #3473, #1386, umbrella #2450), bound instruments and why they exist (hot-path self-diagnostics), views, and the reader/exporter side.Companion to docs/metrics.md, which stays focused on user-facing guidance.
Opening as draft to invite review on framing/accuracy before merging. Happy to split sections out if anything reads as too detailed for a design doc.
Merge requirement checklist
CHANGELOG.mdfiles updated for non-trivial, user-facing changes — N/A, docs only