Skip to content

docs(metrics): add design doc#3569

Draft
cijothomas wants to merge 1 commit into
open-telemetry:mainfrom
cijothomas:cijothomas/docs-metrics-design
Draft

docs(metrics): add design doc#3569
cijothomas wants to merge 1 commit into
open-telemetry:mainfrom
cijothomas:cijothomas/docs-metrics-design

Conversation

@cijothomas

Copy link
Copy Markdown
Member

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 ValueMap hot 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

  • CONTRIBUTING guidelines followed
  • Unit tests added/updated (if applicable) — N/A, docs only
  • Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes — N/A, docs only
  • Changes in public API reviewed (if applicable) — N/A

@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.0%. Comparing base (90a39a0) to head (1fd3d7e).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant