mongodb-instrumentation 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 268adbea20ad896adceac9cda531c99d3fb616f2
+  data.tar.gz: da508f03465be829d2fab469182ac21b2e1d65d6
+SHA512:
+  metadata.gz: ab6ed51e8e89dd95637acdb3fb445e3da9667a6d5fffaaf314d8e4d0734b3d3388b80083b81e9030cf4a39c90b4b6da7bf43f5068f3d141a7b21c425bfc0afcd
+  data.tar.gz: 332124ec50735a62b42efa54451a174f04d1771e3f307f2b1351a4a580def54c466c8bd6378850be17cb518d413df6430d6286cedf50b01070c13b3948abee81

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'mongo-latest' do
+  gem 'mongo'
+end
+
+appraise 'mongo-2.5.0' do
+  gem 'mongo', '2.5.0'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mongodb-instrumentation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ashwin Chandrasekar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Mongodb::Instrumentation
+
+This gem provides auto-instrumentation for the MongoDB Ruby Driver by subscribing to Monitoring notifications.
+
+## Supported Versions
+
+- MRI 2.0 and newer
+- mongo 2.1 and newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongodb-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongodb-instrumentation
+
+## Usage
+
+To enable instrumentation, simply add this line of code:
+
+```ruby
+require 'mongodb/instrumentation'
+
+MongoDB::Instrumentation.instrument
+```
+
+The `instrument` method optionally takes a `tracer` argument to explicitly
+set the tracer to use. If not provided, the instrumentation will default to the
+OpenTracing global tracer.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Unit tests
+
+Run the RSpec tests with
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/signalfx/ruby-mongodb-instrumentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongodb/instrumentation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongodb/instrumentation.rb

@@ -0,0 +1,13 @@
+require "mongodb/instrumentation/version"
+require "mongodb/instrumentation/command_subscriber"
+require "opentracing"
+
+module MongoDB
+  module Instrumentation
+    class << self
+      def instrument(tracer: OpenTracing.global_tracer)
+        Mongo::Monitoring::Global.subscribe(Mongo::Monitoring::COMMAND, MongoDB::Instrumentation::CommandSubscriber.new(tracer: tracer))
+      end
+    end
+  end
+end

data/lib/mongodb/instrumentation/command_subscriber.rb

@@ -0,0 +1,59 @@
+module MongoDB
+  module Instrumentation
+    class CommandSubscriber
+
+      attr_reader :requests
+
+      def initialize(tracer: OpenTracing.global_tracer)
+        @tracer = tracer
+
+        @requests = {}
+      end
+
+      def started(event)
+        # start command span
+        tags = {
+          # opentracing tags
+          'component' => 'ruby-mongodb',
+          'db.instance' => event.database_name,
+          'db.statement' => event.command,
+          'db.type' => 'mongo',
+          'span.kind' => 'client',
+
+          # extra info
+          'mongo.command.name' => event.command_name,
+          'mongo.operation.id' => event.operation_id,
+          'mongo.request.id' => event.request_id,
+        }
+        span =@tracer.start_span(event.command_name, tags: tags)
+
+        @requests[event.request_id] = span
+      end
+
+      def succeeded(event)
+        return if @requests[event.request_id].nil?
+
+        # tag the reported duration, in case it differs from what we saw
+        # through the notifications times
+        span = @requests[event.request_id]
+        span.set_tag("took.ms", event.duration * 1000)
+
+        span.finish()
+        @requests.delete(event.request_id)
+      end
+
+      def failed(event)
+        return if @requests[event.request_id].nil?
+
+        # tag the reported duration and any error message that came through
+        span = @requests[event.request_id]
+        span.set_tag("took.ms", event.duration * 1000)
+        span.set_tag("error", true)
+        span.log_kv(key: "message", value: event.message)
+
+        span.finish()
+        @requests.delete(event.request_id)
+      end
+    end
+  end
+end

