Skip to content

Commit e2227c6

Browse files
authored
Messaging: Clarify {destination} value used on span name (#1635)
1 parent abd92c1 commit e2227c6

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
change_type: enhancement
2+
component: messaging
3+
note: Further clarify `{destination}` value on span names
4+
issues: [1635]
5+
subtext:

docs/messaging/messaging-spans.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,19 +191,24 @@ Messaging spans SHOULD follow the overall [guidelines for span names](https://gi
191191

192192
<!-- markdown-link-check-disable -->
193193
<!-- HTML anchors are not supported https://github.com/tcort/markdown-link-check/issues/225-->
194-
The **span name** SHOULD be `{messaging.operation.name} {destination}` (see below for the exact definition of the [`{destination}`](#destination-placeholder) placeholder).
194+
The **span name** SHOULD be `{messaging.operation.name} {destination}`
195+
(see below for the exact definition of the [`{destination}`](#destination-placeholder) placeholder).
195196
<!-- markdown-link-check-enable -->
196197

197-
Semantic conventions for individual messaging systems MAY specify different span name format and then MUST document it in semantic conventions for specific messaging technologies.
198+
Semantic conventions for individual messaging systems MAY specify different
199+
span name format and then MUST document it in semantic conventions
200+
for specific messaging technologies.
198201

199-
The <span id="destination-placeholder">`{destination}`</span> SHOULD describe the entity that the operation is performed against
202+
The <span id="destination-placeholder">`{destination}`</span>
203+
SHOULD describe the entity that the operation is performed against
200204
and SHOULD adhere to one of the following values, provided they are accessible:
201205

202206
1. `messaging.destination.template` SHOULD be used when it is available.
203207
2. `messaging.destination.name` SHOULD be used when the destination is known to be neither [temporary nor anonymous](#temporary-and-anonymous-destinations).
204208
3. `server.address:server.port` SHOULD be used only for operations not targeting any specific destination(s).
205209

206-
If a corresponding `{destination}` value is not available for a specific operation, the instrumentation SHOULD omit the `{destination}`.
210+
If a (low-cardinality) corresponding `{destination}` value is not available for
211+
a specific operation, the instrumentation SHOULD omit the `{destination}`.
207212

208213
Examples:
209214

0 commit comments

Comments
 (0)