opentelemetry-instrumentation-mysql2 0.13.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4926ca7202e794242371d84dfef388bc4cf32310d6884a5963b914e4fdb0f07b
-  data.tar.gz: 9c078e326c93b76e5f09a480d1af3cba910cffa622a8397fbec9d30f31b63267
+  metadata.gz: 61e1097f36ce3b194cdf0df01e5669c9a6db74f6d5556adc9f29900cabab1d62
+  data.tar.gz: a73c48dd8d12739d91a5dd28ad8cf86ff217d31fc1641b30fabd99ef8ba47628
 SHA512:
-  metadata.gz: 7390cb9ade24cf16ac17a30bd7be9b40c6511a9cc5bbcbc14a9e1660709467581f33123afc423944ca2762c8b10c449f02d7117103e9684953a67db71bfad18c
-  data.tar.gz: 1aac4ddc2e96e1c9695a5c803b6c90185b5e5109f6f7f00978f5a2b73fa9effbf42c5bfab662edf9e6a94838acc7452dbb594effa9bb829ff77bdae7e7b7d973
+  metadata.gz: 11e4c2378b2e6b8bcd77e6904911107a0df57e1782041c4cfdc98e3351f7e11086e069aeaeaf327dc608ea388e4639d0a8c4bee449909f9ff30733d56e27487a
+  data.tar.gz: 9ba36566d8841a8fff30bcf09a23fe6aedc3dc43e19ca8967980b3699bece98ac2341c37cfbfa03632e3c65f7c9a8890c81bd6788cd277928fd467331ec7c108

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### 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
+* ADDED: Configurable obfuscation of sql in mysql2 instrumentation to avoid logging sensitive data
+
+### v0.15.0 / 2021-02-18
+
+* ADDED: Add instrumentation config validation
+
+### v0.14.0 / 2021-02-03
+
+* (No significant changes)
+
 ### v0.13.0 / 2021-01-29
 
 * (No significant changes)
@@ -10,12 +33,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
 
@@ -23,19 +46,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

@@ -0,0 +1,65 @@
+# OpenTelemetry Mysql2 Instrumentation
+
+The OpenTelemetry Mysql2 Ruby gem is a community maintained instrumentation for [Mysql2][mysql2-home].
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-mysql2
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-mysql2` in your `Gemfile`.
+
+## Usage
+
+To use the instrumentation, call `use` with the name of the instrumentation:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Mysql2'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+### Configuration options
+
+```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 enable_sql_obfuscation to true.
+    enable_sql_obfuscation: false,
+  }
+end
+```
+
+## Examples
+
+An example of usage can be seen in [`example/mysql2.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/mysql2/example/mysql2.rb).
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-mysql2` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
+
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+
+## License
+
+The `opentelemetry-instrumentation-mysql2` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[mysql2-home]: https://github.com/brianmario/mysql2
+[bundler-home]: https://bundler.io
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby

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

@@ -19,6 +19,9 @@ module OpenTelemetry
           defined?(::Mysql2)
         end
 
+        option :peer_service, default: nil, validate: :string
+        option :enable_sql_obfuscation, default: false, validate: :boolean
+
         private
 
         def require_dependencies

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

@@ -30,11 +30,31 @@ module OpenTelemetry
 
           QUERY_NAME_RE = Regexp.new("^(#{QUERY_NAMES.join('|')})", Regexp::IGNORECASE)
 
+          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
+
           def query(sql, options = {})
             tracer.in_span(
               database_span_name(sql),
               attributes: client_attributes.merge(
-                'db.statement' => sql
+                'db.statement' => obfuscate_sql(sql)
               ),
               kind: :client
             ) do
@@ -44,6 +64,31 @@ 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
+              obfuscated = sql.gsub(generated_mysql_regex, '?')
+              obfuscated = 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if detect_unmatched_pairs(obfuscated)
+              obfuscated
+            end
+          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)
             # Setting span name to the SQL query without obfuscation would
             # result in PII + cardinality issues.
@@ -74,11 +119,10 @@ module OpenTelemetry
 
             attributes = {
               'db.system' => 'mysql',
-              'db.instance' => database_name,
-              'db.url' => "mysql://#{host}:#{port}",
               '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.13.0'
+      VERSION = '0.18.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.18.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-05-21 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.13.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ 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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +174,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-mysql2.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/mysql2.rb
@@ -170,10 +185,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.13.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.18.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.13.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.18.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -189,7 +204,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