Skip to content
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

Observation API bird's eye view #4726

Closed
brunobat opened this issue Feb 6, 2024 · 2 comments
Closed

Observation API bird's eye view #4726

brunobat opened this issue Feb 6, 2024 · 2 comments
Labels
doc-update A documentation update
Milestone

Comments

@brunobat
Copy link

brunobat commented Feb 6, 2024

Request.
It would be great to have a high level overview on the documentation on how the Observation API works.
This could be done by enumerating and defining the different functional modules and explain their motivation and relationship with other modules. I see some big blocks like:

  • Observation and ObservationView
  • Context (the different ones)
  • Handlers and Composition
  • Conventions
  • How it can be used for metrics and tracing and how it cannot be used for metrics.

Rationale
This is important for anyone wanting to integrate the Observation API on their own framework or for someone that just wants to instrument a library.

@brunobat
Copy link
Author

brunobat commented Feb 6, 2024

@marcingrzejszczak
Copy link
Contributor

I understand that we should expand what we have here with additional information?

@marcingrzejszczak marcingrzejszczak added doc-update A documentation update and removed waiting-for-triage labels Feb 6, 2024
@marcingrzejszczak marcingrzejszczak added this to the 1.12.3 milestone Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-update A documentation update
Projects
None yet
Development

No branches or pull requests

2 participants