opentelemetry-instrumentation-pg 0.35.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7939f1927799287f8b6aaa52df7b679f48b79e071b890caa729cde97076f4cc7
-  data.tar.gz: 5ab484d7f918cb112580e1bd380cff06828d7b24df830e5f87c777300fc0e826
+  metadata.gz: 147a56092b8f0120d9dcda8cb8af7bdf7dedd85747c33c3af830d1f7b8526ae5
+  data.tar.gz: 86ce58798fc0256220f8c4b22a58ed8bc0f863d599e4c68a5aa1cb8dd3e9d19a
 SHA512:
-  metadata.gz: 773ad26dd2a8ee92c2abd59453c7ccd3d5ca2cbaf6766ac085a29e4c1c09f446d38a9b7e6a612243ea5c3488b5d8afc87ddc0384a9c27b9410f6afb3d49ec6a2
-  data.tar.gz: 4a63ed8c931d8f4fd7f73b162d804da1285e211e28fde2631acf975a93344139c6e3694b76870bc22a7eac9c66c74bb41851482b2d6df0360d4c16299b137fc1
+  metadata.gz: 05acd8886220b23284e5974e73a49120ec599f14f751dda701be3002fff711dc09917a8dcd4f3de9ebf52690a5d54929fd7837d8ea11f8d7c949c4bf61ae785d
+  data.tar.gz: 215acc2fff73d8ceff2e208989b1b86509d2300c7fa8e49f5093822f4e82cb9255ae584bdc89f7c87eda1bb8f29c18771653e60a917a8ad6f49c8fa7c0ec14ef

data/CHANGELOG.md

@@ -1,117 +1,125 @@
 # Release History: opentelemetry-instrumentation-pg
 
-### v0.35.0 / 2026-01-13
+## v0.37.0 / 2026-08-05
 
