[SqlClient] Sanitize SQL query text #2446
Open
+57
−19
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
CodeBlanch
reviewed
Dec 23, 2024
| @@ -123,12 +123,13 @@ This instrumentation can be configured to change the default behavior by using | |||
|
|
|||
| ### SetDbStatementForText | |||
|
|
|||
| Capturing the text of a database query may run the risk of capturing sensitive data. | |||
| `SetDbStatementForText` controls whether the | |||
| The text of a database query may include sensitive data. `SetDbStatementForText` | |||
There was a problem hiding this comment.
I'm finding this whole block a bit confusing. Took a stab at rewriting it:
SetDbStatementForText controls whether the db.statement attribute is emitted for instrument SqlCommands. The behavior of SetDbStatementForText depends on the runtime used, see below for more details.
Query text may contain sensitive data so when SetDbStatementForText is enabled the raw query text is sanitized by automatically replacing literal values with a ? character.
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 #2221
Performs sanitization of SQL text. First 1000 results are cached. This number is arbitrary. I do not wish to make it configurable yet in this PR though I'm open to choosing a different arbitrary number.