opentelemetry-instrumentation-pg 0.31.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27552dae38df46b415d38e11216ef734157f2bcb9ad5e19a25cb26d5ce029b02
-  data.tar.gz: 39e3643f1cfe66f3a6587b1a54f5994cd7b7fc5f3a1dbdc588dd2445da2cf131
+  metadata.gz: 55eea698a5680444c893b9ff4bfafcd490f179418b3d84df63eb49737eb89b11
+  data.tar.gz: 332bb5e30ee14d66fb880f7645afbee4a5646e1b1e70d16a39d27aba37d5baee
 SHA512:
-  metadata.gz: 27cf741489c9998928bfab9f18cf915b19c83c1a776dc0e1c9711835ab4873f5065539920d07645413890881ac3ad757d0eed26e8cd3ade672abebabfe8f064a
-  data.tar.gz: 3e637c382752c7b515712805c029a7a9cd2461813e198a2dced86f8227931a68ee18711f948e4742e62ebd15556c7dab50d020afc6970b52ae0b61d98801b2a1
+  metadata.gz: 8be801a269c94650a3cec4362a551e3f89428956bb20aa988b8196952ff4322ca4eeceb186c62bb8156c616627ecf5a8d954d218fefacfb647643070df7f8aa6
+  data.tar.gz: dd5824d49a288621a39cdaaac75aae220e85029cf9a07a5b13bab8f40f9b12021ecfea3477e040f1ace8e3cd070f0218622fc329bb130226bd77c9a29bc15c9f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### v0.33.0 / 2025-11-03
+
+* ADDED: Instrument PG connect
+
+### v0.32.0 / 2025-10-22
+
+* BREAKING CHANGE: Min Ruby Version 3.2
+
+* ADDED: Min Ruby Version 3.2
+
 ### v0.31.1 / 2025-09-30
 
 * FIXED: Min OTel Ruby API 1.7

data/README.md

@@ -50,9 +50,9 @@ OpenTelemetry::SDK.configure do |c|
     # will be included on all spans from this instrumentation:
     peer_service: 'postgres:readonly',
 
-    # By default, this instrumentation obfuscate/sanitize the executed SQL as the `db.statement`
+    # By default, this instrumentation obfuscates/sanitizes the executed SQL as the `db.statement`
     # semantic attribute. Optionally, you may disable the inclusion of this attribute entirely by
-    # setting this option to :omit or disbale sanitization the attribute by setting to :include
+    # setting this option to :omit or disable sanitization of the attribute by setting it to :include
     db_statement: :include,
   }
 end

data/lib/opentelemetry/instrumentation/pg/constants.rb

@@ -94,6 +94,12 @@ module OpenTelemetry
           async_exec_prepared
           sync_exec_prepared
         ].freeze
+
+        CONNECTION_METHODS = %i[
+          connect
+          open
+          async_connect
+        ].freeze
       end
     end
   end

data/lib/opentelemetry/instrumentation/pg/instrumentation.rb

@@ -40,6 +40,7 @@ module OpenTelemetry
 
         def patch_client
           ::PG::Connection.prepend(Patches::Connection)
+          ::PG::Connection.singleton_class.prepend(Patches::Connect)
         end
       end
     end

data/lib/opentelemetry/instrumentation/pg/patches/connection.rb

@@ -12,6 +12,65 @@ module OpenTelemetry
   module Instrumentation
     module PG
       module Patches
+        # Utility methods for setting connection attributes from Connect module
+        module ConnectionHelper
+          module_function
+
+          def set_connection_attributes(span, conn, config)
+            attributes = {
+              'db.system' => 'postgresql',
+              'db.name' => conn.db,
+              'db.user' => conn.user
+            }
+            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+
+            h = conn.host
+            if h&.start_with?('/')
+              attributes['net.sock.family'] = 'unix'
+              attributes['net.peer.name'] = h
+            else
+              attributes['net.transport'] = 'ip_tcp'
+              attributes['net.peer.name'] = h
+              attributes['net.peer.port'] = conn.port if defined?(::PG::DEF_PGPORT)
+            end
+
+            attributes.merge!(OpenTelemetry::Instrumentation::PG.attributes)
+            attributes.compact!
+
+            span.add_attributes(attributes)
+          end
+        end
+
+        # Module to prepend to PG::Connection singleton class for connection initialization
+        # We override `new` instead of `initialize` because PG::Connection.new is implemented
+        # as a Ruby method that calls the C-level connect_start, bypassing initialize.
+        # We also need to override the aliases (open, connect, async_connect) because they
+        # were aliased before our prepend, so they point to the original method.
+        # See: https://github.com/ged/ruby-pg/blob/master/lib/pg/connection.rb#L870
+        module Connect
+          def new(...)
+            tracer = OpenTelemetry::Instrumentation::PG::Instrumentation.instance.tracer
+            config = OpenTelemetry::Instrumentation::PG::Instrumentation.instance.config
+
+            tracer.in_span('connect', kind: :client) do |span|
+              if block_given?
+                super do |conn|
+                  ConnectionHelper.set_connection_attributes(span, conn, config)
+                  yield conn
+                end
+              else
+                conn = super
+                ConnectionHelper.set_connection_attributes(span, conn, config)
+                conn
+              end
+            end
+          end
+
+          PG::Constants::CONNECTION_METHODS.each do |method|
+            alias_method method, :new
+          end
+        end
+
         # Module to prepend to PG::Connection for instrumentation
         module Connection # rubocop:disable Metrics/ModuleLength
           # Capture the first word (including letters, digits, underscores, & '.', ) that follows common table commands

data/lib/opentelemetry/instrumentation/pg/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.31.1'
+      VERSION = '0.33.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.31.1
+  version: 0.33.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-01 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-helpers-sql
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
 description: PG (PostgreSQL) instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -75,10 +75,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.31.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.33.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/pg
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.31.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.33.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -87,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: PG (PostgreSQL) instrumentation for the OpenTelemetry framework