Clarify target in DB Span name
#1061
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarify span name to avoid alternating span name formats and allow dropping `target`.
5 tasks
3 tasks
joaopgrassi
reviewed
May 24, 2024
docs/database/database-spans.md
Outdated
| @@ -71,6 +71,8 @@ The <span id="target-placeholder">`{target}`</span> SHOULD adhere to one of the | |||
| - `server.address:server.port` | |||
| - `db.system` | |||
|
|
|||
| A given instrumentation SHOULD strive for consistency in span names. This means that if a specific attribute from the [`{target}`](#target-placeholder) list is selected, it should always be used for the span name. If certain queries lack this specific attribute, the instrumentation SHOULD use `{db.operation.name}` as the span name and omit `{target}`, rather than falling back to the next attribute in the [`{target}`](#target-placeholder) list. | |||
There was a problem hiding this comment.
can you please break the lines? That way it's easier to leave comments and suggestions when the lines are between 80-120 chars long.
We have tooling to enforce this but not running it at the moment.
|
We discussed this in the DB Stabilization SIG meeting - likely we'll go with #1069. Will close this if there is a final decision. |
|
Closing in favour of #1069 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify span name to avoid alternating span name formats and allow dropping
{target}in edge cases.Fixes #1045
Changes
Implementing #1045 (comment) from DB Stabilization WG meeting.
Merge requirement checklist
[chore]