Update SqlClient instrumentation to follow new DB span conventions #2229
+297
−58
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
github-actions
bot
added
the
comp:instrumentation.sqlclient
alanwest
changed the title
alanwest
commented
Oct 19, 2024
Comment on lines
+77
to
+78
| // Test cases when EmitOldAttributes = false and EmitNewAttributes = true (i.e., OTEL_SEMCONV_STABILITY_OPT_IN=database) | ||
| [InlineData(SqlClientDiagnosticListener.SqlDataBeforeExecuteCommand, SqlClientDiagnosticListener.SqlDataAfterExecuteCommand, CommandType.StoredProcedure, "SP_GetOrders", true, false, true, false, true)] |
There was a problem hiding this comment.
These test cases are becoming a bit heinous for readability as expressed here. I have thoughts to refactor the tests, but I want to roll with the heinousness for now.
alanwest
commented
Oct 19, 2024
Comment on lines
+285
to
+287
| // TODO: The attributes added here are required. We need to consider | ||
| // collecting these attributes by default. | ||
| if (this.EnableConnectionLevelAttributes) |
There was a problem hiding this comment.
Will open a new issue for this.
alanwest
commented
Oct 19, 2024
Comment on lines
+295
to
+297
| // TODO: In the new conventions, instance name should now be captured | ||
| // as a part of db.namespace, when available. | ||
| if (this.EmitOldAttributes && !string.IsNullOrEmpty(connectionDetails.InstanceName)) |
There was a problem hiding this comment.
Will open a new issue for this.
alanwest
commented
Oct 19, 2024
Comment on lines
+97
to
99
| // TODO: Need to understand what scenario (if any) database will be null here | ||
| // so that we set DisplayName and db.name/db.namespace correctly. | ||
| if (database != null) |
There was a problem hiding this comment.
Will open a new issue for this
alanwest
commented
Oct 19, 2024
Comment on lines
-286
to
313
| // TODO: Should we continue to emit this if the default port (1433) is being used? | ||
| sqlActivity.SetTag(SemanticConventions.AttributeServerPort, connectionDetails.Port); |
There was a problem hiding this comment.
Removed this TODO because the instrumentation already excludes port when it is 1433.
alanwest
commented
Oct 19, 2024
Comment on lines
-258
to
-261
| if (!this.EnableConnectionLevelAttributes) | ||
| { | ||
| sqlActivity.SetTag(SemanticConventions.AttributePeerService, dataSource); | ||
| } |
There was a problem hiding this comment.
This instrumentation should not be emitting peer.service.
But just a reminder here... when peer.service was removed from HTTP client instrumentation it was unexpected see #1761.
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.
Fixes #2225
This PR is the first in a series of PRs. It introduces support for the
OTEL_SEMCONV_STABILITY_OPT_INenvironment variable to gate using the old or new conventions. It does not aim to fully adopt the new database conventions. It only updates conventions for the attributes currently reported by the instrumentation.The documentation in the readme still only refers to the old attributes. I will update the readme in a different PR.