data/lib/mongodb/instrumentation/version.rb

@@ -0,0 +1,5 @@
+module Mongodb
+  module Instrumentation
+    VERSION = "0.1.1"
+  end
+end

data/mongodb-instrumentation.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongodb/instrumentation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongodb-instrumentation"
+  spec.version       = Mongodb::Instrumentation::VERSION
+  spec.authors       = ["Ashwin Chandrasekar"]
+  spec.email         = ["achandrasekar@signalfx.com"]
+
+  spec.summary       = %q{Instrumentation for MongoDB}
+  spec.description   = %q{OpenTracing auto-instrumentation for applications using the MongoDB Ruby driver.}
+  spec.homepage      = "http://github.com/signalfx/ruby-mongodb-instrumentation"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+  spec.add_development_dependency "mongo", "~> 2.6.2"
+end

data/test_app/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'jaeger-client'
+gem 'mongo'
+gem 'mongodb-instrumentation'

data/test_app/test.rb

@@ -0,0 +1,76 @@
+require 'jaeger/client'
+require 'jaeger/client/http_sender'
+require 'mongo'
+require 'mongodb/instrumentation'
+
+def list_all(collection)
+  collection.find.each do |document|
+    puts document
+  end
+end
+
+# set up the exporter
+ingest_url = "http://localhost:14268/api/traces"
+service_name = "mongodb-test"
+headers = { }
+encoder = Jaeger::Client::Encoders::ThriftEncoder.new(service_name: service_name)
+http_sender = Jaeger::Client::HttpSender.new(url: ingest_url, headers: headers, encoder: encoder)
+OpenTracing.global_tracer = Jaeger::Client.build(service_name: service_name, sender: http_sender)
+
+# set up the instrumentation
+MongoDB::Instrumentation.instrument
+
+# suppress the logs, since the default makes reading the output difficult
+Mongo::Logger.logger.level = ::Logger::FATAL
+
+# create a connection to the local mongo instance
+client = Mongo::Client.new([ '127.0.0.1:27017' ], :database => 'testdb')
+
+# print collections directly
+client.collections.each { |coll| puts coll.name }
+
+# print collections by accessing a database
+db = client.database
+puts db.collection_names
+
+# insert document
+collection = client[:test_collection]
+doc = { name: 'Test', value: 'TestValue'}
+result = collection.insert_one(doc)
+puts "Inserted #{result.n} document"
+
+# insert many documents
+docs = []
+for i in 1..10 do
+  docs << { name: "Test#{i}", value: "Value#{i}"}
+end
+result = collection.insert_many(docs)
+puts "Inserted #{result.inserted_count} documents"
+
+# query all documents
+list_all(collection)
+
+# update
+result = collection.update_many( {}, { '$set' => { 'value' => 'test_updated' } } )
+puts "Modified #{result.modified_count} documents"
+
+# query
+list_all(collection)
+
+# delete document
+result = collection.delete_one( { name: 'Test' } )
+puts "Deleted #{result.deleted_count}"
+list_all(collection)
+result = collection.delete_many( { name: /Test/ } )
+puts "Deleted #{result.deleted_count}"
+
+list_all(collection)
+
+documents = collection.find(:name => 'Test').skip(10).limit(10)
+
+# delete the collection and close the connection
+collection.drop
+client.close
+
+# sleep to let the Jaeger spans finish sending
+sleep(10)

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: mongodb-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ashwin Chandrasekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: opentracing_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: OpenTracing auto-instrumentation for applications using the MongoDB Ruby
+  driver.
+email:
+- achandrasekar@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongodb/instrumentation.rb
+- lib/mongodb/instrumentation/command_subscriber.rb
+- lib/mongodb/instrumentation/version.rb
+- mongodb-instrumentation.gemspec
+- test_app/Gemfile
+- test_app/test.rb
+homepage: http://github.com/signalfx/ruby-mongodb-instrumentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Instrumentation for MongoDB
+test_files: []