opentelemetry-instrumentation-mongo 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd55b775b9538cf3addb8aa08c1fbbf34d028855ee96bf9999fab9dedd17a47c
-  data.tar.gz: 48347c6004b7daa37081568061a2d7303cfa6ccf4fa60160194f66b3a9a9a4d2
+  metadata.gz: 85f1636546167aa1e9e6603257eeb965dbb08f9c5bc26050c15cc929758e847d
+  data.tar.gz: 15dc6ba2a31cbe827bd81d16edc5aa8a8de6635a3822dba0479adf9de50d61bf
 SHA512:
-  metadata.gz: 191a28783347264e83c5da357e0f573485795ec0737e2f4e67f335df70c1abce587582d4c17dca1f44020d0649bfd1941946dfae744f1350065a3d0169b35a6d
-  data.tar.gz: 10c534b18f976758ac63be01539e51c872b40feabb06a88703a4e6c9f7268c92fb2d7b71a242530ee20cb04292eb96270b06e406928bbe3534f3b0fe36c2a474
+  metadata.gz: '08fd54a2850631ac755508538495dc9fc91507a7827437ca4e046dfaa685eaee3a81c54f3c995bc33d74754e7fda385c4a1fd1f67c362404cf0059a7a219b677'
+  data.tar.gz: e958b40ba06c2f5f28baf26877fba8ecb3056dc600c4068aa71a6d3919434447eba2cddb8f9269e28cc367fe8bf21b1e7696340ef807aae337814b9bcc36b6f0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-mongo
 
+### v0.21.0 / 2022-10-04
+
+* ADDED: Support mongodb db statement without obfuscation 
+
 ### v0.20.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -30,6 +30,20 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
+### Configuration options
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Mongo', {
+    # Sets how db_statement appears in your traces. The options are:
+    # :obfuscate - (default) query parameters are visible, but values are masked.
+    # :include - query parameters and values are both fully visible.
+    # :omit - db_statement is omitted entirely.
+    db_statement: :include,
+  }
+end
+```
+
 ## Example
 
 To run the example:
@@ -57,8 +71,7 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [mongo-home]: https://github.com/mongodb/mongo-ruby-driver
 [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
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
-

data/lib/opentelemetry/instrumentation/mongo/command_serializer.rb

@@ -14,10 +14,10 @@ module OpenTelemetry
 
         attr_reader :command, :command_name, :collection, :payload
 
-        def initialize(command)
+        def initialize(command, obfuscate)
           @command = command
           @command_name, @collection = command.first
-          @collection = MASK_VALUE unless @collection.is_a?(String) || @collection.is_a?(Integer)
+          @obfuscate = obfuscate
           @payload = {}
         end
 
@@ -35,7 +35,7 @@ module OpenTelemetry
           build_pipeline
         end
 
-        def build_command # rubocop:disable Metrics/AbcSize
+        def build_command
           add_val(payload, command, 'key')
           add_map(payload, command, 'query')
           add_map(payload, command, 'filter')
@@ -87,14 +87,21 @@ module OpenTelemetry
 
         def add_map(payload, command, key)
           value = command[key]
-          return unless value&.is_a?(Hash) && !value.empty?
+          return unless value.is_a?(Hash) && !value.empty?
 
           payload[key] = mask(value)
         end
 
         def mask(hash)
           hash.each_with_object({}) do |(k, v), h|
-            h[k] = v.is_a?(Hash) ? mask(v) : MASK_VALUE
+            value = if v.is_a?(Hash)
+                      mask(v)
+                    elsif @obfuscate
+                      MASK_VALUE
+                    else
+                      v
+                    end
+            h[k] = value
           end
         end
       end

data/lib/opentelemetry/instrumentation/mongo/instrumentation.rb

@@ -25,7 +25,7 @@ module OpenTelemetry
         end
 
         option :peer_service, default: nil, validate: :string
-        option :db_statement, default: :include, validate: %I[omit include]
+        option :db_statement, default: :obfuscate, validate: %I[omit obfuscate include]
 
         private
 

data/lib/opentelemetry/instrumentation/mongo/subscriber.rb

@@ -13,7 +13,7 @@ module OpenTelemetry
       class Subscriber
         THREAD_KEY = :__opentelemetry_mongo_spans__
 
-        def started(event) # rubocop:disable Metrics/AbcSize
+        def started(event)
           # start a trace and store it in the current thread; using the `operation_id`
           # is safe since it's a unique id used to link events together. Also only one
           # thread is involved in this execution so thread-local storage should be safe. Reference:
@@ -33,7 +33,9 @@ module OpenTelemetry
           config = Mongo::Instrumentation.instance.config
           attributes['peer.service'] = config[:peer_service] if config[:peer_service]
           # attributes['db.statement'] = CommandSerializer.new(event.command).serialize
-          attributes['db.statement'] = CommandSerializer.new(event.command).serialize if config[:db_statement] == :include
+          omit = config[:db_statement] == :omit
+          obfuscate = config[:db_statement] == :obfuscate
+          attributes['db.statement'] = CommandSerializer.new(event.command, obfuscate).serialize unless omit
           attributes['db.mongodb.collection'] = collection if collection
           attributes.compact!
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mongo
-      VERSION = '0.20.0'
+      VERSION = '0.21.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mongo
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -238,14 +252,14 @@ files:
 - lib/opentelemetry/instrumentation/mongo/instrumentation.rb
 - lib/opentelemetry/instrumentation/mongo/subscriber.rb
 - lib/opentelemetry/instrumentation/mongo/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mongo/v0.20.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/mongo
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mongo/v0.20.0
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-mongo/v0.21.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/mongo
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-mongo/v0.21.0
 post_install_message: 
 rdoc_options: []
 require_paths: