opentelemetry-instrumentation-mysql2 0.24.3 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fead6578e21138cd574525dfe0fef226474d1553bb98a29206785aa811f3855
-  data.tar.gz: 6f23786abd74ed57ccd80f2b01c1bf3610db05f9b02fec00016d54c5943b9b35
+  metadata.gz: 8dd5337ce5e46679d577e51b807122cb037299d844ab8405d46c2043d2484931
+  data.tar.gz: c5df05b92be367a4c4397cfcb9eb76c5b5ca0f4fd0b6ee21d61a7bfafa1f1611
 SHA512:
-  metadata.gz: 7d8f085435dd3084ee9cd4a15961fec9183736c5f41f821e5fd6ea469b5b5400025efc3442beca44b2f4d60b850929faeaf3c20fb2c456cf9cde1046af883326
-  data.tar.gz: a7a33b5797845e4640264376d973212c3db062f0ac3a9d5c78e08bce69b504215ad1546745c94b9e41d49779b43fcfd6f12f7297cb113e5c22c2e6c2ab4608ec
+  metadata.gz: 8f183aee9dd0938d0c59928cafa9dd146fafaddb10a246b8486e333139abef478decd4fa1cea0c493012ab300c508302446102b15653092ead1e91d6a739e275
+  data.tar.gz: 4fc278b6756d5f744bf532999da01d95328eca700594e572039c2e51d81df668fc7674b040dbc2d8f350232a3fc267566974d40f393aef35428f1e308dc364be

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.26.0 / 2024-02-08
+
+* BREAKING CHANGE: Move shared sql behavior to helper gems
+
+
+### v0.25.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.24.3 / 2023-08-03
 
 * FIXED: Remove inline linter rules

data/README.md

