open-telemetry / open-telemetry/opentelemetry-python-contrib
Update db instrumentations documentation around 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
Release 1.44.0/0.65b0 supports OTEL_SEMCONV_STABILITY_OPT_IN for most database instrumentation libraries. Similar to https://github.com/open-telemetry/opentelemetry-python-contrib/issues/4202:
- database - emit the new, stable db conventions, and stop emitting the old experimental db conventions that the instrumentation emitted previously.
- database/dup - emit both the old and the stable db conventions, allowing for a seamless transition.
By default, the old experimental db conventions are emitted.
Please update the individual instrumentation libraries' documentation around this feature.
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 with the documentation for the individual database instrumentation libraries and compare the guidance in issue 4202. Update the docs to describe OTEL_SEMCONV_STABILITY_OPT_IN, the database and database/dup modes, and the default behavior. Done means the affected instrumentation documentation consistently explains the transition between experimental and stable database conventions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100