Document OTEL_SEMCONV_STABILITY_OPT_IN environment variable#4254
Document OTEL_SEMCONV_STABILITY_OPT_IN environment variable#4254thakoreh wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
Add documentation explaining how to use the OTEL_SEMCONV_STABILITY_OPT_IN environment variable to control semantic convention stability opt-in for HTTP instrumentations. Fixes: open-telemetry#4202
|
|
||
| ### Opting into stable semantic conventions | ||
|
|
||
| You can control which semantic conventions are used by setting the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable. This is useful for transitioning from experimental to stable semantic conventions. |
There was a problem hiding this comment.
I think this is the wrong place, I think we should have these to every http instrumentation rst documentation and maybe on opentelemetry.io
There was a problem hiding this comment.
I agree with xrmx. It will be a bigger update, but the individual docs are a better place for details especially for users doing manual instrumentation. For example: one update in the Flask readthedocs already linked from Flask readme
xrmx
moved this from Easy to review / merge / close
to Reviewed PRs that need fixes
in Python PR digest
|
Thanks for the feedback @xrmx @tammy-baylis-swi! You're right - the documentation belongs in the individual instrumentation READMEs rather than the root README. I'll update this PR to add the env var documentation to the Flask instrumentation README and link it from there. Let me refactor this to target the specific instrumentation docs. |
3 participants
Description
Fixes issue #4202 - Document the OTEL_SEMCONV_STABILITY_OPT_IN environment variable.
Changes
Added a new subsection under Semantic Convention status explaining:
Documentation Added