opentelemetry-instrumentation-mongo 0.16.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41d8a759a1cd548529ef959337c09aca97444ae56769d40640695c0b3ed87d09
-  data.tar.gz: 56ad71e94332ee8a4844ce372c4bee11344f7621c78d0ec23fd3a9790c761726
+  metadata.gz: 24bf5fab8314c837b21a92ce2e00d248873f3ccaa6e77491bcac0e212a0c75e1
+  data.tar.gz: f09676d1b97f859520a814bfb4ecaee0b26da7584d4a809310a863fab5dcb47f
 SHA512:
-  metadata.gz: 5779498ffddb9613c115b2b93c842c4adf67ca8d6b375d122580beff511a5f39e050240df513916aaf36d9e107ac907a717a1b2777ccff2ab30c75fc0885c57c
-  data.tar.gz: d246e243ed98f7bb5e79543d9d58f97a00ad7c532d0d0e93f5b9afc1c39620f1e3a8bfb6af541e5ceaa3925751a109c277a839bba9e6c86dfd5d3e5ec8e921b3
+  metadata.gz: b47188d748b610b4296b2286acd93164f41d56b5462beee805c4347cc85613f997601df98472922405cbb8fe785315438700071ba3e0a06693680bced1d3731f
+  data.tar.gz: '0090d4aee3839e7938a25ecff4739a42bc6e6bcb6721799b427c53b1b3f75f4f89da6489d05e48dc2bd5937f4b66ecbd75b43462e8f4069fdbb77e82a0330f0e'

data/CHANGELOG.md

@@ -1,9 +1,31 @@
 # Release History: opentelemetry-instrumentation-mongo
 
+### v0.18.2 / 2021-08-12
+
+* FIXED: Flakey mongo test 
+
+### v0.18.1 / 2021-06-23
+
+* (No significant changes)
+
+### v0.18.0 / 2021-05-21
+
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* FIXED: Replace Time.now with Process.clock_gettime
+* FIXED: Mongodb test asserting error message
+
+### v0.17.0 / 2021-04-22
+
+* ADDED: Mongo instrumentation accepts peer service config attribute.
+* FIXED: Fix Mongo instrumentation example.
+* FIXED: Refactor propagators to add #fields
+
 ### v0.16.0 / 2021-03-17
 
-* FIXED: Example scripts now reference local common lib 
-* DOCS: Replace Gitter with GitHub Discussions 
+* FIXED: Example scripts now reference local common lib
+* DOCS: Replace Gitter with GitHub Discussions
 
 ### v0.15.0 / 2021-02-18
 
@@ -11,13 +33,13 @@
 
 ### v0.14.0 / 2021-02-03
 
-* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators 
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
 
-* ADDED: Replace getter and setter callables and remove rack specific propagators 
+* ADDED: Replace getter and setter callables and remove rack specific propagators
 
 ### v0.13.0 / 2021-01-29
 
-* FIXED: Mongo Instrumenter: Do not send nil attributes 
+* FIXED: Mongo Instrumenter: Do not send nil attributes
 
 ### v0.12.0 / 2020-12-24
 
@@ -25,7 +47,7 @@
 
 ### v0.11.0 / 2020-12-11
 
-* FIXED: Copyright comments to not reference year 
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.0 / 2020-12-03
 
@@ -33,4 +55,4 @@
 
 ### v0.9.0 / 2020-11-03
 
-* Initial release of Mongo instrumenter (ported from Datadog)
+* Initial release of Mongo instrumenter (ported from Datadog)

data/README.md

@@ -30,9 +30,19 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
-## Examples
+## Example
 
-Example usage of mongo can be seen in the `./example/mongo.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/mongo/example/mongo.rb)
+To run the example:
+
+1. Start MongoDB using docker-compose
+	* `docker-compose up mongo`
+2. In a separate terminal window, `cd` to the examples directory and install gems
+	* `cd example`
+	* `bundle install`
+3. Run the sample client script
+	* `ruby mongo.rb`
+
+This will run a few MongoDB commands, printing OpenTelemetry traces to the console as it goes.
 
 ## How can I get involved?
 
@@ -51,3 +61,4 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [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.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/mongo/instrumentation.rb

@@ -24,6 +24,9 @@ module OpenTelemetry
           gem_version >= MINIMUM_VERSION
         end
 
+        option :peer_service, default: nil, validate: :string
+        option :db_statement, default: :include, validate: ->(opt) { %I[omit include].include?(opt) }
+
         private
 
         def gem_version

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

@@ -13,15 +13,30 @@ module OpenTelemetry
       class Subscriber
         THREAD_KEY = :__opentelemetry_mongo_spans__
 
-        def started(event)
+        def started(event) # rubocop:disable Metrics/AbcSize
           # 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:
           # https://github.com/mongodb/mongo-ruby-driver/blob/master/lib/mongo/monitoring.rb#L70
           # https://github.com/mongodb/mongo-ruby-driver/blob/master/lib/mongo/monitoring/publishable.rb#L38-L56
+
           collection = get_collection(event.command)
-          attributes = build_attributes(event)
+
+          attributes = {
+            'db.system' => 'mongodb',
+            'db.name' => event.database_name,
+            'db.operation' => event.command_name,
+            'net.peer.name' => event.address.host,
+            'net.peer.port' => event.address.port
+          }
+
+          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
           attributes['db.mongodb.collection'] = collection if collection
+          attributes.compact!
+
           span = tracer.start_span(span_name(collection, event.command_name), attributes: attributes, kind: :client)
           set_span(event, span)
         end
@@ -63,17 +78,6 @@ module OpenTelemetry
           "#{collection}.#{command_name}"
         end
 
-        def build_attributes(event)
-          {
-            'db.system' => 'mongodb',
-            'db.name' => event.database_name,
-            'db.operation' => event.command_name,
-            'db.statement' => CommandSerializer.new(event.command).serialize,
-            'net.peer.name' => event.address.host,
-            'net.peer.port' => event.address.port
-          }.compact
-        end
-
         def get_collection(command)
           collection = command.values.first
           collection if collection.is_a?(String)

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mongo
-      VERSION = '0.16.0'
+      VERSION = '0.18.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mongo
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.2
 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: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -200,10 +242,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-mongo/v0.16.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mongo/v0.18.2/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.16.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mongo/v0.18.2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -219,7 +261,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: Mongo instrumentation for the OpenTelemetry framework