Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .chloggen/feat_experimental_messaging.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: "enhancement"

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: "messaging"

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Add messaging_latest_experimental feature flag to enable experimental messaging conventions"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [2928]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
7 changes: 6 additions & 1 deletion docs/messaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ This document defines semantic conventions for messaging systems spans, metrics
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/azure-messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ The Semantic Conventions for [Azure Service Bus](https://learn.microsoft.com/azu
> * `messaging` - emit the new, stable messaging conventions,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be crystal clear here and say that this only emits stable conventions? Because it says "stop emitting the old, experimental. I kinda don't like "old" here because there might be "new" unstable conventions as well, and are those included or not? :D

Maybe we just say: emit only stable messaging conventions. and keep it short.

Could also be done as a follow up. I just wanted to bring here now for discussions. CC @open-telemetry/specs-semconv-maintainers

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kinda don't like "old" here because there might be "new" unstable conventions as well, and are those included or not? :D

Heh, good point! I'm happy to follow-up on it if we decide to go that route. 🙂

Maybe we just say: emit only stable messaging conventions. and keep it short.

I like that. Maybe that small change could be the resolution for #3200 🙂

> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/gcp-pubsub.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ The Semantic Conventions for [Google Cloud Pub/Sub](https://cloud.google.com/pub
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,17 @@ The Semantic Conventions for [Apache Kafka](https://kafka.apache.org/) extend an
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/messaging-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,17 @@ linkTitle: Metrics
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/messaging-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,17 @@ linkTitle: Spans
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ The Semantic Conventions for [RabbitMQ](https://www.rabbitmq.com/) extend and ov
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
7 changes: 6 additions & 1 deletion docs/messaging/rocketmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ The Semantic Conventions for [Apache RocketMQ](https://rocketmq.apache.org/) ext
> * `messaging` - emit the new, stable messaging conventions,
> and stop emitting the old experimental messaging conventions
> that the instrumentation emitted previously.
> * `messaging_latest_experimental` - emit the latest in-development messaging conventions
> and stop emitting the old experimental conventions (v1.24.0 or prior). If stable
> messaging conventions are available, emit both stable and latest in-development conventions.
> * `messaging/dup` - emit both the old and the stable messaging 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 messaging conventions
> the instrumentation was emitting previously.
> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present
> * Notes:
> * `messaging/dup` has higher precedence than `messaging` in case both values are present
> * `messaging_latest_experimental` has higher precedence than both `messaging/dup` and `messaging`
> * 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.
Expand Down
Loading