Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Messaging: Clarify span name when destination is temporary/anonymous #1635

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Messaging: Clarify span name when destination is temporary/anonymous #1635

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bfb9cf5
try to clarify temporary destination names
joaopgrassi Nov 29, 2024
a7624f6
PR review
joaopgrassi Dec 10, 2024
48c602a
Merge branch 'main' into clarify-temporary-destination
joaopgrassi Dec 10, 2024
c676100
"revert"
joaopgrassi Dec 9, 2024
abcc531
fix
joaopgrassi Dec 10, 2024
c6c1ac6
PR suggestions
joaopgrassi Dec 12, 2024
54d7989
Merge branch 'main' into clarify-temporary-destination
joaopgrassi Dec 12, 2024
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
13 changes: 10 additions & 3 deletions docs/messaging/messaging-spans.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,17 +191,24 @@ Messaging spans SHOULD follow the overall [guidelines for span names](https://gi

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

Semantic conventions for individual messaging systems MAY specify different span name format and then MUST document it in semantic conventions for specific messaging technologies.
Semantic conventions for individual messaging systems MAY specify different
span name format and then MUST document it in semantic conventions
for specific messaging technologies.

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

1. `messaging.destination.template` SHOULD be used when it is available.
2. `messaging.destination.name` SHOULD be used when the destination is known to be neither [temporary nor anonymous](#temporary-and-anonymous-destinations).
3. `server.address:server.port` SHOULD be used only for operations not targeting any specific destination(s).
4. The placeholder `(temporary)` SHOULD be used when the destination is [temporary or anonymous](#temporary-and-anonymous-destinations)
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
and neither `messaging.destination.template` or `server.address:server.port` are available.

If a corresponding `{destination}` value is not available for a specific operation, the instrumentation SHOULD omit the `{destination}`.

Expand Down
Loading