opentelemetry-instrumentation-pg 0.24.0 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c59fa49902f08ce89443d4b062b10d31b6e8c6a7741b2069e32c974079c07f
-  data.tar.gz: 5530b1f69417c3bbcb9219fba0f5ae34d71741fcac4d496c247bbdb88384fe0c
+  metadata.gz: d828ad6a0400bd997f99de77aeb6507bfc82d6ae4b0ca9744e166030bd23edee
+  data.tar.gz: 37e5eecb2567bfee13896d67e443a4f7f43ad02fc8864ce925f72e694fd3b924
 SHA512:
-  metadata.gz: e52b890b4f7008ae18888810e58a5bba899d20877f446467ae98294d35f12cb4bf33bf6c8b94e50e5ffdec04982a308373b282e028f347cd99ff92d1b4f00e96
-  data.tar.gz: 2748d5fd4e56cffafef5d7ea7ea21fcf9c0b7f3b289ed16a9be73ff590014e7f31ae8f71890a8724851051e09b493d6cd458a79a3eed8442a705c46f4feb14dc
+  metadata.gz: 4d9cf4613d90e9afeb0baedf84dc190168384490e8fab4cd36cdc4fbbe9a4754d2494a6f3293217ac7263c6973c277ba35f1b9ef3b629abf4a6709eb06380c4a
+  data.tar.gz: 5a2e6d37525c31c24e3868498e238d834bffd6abeeb91816816d82290dbf9d5ef5c2cfd08fe5b49f9a7245f2462b104b0171b7b6a2589e27e15b641063d29f63

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### v0.25.1 / 2023-06-01
+
+* FIXED: Regex non-match with obfuscation limit (issue #486) 
+
+### v0.25.0 / 2023-05-25
+
+* ADDED: Add config[:obfuscation_limit] to pg and mysql2 
+
 ### v0.24.0 / 2023-04-17
 
 * BREAKING CHANGE: Drop support for EoL Ruby 2.7 

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

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

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

@@ -107,8 +107,14 @@ module OpenTelemetry
           def obfuscate_sql(sql)
             return sql unless config[:db_statement] == :obfuscate
 
-            # Borrowed from opentelemetry-instrumentation-mysql2
-            return 'SQL query too large to remove sensitive data ...' if sql.size > 2000
+            if sql.size > config[:obfuscation_limit]
+              first_match_index = sql.index(generated_postgres_regex)
+              truncation_message = "SQL truncated (> #{config[:obfuscation_limit]} characters)"
+              return truncation_message unless first_match_index
+
+              truncated_sql = sql[..first_match_index - 1]
+              return "#{truncated_sql}...\n#{truncation_message}"
+            end
 
             # From:
             # https://github.com/newrelic/newrelic-ruby-agent/blob/9787095d4b5b2d8fcaf2fdbd964ed07c731a8b6b/lib/new_relic/agent/database/obfuscator.rb
@@ -117,6 +123,9 @@ module OpenTelemetry
             obfuscated = 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if PG::Constants::UNMATCHED_PAIRS_REGEX.match(obfuscated)
 
             obfuscated
+          rescue StandardError => e
+            OpenTelemetry.handle_error(message: 'Failed to obfuscate SQL', exception: e)
+            'OpenTelemetry error: failed to obfuscate sql'
           end
 
           def generated_postgres_regex

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.24.0'
+      VERSION = '0.25.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -243,10 +243,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.24.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.25.1/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.24.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.25.1
 post_install_message: 
 rdoc_options: []
 require_paths: