-
Notifications
You must be signed in to change notification settings - Fork 502
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add design docs #2657
Add design docs #2657
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
docs/design/logs.md:111
- The phrase should be 'components like the exporter use interior mutability'.
components like exporter use interior mutability
docs/design/logs.md:117
- The phrase should be 'ownership is not passed to the processor.'.
ownership is not passed to the processor
docs/design/logs.md:123
- The phrase should be 'Since the processor only gets a reference to the log, it cannot store it beyond
OnEmit()
.'
Since the processor only gets a reference to the log, it cannot store it beyond the `OnEmit()`.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2657 +/- ##
=====================================
Coverage 79.1% 79.1%
=====================================
Files 120 120
Lines 22556 22556
=====================================
Hits 17857 17857
Misses 4699 4699 ☔ View full report in Codecov by Sentry. |
The OTel Logs API is not intended for direct end-user usage. Instead, it is | ||
designed for appender/bridge authors to integrate existing logging libraries | ||
with OpenTelemetry. However, there is nothing preventing it from being used by | ||
end-users. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit - However, since this is public API, there is nothing preventing it from being used by end-users.
Thanks, @cijothomas! This is a great addition for anyone looking to understand the design and revisit the reasoning behind certain decisions. I haven't completed the full review yet. so added minor (cosmetic) comments on the parts I've reviewed so far. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great (and I learnt some stuff reading it) !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for adding this :)
Merging as the doc is still marked experimental/draft. Will be polishing the doc more to cover more design decisions. |
Part of #2570
This adds an initial draft of Logs architecture/design. Will add Metrics one next, and then Traces (Traces would be mostly same as Logs)