opentelemetry-instrumentation-pg 0.36.0 → 0.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f996ad740911dadbeb4e827f62b05f2bd2b57a3cc9a695c7e4e9ece7dadc385
-  data.tar.gz: 3caedd663abde4a0bb8d9636bb46621dccc4a0d4c8db101e60cf51cb7c6c790f
+  metadata.gz: ad8e81754b0cdc6821ffa0ac1844b0b681d3968a02dcc66b2f4aaa38dbab4210
+  data.tar.gz: af540cd156af164ca33bb267f1b1facb1fac46eba1a5129e1ae3e0b20f3b6138
 SHA512:
-  metadata.gz: 5cd52f1d835d96eb26bbfca70ccfb5261f164c8f2d44203f14d780a1df61fe6b196600ad7a0cbfdbfa34b8eea806125f0a1679718d8119cb00e2d6feefcab553
-  data.tar.gz: 5ce0ad3fe50cd072497ab0cb040eab2c2bd98a03570872cc94fb3c43a53933f889d379b322541fd089a827d0d656b46bcf43293873c81704187684a6fde7cdcf
+  metadata.gz: 3fb98ac6e4f1b7eea7b455780fae059e948e289e73ac55e45c58da8cfe58c27595c99c9a4c2f9c26bb23622d31ec49be76261a2766ffaed9741ae675b069eafc
+  data.tar.gz: 87eb28915287d385feecdeade147f9d18a64a6b8a3a5419440ce438a73cfc3a363df8a5f506cdfd7d9de20797a0663997afa0ed060831334428e70053b00f3d0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-pg
 
+## v0.37.1 / 2026-10-13
+
+- FIXED: Encode SQL commenter propagation keys (#2634, #2638)
+
+## v0.37.0 / 2026-08-05
+
+- ADDED: Add returned and affected rows attributes (#2410)
+
 ## v0.36.0 / 2026-04-14
 
 - BREAKING CHANGE: Min Ruby Version 3.3 (#2125)

data/README.md

@@ -58,7 +58,18 @@ OpenTelemetry::SDK.configure do |c|
     # 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
+    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
 ```
@@ -69,9 +80,9 @@ An example of usage can be seen in [`example/pg.rb`](https://github.com/open-tel
 
 ## How can I get involved?
 
-The `opentelemetry-instrumentation-pg` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
+The `opentelemetry-instrumentation-pg` gem source is [on github][repo-github], along with related gems.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby Special Interest Group (SIG). You can find details on our weekly meeting times, GitHub Discussions, and CNCF Slack channels on the [Ruby SDK SIG page][ruby-sig].
 
 ## License
 
@@ -79,9 +90,6 @@ The `opentelemetry-instrumentation-pg` gem is distributed under the Apache 2.0 l
 
 [pg-home]: https://github.com/ged/ruby-pg
 [bundler-home]: https://bundler.io
-[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
-[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
-[community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
-[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+[ruby-sig]: https://github.com/open-telemetry/community/blob/main/sigs.md#ruby-sdk

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.36.0'
+      VERSION = '0.37.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.37.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -29,14 +29,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
@@ -74,10 +80,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.36.0/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-pg/v0.36.0/instrumentation/pg
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.37.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-pg/v0.37.1/instrumentation/pg
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.36.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.37.1
 rdoc_options: []
 require_paths:
 - lib
@@ -92,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: PG (PostgreSQL) instrumentation for the OpenTelemetry framework
 test_files: []