feat(dbapi): add comment_position option to control SQL comment placement#4561
Open
RiyaChaturvedi37 wants to merge 11 commits into
Open
Conversation
Contributor
Author
|
This is the first PR in a series adding comment_position support to sqlcommenter instrumentation libraries, as discussed with @tammy-baylis-swi in #4490. Starting with DB-API as the base library to confirm the approach before proceeding to Django, Flask, SQLAlchemy, psycopg2, psycopg, mysql, mysqlclient, and PyMySQL. |
RiyaChaturvedi37
force-pushed
the
feat/sqlcommenter-comment-position-dbapi
branch
from
e74a5e0 to
510e3a7
Compare
RiyaChaturvedi37
force-pushed
the
feat/sqlcommenter-comment-position-dbapi
branch
from
21bd0db to
c0173ed
Compare
RiyaChaturvedi37
force-pushed
the
feat/sqlcommenter-comment-position-dbapi
branch
from
18ae7ef to
ea84264
Compare
RiyaChaturvedi37
force-pushed
the
feat/sqlcommenter-comment-position-dbapi
branch
from
c098c79 to
d504f0a
Compare
herin049
requested changes
May 10, 2026
github-project-automation
Bot
moved this to Reviewed PRs that need fixes
in Python PR digest
Contributor
Author
|
Fixed all the suggestions @herin049 — used Literal["start", "end"] type with a CommentPositionT alias, simplified the semicolon handling logic in sqlcommenter_utils.py, and cleaned up the changelog. Ready for re-review! |
herin049
requested changes
May 10, 2026
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.
Solution
Added a comment_position parameter to trace_integration, wrap_connect, instrument_connection, and DatabaseApiIntegration that defaults to "end" (preserving existing behavior per OTel spec). Set comment_position="start" to prepend the comment instead.
Usage
pythonwrap_connect(
name,
mysql.connector,
"connect",
"mysql",
enable_commenter=True,
comment_position="start",
)
Default behavior unchanged
Part of a series of PRs adding comment_position support across DB-API, Django, Flask, SQLAlchemy, psycopg2, psycopg, mysql, mysqlclient, PyMySQL
Follows approach confirmed in #4490
Part of #3583