opentelemetry-instrumentation-mysql2 0.16.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89fb1be56f26510a07111f785844a64bb8afa67b451967481f66b34fb4148918
-  data.tar.gz: 2fda38e2e737d5400de33644f634a2fd01b292de783af6c79a7f7ab202d5c2e0
+  metadata.gz: c4c336dee4ea731b92e4546a72fc047e1daaccbfdc45b2771844a71b937283b6
+  data.tar.gz: ce856296ab136a054567fdd5c180af35ea1538f71eeac10255e47adc6f8e9046
 SHA512:
-  metadata.gz: c606394f621ae305fe5eea6b9167bd5fc6303aa2c73365d6d381f0f2dbe545d91caa2ed3c55e6e7db62797381eaccdea0f68afeb38f2efb6673282fcae3f68ae
-  data.tar.gz: 430c6c8530deee4cfa85f739c256663ac536eec693a0e39a8899f7b73d2a6f3b896787802b349ed4dbb46758ce4552ad3ff0e3a3d4acaaa20f569e1724a9fad8
+  metadata.gz: 6a0c027bb105697ba6c564a32ca3fa1db695ad374302e98b89d59d030fdc2ba63a8c2beb794033687c0a88f9ac00e65b6b6dcd152bbac379ddcdb07b2b7e5f79
+  data.tar.gz: 8b31ee410ba0364068f3dde580728618cd9db21c09daaae7827d9a023b01ce1ad079c603e976d100c4c2ba0b4e2f93ac1952fe3d4c439a8fa607980eba586ba9

data/CHANGELOG.md

@@ -1,14 +1,35 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.19.0 / 2021-08-12
+
+* 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 
+
+### v0.18.1 / 2021-06-23
+
+* (No significant changes)
+
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* Fix: Nil value for db.name attribute #744
+
+### v0.17.0 / 2021-04-22
+
+* (No significant changes)
+
 ### v0.16.0 / 2021-03-17
 
-* FIXED: Update DB semantic conventions 
-* FIXED: Example scripts now reference local common lib 
+* FIXED: Update DB semantic conventions
+* FIXED: Example scripts now reference local common lib
 * ADDED: Configurable obfuscation of sql in mysql2 instrumentation to avoid logging sensitive data
 
 ### v0.15.0 / 2021-02-18
 
-* ADDED: Add instrumentation config validation 
+* ADDED: Add instrumentation config validation
 
 ### v0.14.0 / 2021-02-03
 
@@ -24,12 +45,12 @@
 
 ### v0.11.0 / 2020-12-11
 
-* ADDED: Add peer service config to mysql 
-* FIXED: Copyright comments to not reference year 
+* ADDED: Add peer service config to mysql
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.1 / 2020-12-09
 
-* FIXED: Semantic conventions db.type -> db.system 
+* FIXED: Semantic conventions db.type -> db.system
 
 ### v0.10.0 / 2020-12-03
 
@@ -37,19 +58,19 @@
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Add timeout for force_flush and shutdown 
+* ADDED: Add timeout for force_flush and shutdown
 
 ### v0.8.0 / 2020-10-27
 
-* BREAKING CHANGE: Remove 'canonical' from status codes 
+* BREAKING CHANGE: Remove 'canonical' from status codes
 
-* FIXED: Remove 'canonical' from status codes 
+* FIXED: Remove 'canonical' from status codes
 
 ### v0.7.0 / 2020-10-07
 
-* DOCS: Standardize toplevel docs structure and readme 
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/README.md

@@ -36,8 +36,8 @@ end
 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 enable_sql_obfuscation to true.
-    enable_sql_obfuscation: false,
+    # To enable, set db_statement to :obfuscate.
+    db_statement: :obfuscate,
   }
 end
 ```

data/lib/opentelemetry/instrumentation/mysql2.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation

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

@@ -10,7 +10,15 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the Mysql2
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        install do |_config|
+        install do |config|
+          if config[:enable_sql_obfuscation]
+            config[:db_statement] = :obfuscate
+            OpenTelemetry.logger.warn(
+              'Instrumentation mysql2 configuration option enable_sql_obfuscation has been deprecated,' \
+              'use db_statement option instead'
+            )
+          end
+
           require_dependencies
           patch_client
         end
@@ -21,6 +29,7 @@ module OpenTelemetry
 
         option :peer_service, default: nil, validate: :string
         option :enable_sql_obfuscation, default: false, validate: :boolean
+        option :db_statement, default: :include, validate: ->(opt) { %I[omit include obfuscate].include?(opt) }
 
         private
 

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

@@ -51,11 +51,16 @@ module OpenTelemetry
           ].freeze
 
           def query(sql, options = {})
+            attributes = client_attributes
+            case config[:db_statement]
+            when :include
+              attributes['db.statement'] = sql
+            when :obfuscate
+              attributes['db.statement'] = obfuscate_sql(sql)
+            end
             tracer.in_span(
               database_span_name(sql),
-              attributes: client_attributes.merge(
-                'db.statement' => obfuscate_sql(sql)
-              ),
+              attributes: attributes,
               kind: :client
             ) do
               super(sql, options)
@@ -65,8 +70,6 @@ module OpenTelemetry
           private
 
           def obfuscate_sql(sql)
-            return sql unless config[:enable_sql_obfuscation]
-
             if sql.size > 2000
               'SQL query too large to remove sensitive data ...'
             else
@@ -119,10 +122,10 @@ module OpenTelemetry
 
             attributes = {
               'db.system' => 'mysql',
-              'db.name' => database_name,
               'net.peer.name' => host,
               'net.peer.port' => port
             }
+            attributes['db.name'] = database_name if database_name
             attributes['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.16.0'
+      VERSION = '0.19.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 1.0.0.rc3
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -171,10 +213,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.16.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.19.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/mysql2
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.16.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.19.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -190,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Mysql2 instrumentation for the OpenTelemetry framework