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.

Sign up for GitHub

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

Jump to bottom

Document obsreport #11437

Open
mackjmr opened this issue Oct 14, 2024 · 0 comments · May be fixed by #11521
Open

Document obsreport #11437

mackjmr opened this issue Oct 14, 2024 · 0 comments · May be fixed by #11521

Comments

@mackjmr
Copy link
Member

mackjmr commented Oct 14, 2024

obsreport is a framework used to create internal telemetry inside components. There used to be some documentation in https://github.com/open-telemetry/opentelemetry-collector/blob/v0.96.0/obsreport/doc.go, but this got removed.

We should document how to use obsreport inside components, e.g. should implement Start<>Op/End<>Op.

I think documenting this in service/telemetry/README.md would be a good place as obsreport uses tracer/ meter from this package.
mackjmr added a commit to mackjmr/opentelemetry-collector that referenced this issue Oct 23, 2024
@mackjmr
[chore] Document obsreport
a3ee4eb 
Add documentation for obsreport. I have limited context, so I added documentation based on what I could find in the code. Please let me know if there are additions I should make.

Fixes: open-telemetry#11437
@mackjmr mackjmr linked a pull request Oct 23, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[chore] Document obsreport mackjmr/opentelemetry-collector
1 participant
@mackjmr