Prefix SQL URLs with scheme #667
Merged
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
Currently the database URLs provided in SQL data are formatted like:
{host}:{port}/{database}
However, most (maybe all?) of the other X-Ray SDKs[1][2][3] format these
URLs with the scheme prefixed in front, so:
{scheme}://{host}:{port}/{database}
This format is also enforced on the opentelemetry collector[4], and
results in the following error when receiving traces with SQL data from
this library:
failed to parse out the database name in the "sql.url" field
When this happens, traces are dropped by the opentelemetry collector and
are not sent to AWS X-Ray.
This change addresses these issues by prefixing the SQL data URLs with
the scheme for both MySQL (`mysql://`) and Postgres (`postgresql://`).
[1]: https://github.com/aws/aws-xray-sdk-python/blob/d3a202719e659968fe6dcc04fe14c7f3045b53e8/aws_xray_sdk/ext/sqlalchemy_core/patch.py#L30
[2]: https://github.com/aws/aws-xray-sdk-java/blob/master/aws-xray-recorder-sdk-sql-mysql/src/main/java/com/amazonaws/xray/sql/mysql/TracingInterceptor.java#L119
[3]: https://github.com/aws/aws-xray-sdk-ruby/blob/b2fce0c1f4ada747ebe16b973e1ed7069013a9a2/lib/aws-xray-sdk/facets/rails/active_record.rb#L50
[4]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/awsxrayreceiver/internal/translator/sql.go#L38-L39
mxiamxia
approved these changes
Aug 1, 2024
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.
Description of changes:
Currently the database URLs provided in SQL data are formatted like:
However, most (maybe all?) of the other X-Ray SDKs1 2 3 format these URLs with the scheme prefixed in front, so:
This format is also enforced on the opentelemetry collector 4, and results in the following error when receiving traces with SQL data from this library:
When this happens, traces are dropped by the opentelemetry collector and are not sent to AWS X-Ray. This change addresses these issues by prefixing the SQL data URLs with the scheme for both MySQL (
mysql://) and Postgres (postgresql://).By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.