-* ADDED: Add SQL Comment Propagator
+- ADDED: Add returned and affected rows attributes (#2410)
 
-### v0.34.1 / 2025-12-03
+## v0.36.0 / 2026-04-14
 
-* FIXED: Update gemspec dependencies to sql-processor
+- BREAKING CHANGE: Min Ruby Version 3.3 (#2125)
+- ADDED: Min Ruby Version 3.3 (#2125)
+- ADDED: Add release tag into source code url of gem metadata (#1984)
 
-### v0.34.0 / 2025-12-02
+## v0.35.0 / 2026-01-13
 
-* ADDED: Replace references sql-obfuscation -> sql-processor
+- ADDED: Add SQL Comment Propagator
 
-### v0.33.0 / 2025-11-03
+## v0.34.1 / 2025-12-03
 
-* ADDED: Instrument PG connect
+- FIXED: Update gemspec dependencies to sql-processor
 
-### v0.32.0 / 2025-10-22
+## v0.34.0 / 2025-12-02
 
-* BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Replace references sql-obfuscation -> sql-processor
 
-* ADDED: Min Ruby Version 3.2
+## v0.33.0 / 2025-11-03
 
-### v0.31.1 / 2025-09-30
+- ADDED: Instrument PG connect
 
-* FIXED: Min OTel Ruby API 1.7
+## v0.32.0 / 2025-10-22
 
-### v0.31.0 / 2025-09-30
+- BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Min Ruby Version 3.2
 
-* ADDED: Bump minimum API Version to 1.7
+## v0.31.1 / 2025-09-30
 
-### v0.30.1 / 2025-04-16
+- FIXED: Min OTel Ruby API 1.7
 
-* refactor: Use SQL helpers for context attributes #1271
+## v0.31.0 / 2025-09-30
 
-### v0.30.0 / 2025-01-16
+- ADDED: Bump minimum API Version to 1.7
 
-* BREAKING CHANGE: Drop Support for EoL Rails 6.1
-* BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+## v0.30.1 / 2025-04-16
 
-* ADDED: Drop Support for EoL Rails 6.1
-* ADDED: Set minimum supported version to Ruby 3.1
+- refactor: Use SQL helpers for context attributes #1271
 
-### v0.29.2 / 2025-01-07
+## v0.30.0 / 2025-01-16
 
-* FIXED: Update instrumentation pg to support merge statements
+- BREAKING CHANGE: Drop Support for EoL Rails 6.1
+- BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+- ADDED: Drop Support for EoL Rails 6.1
+- ADDED: Set minimum supported version to Ruby 3.1
 
-### v0.29.1 / 2024-11-26
+## v0.29.2 / 2025-01-07
 
-* FIXED: Get correct table name if table name is quoted
+- FIXED: Update instrumentation pg to support merge statements
 
-### v0.29.0 / 2024-09-12
+## v0.29.1 / 2024-11-26
+
+- FIXED: Get correct table name if table name is quoted
+
+## v0.29.0 / 2024-09-12
 
 - BREAKING CHANGE: Return message when sql is over the obfuscation limit. Fixes a bug where sql statements with prepended comments that hit the obfuscation limit would be sent raw.
 
-### v0.28.0 / 2024-08-15
+## v0.28.0 / 2024-08-15
 
 - ADDED: Collect pg db.collection_name attribute
 - FIXED: Update versions to be tested (includes drop support for pg 1.2)
 
-### v0.27.4 / 2024-07-23
+## v0.27.4 / 2024-07-23
 
 - DOCS: Add cspell to CI
 
-### v0.27.3 / 2024-05-11
+## v0.27.3 / 2024-05-11
 
 - ADDED: Support prepend SQL comment for PG instrumentation
 
-### v0.27.2 / 2024-04-30
+## v0.27.2 / 2024-04-30
 
 - FIXED: Bundler conflict warnings
 
-### v0.27.1 / 2024-02-08
+## v0.27.1 / 2024-02-08
 
 - FIXED: Add missing requires for sql-helpers to mysql, pg, and trilogy instrumentation
 
-### v0.27.0 / 2024-02-08
+## v0.27.0 / 2024-02-08
 
 - BREAKING CHANGE: Move shared sql behavior to helper gems
 
-### v0.26.1 / 2023-11-23
+## v0.26.1 / 2023-11-23
 
 - CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)
 
-### v0.26.0 / 2023-10-16
+## v0.26.0 / 2023-10-16
 
 - BREAKING CHANGE: Obfuscation for mysql2, dalli and postgresql as default option for db_statement
 
 - ADDED: Obfuscation for mysql2, dalli and postgresql as default option for db_statement
 
-### v0.25.3 / 2023-07-29
+## v0.25.3 / 2023-07-29
 
 - FIXED: Pass block explicitly in `define_method` calls for PG instrumentation query methods
 
-### v0.25.2 / 2023-06-05
+## v0.25.2 / 2023-06-05
 
 - FIXED: Base config options
 
-### v0.25.1 / 2023-06-01
+## v0.25.1 / 2023-06-01
 
 - FIXED: Regex non-match with obfuscation limit (issue #486)
 
-### v0.25.0 / 2023-05-25
+## v0.25.0 / 2023-05-25
 
 - ADDED: Add config[:obfuscation_limit] to pg and mysql2
 
-### v0.24.0 / 2023-04-17
+## v0.24.0 / 2023-04-17
 
 - BREAKING CHANGE: Drop support for EoL Ruby 2.7
 
 - ADDED: Drop support for EoL Ruby 2.7
 
-### v0.23.0 / 2023-01-14
+## v0.23.0 / 2023-01-14
 
 - BREAKING CHANGE: Removed deprecated instrumentation options
 
@@ -120,56 +128,56 @@
 - DOCS: Fix gem homepage
 - DOCS: More gem documentation fixes
 
-### v0.22.3 / 2022-12-06
+## v0.22.3 / 2022-12-06
 
 - FIXED: Use attributes from the active PG connection
 
-### v0.22.2 / 2022-11-10
+## v0.22.2 / 2022-11-10
 
 - FIXED: Safeguard against host being nil
 
-### v0.22.1 / 2022-10-27
+## v0.22.1 / 2022-10-27
 
 - FIXED: Only take the first item in a comma-separated list for pg attrs
 
-### v0.22.0 / 2022-10-04
+## v0.22.0 / 2022-10-04
 
 - ADDED: Add `with_attributes` context propagation for PG instrumentation
 
-### v0.21.0 / 2022-06-09
+## v0.21.0 / 2022-06-09
 
 - Upgrading Base dependency version
 - FIXED: Broken test file requirements
 
-### v0.20.0 / 2022-05-02
+## v0.20.0 / 2022-05-02
 
 - ADDED: Validate Using Enums
 - FIXED: Update pg instrumentation to handle non primitive argument
 - FIXED: RubyGems Fallback
 
-### v0.19.2 / 2021-12-02
+## v0.19.2 / 2021-12-02
 
 - (No significant changes)
 
-### v0.19.1 / 2021-09-29
+## v0.19.1 / 2021-09-29
 
 - (No significant changes)
 
-### v0.19.0 / 2021-08-12
+## v0.19.0 / 2021-08-12
 
 - ADDED: Add db_statement toggle for postgres
 - DOCS: Update docs to rely more on environment variable configuration
 
-### v0.18.1 / 2021-06-23
+## v0.18.1 / 2021-06-23
 
 - (No significant changes)
 
-### v0.18.0 / 2021-05-21
+## v0.18.0 / 2021-05-21
 
 - ADDED: Updated API dependency for 1.0.0.rc1
 - ADDED: Add option to postgres instrumentation to disable db.statement
 
-### v0.17.1 / 2021-04-23
+## v0.17.1 / 2021-04-23
 
 - Initial release.
 - ADDED: Initial postgresql instrumentation

data/README.md

@@ -54,6 +54,22 @@ OpenTelemetry::SDK.configure do |c|
     # semantic attribute. Optionally, you may disable the inclusion of this attribute entirely by
     # setting this option to :omit or disable sanitization of the attribute by setting it to :include
     db_statement: :include,
+
+    # When `db_statement` is enabled, this instrumentation obfuscates SQL queries. By default, it
+    # obfuscates queries up to 2000 characters. You can override the default with a different
+    # `obfuscation_limit`, but higher values may impact performance.
+    obfuscation_limit: 2000,
+
+    # By default, this instrumentation does not emit the opt-in
+    # `db.response.returned_rows` semantic attribute. Set this option to true
+    # to include the number of rows returned by the database operation when
+    # available from PG::Result.
+    db_response_returned_rows: true,
+
+    # By default, this instrumentation does not emit the `db.response.affected_rows`
+    # attribute. Set this option to true to include the number of rows affected
+    # by mutation operations when available from PG::Result.
+    db_response_affected_rows: true
   }
 end
 ```

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

@@ -29,6 +29,8 @@ module OpenTelemetry
         option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
         option :obfuscation_limit, default: 2000, validate: :integer
         option :propagator, default: 'none', validate: %w[none tracecontext]
+        option :db_response_returned_rows, default: false, validate: :boolean
+        option :db_response_affected_rows, default: false, validate: :boolean
 
         attr_reader :propagator
 

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

@@ -73,13 +73,15 @@ module OpenTelemetry
 
         # Module to prepend to PG::Connection for instrumentation
         module Connection # rubocop:disable Metrics/ModuleLength
+          AFFECTED_ROWS_COMMANDS = %w[DELETE INSERT MERGE UPDATE].freeze
+
           # Capture the first word (including letters, digits, underscores, & '.', ) that follows common table commands
           TABLE_NAME = /\b(?:FROM|INTO|UPDATE|CREATE\s+TABLE(?:\s+IF\s+NOT\s+EXISTS)?|DROP\s+TABLE(?:\s+IF\s+EXISTS)?|ALTER\s+TABLE(?:\s+IF\s+EXISTS)?)\s+"?([\w\.]+)"?/i
 
           PG::Constants::EXEC_ISH_METHODS.each do |method|
             define_method method do |*args, &block|
               span_name, attrs = span_attrs(:query, *args)
-              tracer.in_span(span_name, attributes: attrs, kind: :client) do |_span, context|
+              tracer.in_span(span_name, attributes: attrs, kind: :client) do |span, context|
                 # Inject propagator context into SQL if propagator is configured
                 if propagator && args[0].is_a?(String)
                   sql = args[0]
@@ -93,10 +95,14 @@ module OpenTelemetry
                   end
                 end
 
+                result = super(*args)
+                response_attrs = db_response_attributes(result, attrs)
+                span.add_attributes(response_attrs) unless response_attrs.empty?
+
                 if block
-                  block.call(super(*args))
+                  block.call(result)
                 else
-                  super(*args)
+                  result
                 end
               end
             end
@@ -105,7 +111,7 @@ module OpenTelemetry
           PG::Constants::PREPARE_ISH_METHODS.each do |method|
             define_method method do |*args|
               span_name, attrs = span_attrs(:prepare, *args)
-              tracer.in_span(span_name, attributes: attrs, kind: :client) do |_span, context|
+              tracer.in_span(span_name, attributes: attrs, kind: :client) do |span, context|
                 # Inject propagator context into SQL if propagator is configured
                 # For prepare, the SQL is in args[1]
                 if propagator && args[1].is_a?(String)
@@ -120,7 +126,10 @@ module OpenTelemetry
                   end
                 end
 
-                super(*args)
+                result = super(*args)
+                response_attrs = db_response_attributes(result, attrs)
+                span.add_attributes(response_attrs) unless response_attrs.empty?
+                result
               end
             end
           end
@@ -128,11 +137,15 @@ module OpenTelemetry
           PG::Constants::EXEC_PREPARED_ISH_METHODS.each do |method|
             define_method method do |*args, &block|
               span_name, attrs = span_attrs(:execute, *args)
-              tracer.in_span(span_name, attributes: attrs, kind: :client) do
+              tracer.in_span(span_name, attributes: attrs, kind: :client) do |span|
+                result = super(*args)
+                response_attrs = db_response_attributes(result, attrs)
+                span.add_attributes(response_attrs) unless response_attrs.empty?
+
                 if block
-                  block.call(super(*args))
+                  block.call(result)
                 else
-                  super(*args)
+                  result
                 end
               end
             end
@@ -158,6 +171,31 @@ module OpenTelemetry
             PG::Instrumentation.instance.config
           end
 
+          def db_response_attributes(result, span_attrs)
+            attrs = {}
+            attrs['db.response.returned_rows'] = result.ntuples if db_response_returned_rows?(span_attrs)
+            attrs['db.response.affected_rows'] = result.cmd_tuples if db_response_affected_rows?(result, span_attrs)
+            attrs
+          rescue StandardError => e
+            OpenTelemetry.handle_error(message: 'Error setting DB response attributes', exception: e)
+            {}
+          end
+
+          def db_response_returned_rows?(attrs)
+            return false unless config[:db_response_returned_rows]
+            return false if attrs.key?('db.response.returned_rows')
+
+            true
+          end
+
+          def db_response_affected_rows?(result, attrs)
+            return false unless config[:db_response_affected_rows]
+            return false if attrs.key?('db.response.affected_rows')
+            return false unless AFFECTED_ROWS_COMMANDS.include?(result.cmd_status.to_s.split.first)
+
+            true
+          end
+
           def lru_cache
             # When SQL is being sanitized, we know that this cache will
             # never be more than 50 entries * 2000 characters (so, presumably

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.35.0'
+      VERSION = '0.37.0'
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.37.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-helpers-sql
@@ -75,11 +74,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.35.0/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/pg
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.37.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-pg/v0.37.0/instrumentation/pg
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.35.0
-post_install_message:
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.37.0
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: PG (PostgreSQL) instrumentation for the OpenTelemetry framework
 test_files: []