@@ -46,9 +46,9 @@ end
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::Mysql2', {
-    # The obfuscation of SQL in the db.statement attribute is disabled by default.
-    # To enable, set db_statement to :obfuscate.
-    db_statement: :obfuscate,
+    # The obfuscation of SQL in the db.statement attribute is enabled by default.
+    # To disable, set db_statement to :include; to omit the query completely, set db_statement to :omit
+    db_statement: :include,
   }
 end
 ```

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

@@ -20,7 +20,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 :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]
         option :obfuscation_limit, default: 2000, validate: :integer
 

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

@@ -9,58 +9,27 @@ module OpenTelemetry
     module Mysql2
       module Patches
         # Module to prepend to Mysql2::Client for instrumentation
-        module Client # rubocop:disable Metrics/ModuleLength
-          QUERY_NAMES = [
-            'set names',
-            'select',
-            'insert',
-            'update',
-            'delete',
-            'begin',
-            'commit',
-            'rollback',
-            'savepoint',
-            'release savepoint',
-            'explain',
-            'drop database',
-            'drop table',
-            'create database',
-            'create table'
-          ].freeze
-
-          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: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
-            numeric_literals: /-?\b(?:[0-9]+\.)?[0-9]+([eE][+-]?[0-9]+)?\b/,
-            boolean_literals: /\b(?:true|false|null)\b/i,
-            hexadecimal_literals: /0x[0-9a-fA-F]+/,
-            comments: /(?:#|--).*?(?=\r|\n|$)/i,
-            multi_line_comments: %r{\/\*(?:[^\/]|\/[^*])*?(?:\*\/|\/\*.*)}
-          }.freeze
-
-          MYSQL_COMPONENTS = %i[
-            single_quotes
-            double_quotes
-            numeric_literals
-            boolean_literals
-            hexadecimal_literals
-            comments
-            multi_line_comments
-          ].freeze
-
+        module Client
           def query(sql, options = {})
             attributes = client_attributes
             case config[:db_statement]
             when :include
               attributes[SemanticConventions::Trace::DB_STATEMENT] = sql
             when :obfuscate
-              attributes[SemanticConventions::Trace::DB_STATEMENT] = obfuscate_sql(sql)
+              attributes[SemanticConventions::Trace::DB_STATEMENT] =
+                OpenTelemetry::Helpers::SqlObfuscation.obfuscate_sql(
+                  sql, obfuscation_limit: config[:obfuscation_limit], adapter: :mysql
+                )
             end
             tracer.in_span(
-              database_span_name(sql),
+              OpenTelemetry::Helpers::MySQL.database_span_name(
+                sql,
+                OpenTelemetry::Instrumentation::Mysql2.attributes[
+                  SemanticConventions::Trace::DB_OPERATION
+                ],
+                database_name,
+                config
+              ),
               attributes: attributes.merge!(OpenTelemetry::Instrumentation::Mysql2.attributes),
               kind: :client
             ) do
@@ -70,57 +39,6 @@ module OpenTelemetry
 
           private
 
-          def obfuscate_sql(sql)
-            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, '?')
-              obfuscated = 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if detect_unmatched_pairs(obfuscated)
-              obfuscated
-            end
-          rescue StandardError => e
-            OpenTelemetry.handle_error(message: 'Failed to obfuscate SQL', exception: e)
-            'OpenTelemetry error: failed to obfuscate sql'
-          end
-
-          def generated_mysql_regex
-            @generated_mysql_regex ||= Regexp.union(MYSQL_COMPONENTS.map { |component| COMPONENTS_REGEX_MAP[component] })
-          end
-
-          def detect_unmatched_pairs(obfuscated)
-            # We use this to check whether the query contains any quote characters
-            # after obfuscation. If so, that's a good indication that the original
-            # query was malformed, and so our obfuscation can't reliably find
-            # literals. In such a case, we'll replace the entire query with a
-            # placeholder.
-            %r{'|"|\/\*|\*\/}.match(obfuscated)
-          end
-
-          def database_span_name(sql)
-            case config[:span_name]
-            when :statement_type
-              extract_statement_type(sql)
-            when :db_name
-              database_name
-            when :db_operation_and_name
-              op = OpenTelemetry::Instrumentation::Mysql2.attributes[SemanticConventions::Trace::DB_OPERATION]
-              name = database_name
-              if op && name
-                "#{op} #{name}"
-              elsif op
-                op
-              elsif name
-                name
-              end
-            end || 'mysql'
-          end
-
           def database_name
             # https://github.com/brianmario/mysql2/blob/ca08712c6c8ea672df658bb25b931fea22555f27/lib/mysql2/client.rb#L78
             (query_options[:database] || query_options[:dbname] || query_options[:db])&.to_s
@@ -150,13 +68,6 @@ module OpenTelemetry
           def config
             Mysql2::Instrumentation.instance.config
           end
-
-          def extract_statement_type(sql)
-            QUERY_NAME_RE.match(sql) { |match| match[1].downcase } unless sql.nil?
-          rescue StandardError => e
-            OpenTelemetry.logger.debug("Error extracting sql statement type: #{e.message}")
-            nil
-          end
         end
       end
     end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.24.3'
+      VERSION = '0.26.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/mysql2.rb

@@ -20,18 +20,18 @@ module OpenTelemetry
       # Returns the attributes hash representing the Mysql2 context found
       # in the optional context or the current context if none is provided.
       #
-      # @param [optional Context] context The context to lookup the current
+      # @param context [optional Context] The context to lookup the current
       #   attributes hash. Defaults to Context.current
       def attributes(context = nil)
         context ||= Context.current
         context.value(CURRENT_ATTRIBUTES_KEY) || {}
       end
 
-      # Returns a context containing the merged attributes hash, derived from the
-      # optional parent context, or the current context if one was not provided.
-      #
-      # @param [optional Context] context The context to use as the parent for
+      # @param attributes_hash [Hash] The attributes to add to the context
+      # @param parent_context [optional Context] The context to use as the parent for
       #   the returned context
+      # @return A context containing the merged attributes hash, derived from the
+      # optional parent context, or the current context if one was not provided.
       def context_with_attributes(attributes_hash, parent_context: Context.current)
         attributes_hash = attributes(parent_context).merge(attributes_hash)
         parent_context.set_value(CURRENT_ATTRIBUTES_KEY, attributes_hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.24.3
+  version: 0.26.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-03 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,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-helpers-mysql
+  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-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
@@ -44,14 +72,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
@@ -156,56 +184,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.55.1
+        version: 1.60.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.55.1
+        version: 1.60.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '1.20'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: yard-doctest
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
 description: Mysql2 instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -227,10 +255,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.24.3/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.26.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.24.3
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.26.0
 post_install_message: 
 rdoc_options: []
 require_paths: