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

Document InstrumentationContext in CONTRIBUTING #588

Closed
trask opened this issue Jun 27, 2020 · 2 comments
Closed

Document InstrumentationContext in CONTRIBUTING #588

trask opened this issue Jun 27, 2020 · 2 comments
Assignees
Labels
contributor experience Something that we can do to improve the experience of contributors (especially new contributors) documentation Improvements or additions to documentation

Comments

@trask
Copy link
Member

trask commented Jun 27, 2020

This is an important part of the codebase that is super non-obvious.

Compare/contrast with Context (and some instrumentation keep some state in, e.g. HttpRequest attributes as well. So we have at least 3 options. How a developer should choose which one of them to use?)

ref to gitter discussion: https://gitter.im/open-telemetry/opentelemetry-java-instrumentation?at=5ef7a1ceb8152d3484697a86

@trask trask added the documentation Improvements or additions to documentation label Jun 27, 2020
@trask trask self-assigned this Jun 27, 2020
@trask trask added the contributor experience Something that we can do to improve the experience of contributors (especially new contributors) label Jul 10, 2020
@trask trask closed this as completed Jul 13, 2020
@trask trask reopened this Jul 13, 2020
@trask
Copy link
Member Author

trask commented Jul 21, 2020

Include that InstrumentationContext can only be used inside of advice (#746 (comment))

@trask
Copy link
Member Author

trask commented May 9, 2021

Include that InstrumentationContext can only be used inside of advice (#746 (comment))

This is documented in the InstrumentationContext javadoc now.

The rest is resolved by #2793.

@trask trask closed this as completed May 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor experience Something that we can do to improve the experience of contributors (especially new contributors) documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant