feat: Instrument PG connect #1763
Merged
Conversation
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
kirs
force-pushed
the
instrument-pg-connect
branch
from
d2fc214 to
6d32bf7
Compare
kirs
requested review from
a team,
ahayworth,
arielvalentin,
dazuma,
ericmustin,
fbogsany,
kaylareopelle,
mwear,
plantfansam,
robbkidd,
robertlaurin,
simi and
xuan-cao-swi
as code owners
kirs
added a commit
to kirs/opentelemetry-ruby-contrib
that referenced
this pull request
Oct 28, 2025
* feat: add instrumentation for connecting to PG
kirs
force-pushed
the
instrument-pg-connect
branch
2 times, most recently
from
37a50d7 to
950b70a
Compare
Contributor
arielvalentin
left a comment
arielvalentin
left a comment
There was a problem hiding this comment.
Thank you for your contribution. I have left some comments for you to review.
instrumentation/pg/lib/opentelemetry/instrumentation/pg/patches/connection.rb
Show resolved
Hide resolved
instrumentation/pg/lib/opentelemetry/instrumentation/pg/patches/connection.rb
Outdated
Show resolved
Hide resolved
kirs
force-pushed
the
instrument-pg-connect
branch
2 times, most recently
from
93e6b17 to
ff5c0f4
Compare
kirs
force-pushed
the
instrument-pg-connect
branch
from
ff5c0f4 to
1608d41
Compare
Contributor
kaylareopelle
left a comment
kaylareopelle
left a comment
There was a problem hiding this comment.
Thank you for this contribution, @kirs! There's one Rubocop failure on the PG suite to address:
lib/opentelemetry/instrumentation/pg/patches/connection.rb:15:9:
C: Style/Documentation: Missing top-level documentation comment for module
OpenTelemetry::Instrumentation::PG::Patches::ConnectionHelper.
module ConnectionHelper
^^^^^^^^^^^^^^^^^^^^^^^
1608d41 to
4542f03
Compare
Contributor
Author
|
fixed, thank you! |
arielvalentin
approved these changes
Oct 30, 2025
| config = OpenTelemetry::Instrumentation::PG::Instrumentation.instance.config | ||
|
|
||
| tracer.in_span('connect', kind: :client) do |span| | ||
| if block_given? |
Contributor
There was a problem hiding this comment.
Just wanted to confirm that there wasn't a way to simply this.
Does the block not get forwarded when calling super?
Contributor
Author
There was a problem hiding this comment.
It does get forwarded, but we want a special path for block_given? to be able to set span attributes.
conn = super
ConnectionHelper.set_connection_attributes(span, conn, config)
conn
^ the above only returns conn when there's no block given. When the block is given, it doesn't "leak" the connection object outside of the block.
kirs
force-pushed
the
instrument-pg-connect
branch
from
4542f03 to
ef9bf74
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
It's surprising that we don't do this for PG while we do this for Trilogy. Without this, it's impossible to attribute any time spent establishing the connection.