opentelemetry-instrumentation-mysql2 0.23.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ea7871c2d5272a19f91159b2b9f72e07e265fed7dd673c03b3ef2c7506aed62
-  data.tar.gz: 49579a5b7030b8fd8e19900158ad8438ed91a2f9188e8d1e4ee2799503f72f4a
+  metadata.gz: 1f086bc035af9f951109cd4e61e5f4f403c7f066d6c4d5f853465060c6cae2e8
+  data.tar.gz: 81bc9f183786bf26cdbdaa44c4d176258b6446e242800ac8543c1d6ff11784c0
 SHA512:
-  metadata.gz: d762f5106fd527d7f4dfc43830bb6ad7fc46cb7944e8b2468888fe77078c39a3764836149124760c04a8738c9840ec028f34f54899ab5a33dba99b66cadb02d5
-  data.tar.gz: 3e55e547de48c4b2132d4a95023627a8d1a96b0a5f7ee38c3bc565548b541c8da8f2f64817cc636b7de830642a931899b47860939e290d3cbcda7e26b244bc06
+  metadata.gz: 8013b7edd0e679422859c67e13d29c395d5e767e7d780f83b72cd5e302be7430a785c93edbe4ddb417abae4dffe86adcb566b2d39231cf94e4f26c3e55c625c1
+  data.tar.gz: 9312c12a1e1f465a83d2b2617309f91fcfd32d6271ad010b85e934517109e71204ce7796198e68f9e9cada715e7ef8d8a004080a211f4feb1d88db42b3db0fa2

data/CHANGELOG.md

@@ -1,29 +1,37 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.24.1 / 2023-06-01
+
+* FIXED: Regex non-match with obfuscation limit (issue #486)
+
+### v0.24.0 / 2023-05-25
+
+* ADDED: Add config[:obfuscation_limit] to pg and mysql2
+
 ### v0.23.0 / 2023-04-17
 
-* BREAKING CHANGE: Drop support for EoL Ruby 2.7 
+* BREAKING CHANGE: Drop support for EoL Ruby 2.7
 
-* ADDED: Drop support for EoL Ruby 2.7 
-* FIXED: Ensure encoding errors handled during SQL obfuscation for Trilogy 
+* ADDED: Drop support for EoL Ruby 2.7
+* FIXED: Ensure encoding errors handled during SQL obfuscation for Trilogy
 
 ### v0.22.0 / 2023-01-14
 
-* BREAKING CHANGE: Removed deprecated instrumentation options 
+* BREAKING CHANGE: Removed deprecated instrumentation options
 
-* ADDED: Add option to configure span name 
-* ADDED: Removed deprecated instrumentation options 
-* DOCS: Fix gem homepage 
-* DOCS: More gem documentation fixes 
+* ADDED: Add option to configure span name
+* ADDED: Removed deprecated instrumentation options
+* DOCS: Fix gem homepage
+* DOCS: More gem documentation fixes
 
 ### v0.21.1 / 2022-10-26
 
-* FIXED: Handle encoding errors in mysql obfuscation 
+* FIXED: Handle encoding errors in mysql obfuscation
 
 ### v0.21.0 / 2022-06-09
 
 * Upgrading Base dependency version
-* FIXED: Broken test file requirements 
+* FIXED: Broken test file requirements
 
 ### v0.20.1 / 2022-05-03
 
@@ -31,7 +39,7 @@
 
 ### v0.20.0 / 2021-12-01
 
-* ADDED: Add default options config helper + env var config option support 
+* ADDED: Add default options config helper + env var config option support
 
 ### v0.19.1 / 2021-09-29
 
@@ -39,11 +47,11 @@
 
 ### v0.19.0 / 2021-08-12
 
-* BREAKING CHANGE: Add option for db.statement 
+* BREAKING CHANGE: Add option for db.statement
 
-* ADDED: Add option for db.statement 
-* DOCS: Update docs to rely more on environment variable configuration 
-* DOCS: Move to using new db_statement 
+* ADDED: Add option for db.statement
+* DOCS: Update docs to rely more on environment variable configuration
+* DOCS: Move to using new db_statement
 
 ### v0.18.1 / 2021-06-23
 

data/lib/opentelemetry/instrumentation/mysql2/instrumentation.rb

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

data/lib/opentelemetry/instrumentation/mysql2/patches/client.rb

@@ -30,6 +30,7 @@ module OpenTelemetry
 
           QUERY_NAME_RE = Regexp.new("^(#{QUERY_NAMES.join('|')})", Regexp::IGNORECASE)
 
+          # From: https://github.com/newrelic/newrelic-ruby-agent/blob/0235b288d85b8bc795bdc1a24621dd9f84cfef45/lib/new_relic/agent/database/obfuscation_helpers.rb#L9-L34
           COMPONENTS_REGEX_MAP = {
             single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
             double_quotes: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
@@ -70,8 +71,13 @@ module OpenTelemetry
           private
 
           def obfuscate_sql(sql)
-            if sql.size > 2000
-              'SQL query too large to remove sensitive data ...'
+            if sql.size > config[:obfuscation_limit]
+              first_match_index = sql.index(generated_mysql_regex)
+              truncation_message = "SQL truncated (> #{config[:obfuscation_limit]} characters)"
+              return truncation_message unless first_match_index
+
+              truncated_sql = sql[..first_match_index - 1]
+              "#{truncated_sql}...\n#{truncation_message}"
             else
               obfuscated = OpenTelemetry::Common::Utilities.utf8_encode(sql, binary: true)
               obfuscated = obfuscated.gsub(generated_mysql_regex, '?')

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.23.0'
+      VERSION = '0.24.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.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
@@ -156,14 +156,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
@@ -227,10 +227,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.23.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.24.1/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/mysql2
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.23.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.24.1
 post_install_message: 
 rdoc_options: []
 require_paths: