feat(sqlcommenter): add comment_position option to control SQL comment placement#4628
Open
RiyaChaturvedi37 wants to merge 3 commits into
Open
feat(sqlcommenter): add comment_position option to control SQL comment placement#4628RiyaChaturvedi37 wants to merge 3 commits into
RiyaChaturvedi37 wants to merge 3 commits into
Conversation
|
|
||
|
|
||
| def _add_sql_comment(sql, **meta) -> str: | ||
| def _add_sql_comment(sql, comment_position="end", **meta) -> str: |
Contributor
There was a problem hiding this comment.
Pardon my delayed review @RiyaChaturvedi37 and thank you for resuming this!
I had this comment on the other PR: Instead of a string, what if we had it as a case-insensitive boolean string check for false/true and the config was called comment_prepend=false? Since I don't think we'll support a "middle".
Contributor
There was a problem hiding this comment.
Please could test coverage be added in https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/opentelemetry-instrumentation/tests/test_utils.py or a new file.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
The SQL comment was always appended to the end of the query, which caused truncation issues in database query logs for long queries (e.g. queries produced by Django in AWS RDS logs).
Solution
Added a comment_position parameter to _add_sql_comment() that defaults to "end" (preserving existing behavior per OTel spec). Set comment_position="start" to prepend the comment instead.
Usage
python_add_sql_comment(sql, comment_position="start", **meta)
Notes
Default behavior unchanged
Part of a series of PRs adding comment_position support across instrumentation libraries
Replaces #4490
Part of #3583