search

open-telemetry / opentelemetry-ruby-contrib

Contrib Packages for the OpenTelemetry Ruby API and SDK implementation.
https://opentelemetry.io
Apache License 2.0
80 stars 167 forks source link

Implement `OTEL_SEMCONV_STABILITY_OPT_IN` within HTTP-related instrumentation #1116

Open kaylareopelle opened 1 month ago

kaylareopelle commented 1 month ago

Follow the guidelines listed in Semantic Conventions or HTTP to implement the OTEL_SEMCONV_STABILITY_OPT_IN environment variable. This is a requirement before stable HTTP semantic conventions can be added to instrumentation.

Warning Existing HTTP instrumentations that are using v1.20.0 of this document (or prior):

  • SHOULD NOT change the version of the HTTP or networking conventions that they emit until the HTTP semantic conventions are marked stable (HTTP stabilization will include stabilization of a core set of networking conventions which are also used in HTTP instrumentations). Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
  • SHOULD introduce an environment variable OTEL_SEMCONV_STABILITY_OPT_IN in the existing major version which is a comma-separated list of values. The only values defined so far are:
    • 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.
    • The default behavior (in the absence of one of these values) is to continue emitting whatever version of the old experimental HTTP and networking conventions the instrumentation was emitting previously.
    • Note: http/dup has higher precedence than http in case both values are present
  • SHOULD maintain (security patching at a minimum) the existing major version for at least six months after it starts emitting both sets of conventions.
  • SHOULD drop the environment variable in the next major version.
kaylareopelle commented 1 month ago

This relates to #1013

hannahramadan commented 1 month ago

I'd love to work on this issue!

kaylareopelle commented 1 month ago

Great! I've assigned this to you, @hannahramadan

github-actions[bot] commented 2 weeks ago

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.