opentelemetry-instrumentation-pg 0.25.2 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1657a2304d23151ca16abe37e4c10ac189c84d05146f9a9d8802ba164d44598
-  data.tar.gz: 39b4c371b11b030f09b1054c04da290b0b4f051f138c9ad0e5b43117f77c44d0
+  metadata.gz: b1f0cce766de33102b30042a14d65f2e9fd00e0e9bcdc82702cd5b747c146c27
+  data.tar.gz: b2e4ecbad38a5556a7ded3508d44bc0bd18d19078d1df9c5ad8efa29e6ab68b1
 SHA512:
-  metadata.gz: 8c1bcba9e93214b3537856a094846fd93aac95bca4772849e4a42dae335d2102b444db14a7148f34545a1554c1ec12776854d5d4ca5c245f8ac4190c23a1a346
-  data.tar.gz: a09b3230505a4e9b4994e035cdc978a8f782a253bdad3c4accffa9ef8619f4f2147a7119d4763c3051dca855f0522f5a2830bb0e9646f48f20fa3b0b06ae79ca
+  metadata.gz: b131fc9b5c97da003fecf7252f33dd7ee87e07b7e88974031b6e789f7c5afe29621b76138ce78101d32437c31f50b6c3c0e8c91906155a74d918feebd6fdb8af
+  data.tar.gz: d50b7becf091842b581d56aee6d3466eaa51516306f15f120033e2859e1cc5537fc19604100d6b1a7567be1f5cecd34fd0a0f177f1fc396694be013af502f1d5

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### 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
+
+* FIXED: Pass block explicitly in `define_method` calls for PG instrumentation query methods
+
 ### v0.25.2 / 2023-06-05
 
 * FIXED: Base config options 

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 includes the executed SQL as the `db.statement`
+    # By default, this instrumentation obfuscate/sanitize 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 sanitize the attribute by setting to :obfuscate
+    # setting this option to :omit or disbale sanitization the attribute by setting to :include
     db_statement: :include,
   }
 end

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

@@ -25,7 +25,7 @@ module OpenTelemetry
         end
 
         option :peer_service, default: nil, validate: :string
-        option :db_statement, default: :include, validate: %I[omit include obfuscate]
+        option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
         option :obfuscation_limit, default: 2000, validate: :integer
 
         private

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

@@ -14,10 +14,14 @@ module OpenTelemetry
         # Module to prepend to PG::Connection for instrumentation
         module Connection # rubocop:disable Metrics/ModuleLength
           PG::Constants::EXEC_ISH_METHODS.each do |method|
-            define_method method do |*args|
+            define_method method do |*args, &block|
               span_name, attrs = span_attrs(:query, *args)
               tracer.in_span(span_name, attributes: attrs, kind: :client) do
-                super(*args)
+                if block
+                  block.call(super(*args))
+                else
+                  super(*args)
+                end
               end
             end
           end
@@ -32,10 +36,14 @@ module OpenTelemetry
           end
 
           PG::Constants::EXEC_PREPARED_ISH_METHODS.each do |method|
-            define_method method do |*args|
+            define_method method do |*args, &block|
               span_name, attrs = span_attrs(:execute, *args)
               tracer.in_span(span_name, attributes: attrs, kind: :client) do
-                super(*args)
+                if block
+                  block.call(super(*args))
+                else
+                  super(*args)
+                end
               end
             end
           end
@@ -154,7 +162,7 @@ module OpenTelemetry
             # string when there is only one. Some older versions of libpq allow
             # multiple without any way to discern which is presently connected.
             addr = conninfo_hash[:hostaddr]
-            return addr unless addr&.include?(',')
+            addr unless addr&.include?(',')
           end
 
           def transport_attrs
@@ -182,7 +190,7 @@ module OpenTelemetry
             # As a fallback, we can use the port of the parsed connection
             # string when there is exactly one.
             p = conninfo_hash[:port]
-            return p.to_i unless p.nil? || p.empty? || p.include?(',')
+            p.to_i unless p.nil? || p.empty? || p.include?(',')
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.25.2'
+      VERSION = '0.26.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/pg.rb

@@ -44,5 +44,5 @@ module OpenTelemetry
   end
 end
 
-require_relative './pg/instrumentation'
-require_relative './pg/version'
+require_relative 'pg/instrumentation'
+require_relative 'pg/version'

data/lib/opentelemetry/instrumentation.rb

@@ -19,4 +19,4 @@ module OpenTelemetry
   end
 end
 
-require_relative './instrumentation/pg'
+require_relative 'instrumentation/pg'

data/lib/opentelemetry-instrumentation-pg.rb

@@ -4,4 +4,4 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require_relative './opentelemetry/instrumentation'
+require_relative 'opentelemetry/instrumentation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.25.2
+  version: 0.26.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: 1.56.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: 1.56.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -206,20 +206,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
 description: PG (PostgreSQL) instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -243,10 +229,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.25.2/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.26.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.25.2
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.26.0
 post_install_message: 
 rdoc_options: []
 require_paths: