DBM: Add option to append SQL comment propagation #3809
Merged
+122
−42
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
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
BenchmarksBenchmark execution time: 2024-08-12 21:58:03 Comparing candidate commit 8f4efc5 in PR branch Found 1 performance improvements and 1 performance regressions! Performance is the same for 21 metrics, 2 unstable metrics. scenario:profiler - Allocations (baseline)
scenario:tracing - Tracing.log_correlation
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3809 +/- ##
=======================================
Coverage 97.90% 97.91%
=======================================
Files 1261 1261
Lines 75620 75665 +45
Branches 3706 3710 +4
=======================================
+ Hits 74036 74084 +48
+ Misses 1584 1581 -3 ☔ View full report in Codecov by Sentry. |
cswatt
approved these changes
Jul 25, 2024
TonyCTHsu
reviewed
Jul 26, 2024
TonyCTHsu
approved these changes
Jul 30, 2024
TonyCTHsu
reviewed
Jul 30, 2024
p-datadog
reviewed
Jul 30, 2024
| @@ -1990,6 +1992,9 @@ client.query("SELECT * FROM users WHERE group='x'") | |||
| | `enabled` | `DD_TRACE_TRILOGY_ENABLED` | `Bool` | Whether the integration should create spans. | `true` | | |||
| | `service_name` | `DD_TRACE_TRILOGY_SERVICE_NAME` | `String` | Name of application running the `trilogy` instrumentation. May be overridden by `global_default_service_name`. [See _Additional Configuration_ for more details](#additional-configuration) | `trilogy` | | |||
| | `peer_service` | `DD_TRACE_TRILOGY_PEER_SERVICE` | `String` | Name of external service the application connects to | `nil` | | |||
| | `comment_propagation` | `DD_DBM_PROPAGATION_MODE` | `String` | SQL comment propagation mode for database monitoring. <br />(example: `disabled` \| `service`\| `full`). <br /><br />**Important**: _Note that enabling SQL comment propagation results in potentially confidential data (service names) being stored in the databases which can then be accessed by other third parties that have been granted access to the database._ | `'disabled'` | | |||
| | `append_propagation` | | `Bool` | Appends the SQL comment propagation to the query string. Prepends the comment if `false`. For long query strings, the appended propagation comment might be truncated, causing loss of correlation between the query and trace. | `false` | | |||
| | `on_error` | | `Proc` | Custom error handler invoked when MySQL raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring errors that are handled at the application level. | `proc { \|span, error\| span.set_error(error) unless span.nil? }` | | |||
There was a problem hiding this comment.
Is this documenting an existing option that wasn't documented? Would be clearer to have this addition in its own PR.
There was a problem hiding this comment.
Is this documenting an existing option that wasn't documented?
Yes.
Can I keep it here, please? I will save me like 20 minutes now, then a context switch later, and some stress.
Merged
4 tasks
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 #3601
Add an option (defaults to
false) to append the DBM trace propagation comment instead, of prepending it.This allow users using database monitor tools to see the SQL query itself first, instead of the Datadog trace propagation comment first.
Motivation:
To correlate Database Monitoring and Traces, the tracer add a SQL comments to instrumented SQL queries.
Currently, the comments are prepended to the query, to prevent any possible truncation from removing the propagation data.
But this means that, in any external tools use to monitor the database, the queries will have the Datadog propagation comment first, and not the query itself. This makes inspecting the query quite inconvenient in many tools.
How to test the change?
There are tests covering all the changes.