Skip to content

Commit

Permalink
Recommend making create spans disableable
Browse files Browse the repository at this point in the history
  • Loading branch information
lmolkova committed Oct 3, 2024
1 parent 5298ea9 commit 7d87f77
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/messaging/messaging-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,14 @@ into the message.
The "Publish" span SHOULD always link to the creation context that was injected
into a message either from a "Create" span or as a custom creation context.

When instrumenting library API that always sends a single message, it's
RECOMMENDED to create "Publish" span without "Create" span.

When instrumenting library API that usually operate with batches, it's
RECOMMENDED to create "Create" span for each message along with the "Publish" span.
It's also RECOMMENDED to provide a configuration option allowing to disable "Create"
span creation.

#### Consumer spans

"Receive" spans SHOULD be created for operations of passing messages to the
Expand Down Expand Up @@ -272,7 +280,7 @@ messages were received). For each message it accounts for, the "Process" or
> - It is the only option to correlate producer and consumer(s) in batch scenarios
> as a span can only have a single parent.
>
> - It is the only option to correlate produce and consumer(s) when message
> - It is the only option to correlate producer and consumer(s) when message
> consumption can happen in the scope of another ambient context such as a
> HTTP server span.
Expand All @@ -294,8 +302,8 @@ allowing users to control this behavior.
It is NOT RECOMMENDED to use the message creation context as the parent of "Process"
spans (by default) if processing happens in the scope of another span.

If instrumentation use the message creation context as the parent for "Process"
spans in the scope of another valid ambient context, they SHOULD add the
If instrumentation uses the message creation context as the parent for "Process"
spans in the scope of another valid ambient context, it SHOULD add the
ambient context as a link on the "Process" span to preserve the correlation
between message processing and that context.

Expand Down
1 change: 1 addition & 0 deletions model/messaging/deprecated/registry-deprecated.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: registry.messaging.deprecated
type: attribute_group
stability: experimental
display_name: Deprecated Messaging Attributes
brief: "Describes deprecated messaging attributes."
attributes:
Expand Down
1 change: 1 addition & 0 deletions model/messaging/registry.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: registry.messaging
type: attribute_group
stability: experimental
display_name: General Messaging Attributes
brief: 'Attributes describing telemetry around messaging systems and messaging activities.'
attributes:
Expand Down
8 changes: 8 additions & 0 deletions model/messaging/spans.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: attributes.messaging.trace.minimal
type: attribute_group
stability: experimental
brief: >
Defines minimal set of attributes used by all messaging systems.
extends: attributes.messaging.common.minimal
Expand Down Expand Up @@ -29,6 +30,7 @@ groups:

- id: messaging
type: span
stability: experimental
brief: >
Defines a full set of attributes used in messaging systems.
extends: attributes.messaging.trace.minimal
Expand Down Expand Up @@ -85,6 +87,7 @@ groups:

- id: messaging.network.attributes
type: attribute_group
stability: experimental
brief: Attributes that describe messaging operation along with network information.
extends: attributes.messaging.trace.minimal
attributes:
Expand All @@ -97,6 +100,7 @@ groups:

- id: messaging.rabbitmq
type: attribute_group
stability: experimental
extends: messaging.network.attributes
brief: >
Attributes for RabbitMQ
Expand All @@ -114,6 +118,7 @@ groups:

- id: messaging.kafka
type: attribute_group
stability: experimental
extends: attributes.messaging.trace.minimal
brief: >
Attributes for Apache Kafka
Expand Down Expand Up @@ -146,6 +151,7 @@ groups:

- id: messaging.rocketmq
type: attribute_group
stability: experimental
extends: attributes.messaging.trace.minimal
brief: >
Attributes for Apache RocketMQ
Expand Down Expand Up @@ -208,6 +214,7 @@ groups:
- `create` and `receive` for [common messaging operations](/docs/messaging/messaging-spans.md#operation-types)
- id: messaging.servicebus
type: attribute_group
stability: experimental
extends: attributes.messaging.trace.minimal
brief: >
Attributes for Azure Service Bus
Expand Down Expand Up @@ -248,6 +255,7 @@ groups:

- id: messaging.eventhubs
type: attribute_group
stability: experimental
extends: attributes.messaging.trace.minimal
brief: >
Attributes for Azure Event Hubs
Expand Down

0 comments on commit 7d87f77

Please sign in to comment.