opentelemetry-instrumentation-mysql2 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61e1097f36ce3b194cdf0df01e5669c9a6db74f6d5556adc9f29900cabab1d62
-  data.tar.gz: a73c48dd8d12739d91a5dd28ad8cf86ff217d31fc1641b30fabd99ef8ba47628
+  metadata.gz: 1690259e4fa76fd5b47ed40623566ff95db2ff7a5725664b848659e99e8fd7aa
+  data.tar.gz: 9481697fefee3ff4510ef582baa3b6077896ba32c424e5e7d9ddac2975d31fdb
 SHA512:
-  metadata.gz: 11e4c2378b2e6b8bcd77e6904911107a0df57e1782041c4cfdc98e3351f7e11086e069aeaeaf327dc608ea388e4639d0a8c4bee449909f9ff30733d56e27487a
-  data.tar.gz: 9ba36566d8841a8fff30bcf09a23fe6aedc3dc43e19ca8967980b3699bece98ac2341c37cfbfa03632e3c65f7c9a8890c81bd6788cd277928fd467331ec7c108
+  metadata.gz: 9de39b45e35992bb4ab98c45255b1ae10c1fc1611c6f3fe9d22be36249f84723016ab9c5f2a67b7c6da0e4e68b94f72f27870ef1158b6d50c2dcb0f95cb2c59f
+  data.tar.gz: 6488cbd8592d7f56cc91db102d234b6de537bf11d98991412d0be860500184bcb1a4b6fe0a7d738b1eeb18cabd72dad82f0962a41e157003f7dbdc2e2298933c

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.20.0 / 2021-12-01
+
+* ADDED: Add default options config helper + env var config option support 
+
+### v0.19.1 / 2021-09-29
+
+* (No significant changes)
+
+### 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

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/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: %I[omit include obfuscate]
 
         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

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.18.0'
+      VERSION = '0.20.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
+- !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
@@ -185,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.18.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.20.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.18.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.20.0
 post_install_message: 
 rdoc_options: []
 require_paths: