Document OTEL_SEMCONV_STABILITY_OPT_IN

[xrmx]

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.

[rite7sh]

Hi! I’d like to work on this issue.
Quick clarification , should the OTEL_SEMCONV_STABILITY_OPT_IN section be added to all HTTP-related instrumentation docs (Flask, FastAPI, Requests, HTTPX, Django, ASGI/WSGI, etc.), or is there a specific subset you’d like covered?
Also, should this be documented only in the contrib instrumentation .rst files for now, or do you want a follow-up change in opentelemetry.io as well?
Happy to start once the scope is confirmed. Thanks

[xrmx]

@rite7sh I would work to get one of your 3 already open PR merged before opening new ones, thanks.

[rite7sh]

@xrmx affirmative, thanks for the heads up .

[dipak0000812]

Hi @xrmx,
I checked the HTTP instrumentation docs (Flask, FastAPI, Requests, HTTPX) and I don’t see OTEL_SEMCONV_STABILITY_OPT_IN documented there.
I’d like to add a consistent section explaining the behavior for http and http/dup, and clarify the default behavior.
I’ll follow the existing env var documentation pattern.
Please let me know if I should limit this to contrib docs first or also prepare a follow-up for opentelemetry.io.

[xrmx]

@dipak0000812 opentelemetry.io is another repo and we can update that only after the next release.