open-telemetry / open-telemetry/opentelemetry-python-contrib
Document OTEL_SEMCONV_STABILITY_OPT_IN
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
All the http instrumentation now supports the OTEL_SEMCONV_STABILITY_OPT_IN env variable but we're not documenting it. We should document in each http instrumentation documentation that if they are setting the env var to:
- http - emit the new, stable HTTP and networking conventions, and stop emitting the old experimental HTTP and networking conventions that the instrumentation emitted previously.
- http/dup - emit both the old and the stable HTTP and networking conventions, allowing for a seamless transition.
And that by default the old experimental HTTP and networking conventions are emitted.
Also we should probably document this in opentelemetry.io somewhere.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for each HTTP instrumentation and the relevant documentation area on opentelemetry.io. Document the http and http/dup settings, including their emitted conventions, and state that the old experimental conventions are the default.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100