opentelemetry-instrumentation-pg 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 399267fa1f2c8f3206b97b7896f1631d26b4c561d9e7981b225e17ee71d9e028
-  data.tar.gz: ae172b55cd0b320c98baad746078ded1807400e02d16a04ecaa59018ae27fada
+  metadata.gz: 4bc1cf9d4064f6c7acdf160a45b360347c5ad87ffad97a63e086ccea564b396c
+  data.tar.gz: 5bf6eb9b540fd53b53d51126ebd8cce58cc640587f9a9ab7bc3aea9a20026a74
 SHA512:
-  metadata.gz: a2c3d21103e6a462bca6f11703c9534536ee90bdea021341456a1e940b8cefd52ff7e416db0a3bbc32e198886e2c2ac8a411dc9ae65d195fa589f054ee7b6602
-  data.tar.gz: e40016fcb937d5807cddc5029abf6b49bee50e4244df916e2e93e554f15c7c849ac5a703bed4efc60c56843b5d66b672dc731f8c5166f5418107e7070166c6f4
+  metadata.gz: 0f870b5c594e85710a9e71f514ae37059d679601d1d381f5854baf054f780b7504777b12a40e09decbd295852dc9c0b1bb951e97588e8d61b4dfd7e1f8b88f00
+  data.tar.gz: 62479ce766cf77cae8ea0854443d2a71882c9bc1995749c2f07bca70b4890cda2c91d18f1e45e0d27923652111a77257f5aa80e4caa88356f2574680e2647fce

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### v0.27.0 / 2024-02-08
+
+* BREAKING CHANGE: Move shared sql behavior to helper gems
+
+
 ### v0.26.1 / 2023-11-23
 
 * CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)

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

@@ -65,29 +65,6 @@ module OpenTelemetry
           VALUES
         ].freeze
 
-        # From: https://github.com/newrelic/newrelic-ruby-agent/blob/9787095d4b5b2d8fcaf2fdbd964ed07c731a8b6b/lib/new_relic/agent/database/obfuscation_helpers.rb#L9-L34
-        COMPONENTS_REGEX_MAP = {
-          single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
-          dollar_quotes: /(\$(?!\d)[^$]*?\$).*?(?:\1|$)/,
-          uuids: /\{?(?:[0-9a-fA-F]\-*){32}\}?/,
-          numeric_literals: /-?\b(?:[0-9]+\.)?[0-9]+([eE][+-]?[0-9]+)?\b/,
-          boolean_literals: /\b(?:true|false|null)\b/i,
-          comments: /(?:#|--).*?(?=\r|\n|$)/i,
-          multi_line_comments: %r{\/\*(?:[^\/]|\/[^*])*?(?:\*\/|\/\*.*)}
-        }.freeze
-
-        POSTGRES_COMPONENTS = %i[
-          single_quotes
-          dollar_quotes
-          uuids
-          numeric_literals
-          boolean_literals
-          comments
-          multi_line_comments
-        ].freeze
-
-        UNMATCHED_PAIRS_REGEX = %r{'|\/\*|\*\/|\$(?!\?)}
-
         # These are all alike in that they will have a SQL statement as the first parameter.
         # That statement may possibly be parameterized, but we can still use it - the
         # obfuscation code will just transform $1 -> $? in that case (which is fine enough).

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

@@ -50,6 +50,16 @@ module OpenTelemetry
 
           private
 
+          def obfuscate_sql(sql)
+            return sql unless config[:db_statement] == :obfuscate
+
+            OpenTelemetry::Helpers::SqlObfuscation.obfuscate_sql(
+              sql,
+              obfuscation_limit: config[:obfuscation_limit],
+              adapter: :postgres
+            )
+          end
+
           def tracer
             PG::Instrumentation.instance.tracer
           end
@@ -112,34 +122,6 @@ module OpenTelemetry
             operation if PG::Constants::SQL_COMMANDS.include?(operation)
           end
 
-          def obfuscate_sql(sql)
-            return sql unless config[:db_statement] == :obfuscate
-
-            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
-            # https://github.com/newrelic/newrelic-ruby-agent/blob/9787095d4b5b2d8fcaf2fdbd964ed07c731a8b6b/lib/new_relic/agent/database/obfuscation_helpers.rb
-            obfuscated = sql.gsub(generated_postgres_regex, '?')
-            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
-            @generated_postgres_regex ||= Regexp.union(PG::Constants::POSTGRES_COMPONENTS.map { |component| PG::Constants::COMPONENTS_REGEX_MAP[component] })
-          end
-
           def client_attributes
             attributes = {
               'db.system' => 'postgresql',

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.26.1'
+      VERSION = '0.27.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.27.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-helpers-sql-obfuscation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
@@ -170,28 +184,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.60.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.60.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.1
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.1
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -243,10 +257,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.26.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.27.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.26.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-pg/0.27.0
 post_install_message: 
 rdoc_options: []
 require_paths: