opentelemetry-instrumentation-mysql2 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139dddefaff180304528b83c6fe468bc16334d8d79b9f3ce3008a341aec4c7fc
-  data.tar.gz: 22b7924ecb2b9e33404865a13bb755ecfda62ee2e90a5a62fc24df0530a971ac
+  metadata.gz: e5556a962e40c18ff1e4c02618b9772bb6a9708bbcfa4867c62924118bfdf1de
+  data.tar.gz: 856f5881c0c843902bf79b38969f9dc20e9286719ebccde33c4155a2f4b06e54
 SHA512:
-  metadata.gz: b632dd330fd5846e6d500990a8e38629e62b91040ab2f39f1d52d10a145af92076ee4ef6d2e8d10fb5decace8858d02cc070b256212f70cbb6d858bfa062b50a
-  data.tar.gz: b71616e71765cc3d1fcdb8a987db447e6f58511ef53a491fe7b377746d62880a8e178b93d01d10a6b01c3d7c4d1d955d48fb6e8cdec1b0371ed7b02348c4a47a
+  metadata.gz: 36a64234a88f39e07e957721e434633db8636c86467a457fe298492100c9c36f465b37aa36ee4f6a7b37d3747bb1df7c338077514b27e41f867697e19f1dda78
+  data.tar.gz: 6c8f6ffa8a510838c2c559da473b57edd7024d21696bcc143a8bfad6eb6ccba86e021a11cb6b8e9a6deee56ee4dab711274685a3e6bd3792ac6b7fa7e861e44c

data/CHANGELOG.md

@@ -1,22 +1,33 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### 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
+
+* 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
 
@@ -24,7 +35,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
 
@@ -32,11 +43,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: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
@@ -54,9 +55,9 @@ module OpenTelemetry
             attributes = client_attributes
             case config[:db_statement]
             when :include
-              attributes['db.statement'] = sql
+              attributes[SemanticConventions::Trace::DB_STATEMENT] = sql
             when :obfuscate
-              attributes['db.statement'] = obfuscate_sql(sql)
+              attributes[SemanticConventions::Trace::DB_STATEMENT] = obfuscate_sql(sql)
             end
             tracer.in_span(
               database_span_name(sql),
@@ -70,15 +71,17 @@ 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]
+              truncated_sql = sql[..sql.index(generated_mysql_regex) - 1]
+              truncated_sql + "...\nSQL truncated (> #{config[:obfuscation_limit]} characters)"
             else
               obfuscated = OpenTelemetry::Common::Utilities.utf8_encode(sql, binary: true)
               obfuscated = obfuscated.gsub(generated_mysql_regex, '?')
               obfuscated = 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if detect_unmatched_pairs(obfuscated)
               obfuscated
             end
-          rescue StandardError
+          rescue StandardError => e
+            OpenTelemetry.handle_error(message: 'Failed to obfuscate SQL', exception: e)
             'OpenTelemetry error: failed to obfuscate sql'
           end
 
@@ -102,7 +105,7 @@ module OpenTelemetry
             when :db_name
               database_name
             when :db_operation_and_name
-              op = OpenTelemetry::Instrumentation::Mysql2.attributes['db.operation']
+              op = OpenTelemetry::Instrumentation::Mysql2.attributes[SemanticConventions::Trace::DB_OPERATION]
               name = database_name
               if op && name
                 "#{op} #{name}"
@@ -127,12 +130,12 @@ module OpenTelemetry
             port = query_options[:port].to_s
 
             attributes = {
-              'db.system' => 'mysql',
-              'net.peer.name' => host,
-              'net.peer.port' => port
+              SemanticConventions::Trace::DB_SYSTEM => 'mysql',
+              SemanticConventions::Trace::NET_PEER_NAME => host,
+              SemanticConventions::Trace::NET_PEER_PORT => port
             }
-            attributes['db.name'] = database_name if database_name
-            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+            attributes[SemanticConventions::Trace::DB_NAME] = database_name if database_name
+            attributes[SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
             attributes
           end
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.22.0'
+      VERSION = '0.24.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +112,16 @@ dependencies:
   name: opentelemetry-test-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.41.1
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.41.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.22.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.24.0/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.22.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.24.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -239,14 +239,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Mysql2 instrumentation for the OpenTelemetry framework