mongo_active_instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04b56eebdb82174cb02f053a589eb0e4d5cbe6ea
+  data.tar.gz: b8702f3bcbb1f3ad89bb8f93cdc11e0528df09e1
+SHA512:
+  metadata.gz: 3bd2e1fcb21e0b4c5af5cf5461d367ebceab08ffadcb22e65f485b45941b82c645acf6c775058a1a250133dfd1efa42f9084c6c78cf0396421b5b1a3244f3f6a
+  data.tar.gz: 91f8bb11f526049b8894b4ac2d6b5104e899ffd98a04893ced91543280213f17b0f39edfb3f62021cbb72f1fd18ff642b52832efcbf2763e04796279bb20ee11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Edgars Beigarts
+
+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,38 @@
+# Mongo Active Instrumentation
+
+Pretty logging with colors for mongo/mongoid with rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongo_active_instrumentation'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Example
+
+```
+Started GET "/" for ::1
+Processing by PagesController#show as HTML
+  Parameters: {"path"=>"/"}
+  Mongo (2.1ms)  {"find"=>"users", "filter"=>{"deleted_at"=>nil, "_id"=>BSON::ObjectId('4f796a9e83fa26bacf000360')}, "limit"=>1, "singleBatch"=>true}
+Completed 200 OK in 54ms (Views: 9.7ms | Mongo: 2.1ms)
+```
+
+vs
+
+```
+Started GET "/" for ::1
+Processing by PagesController#show as HTML
+  Parameters: {"path"=>"/"}
+MONGODB | localhost:27017 | app_development.find | STARTED | {"find"=>"users", "filter"=>{"deleted_at"=>nil, "_id"=>BSON::ObjectId('4f796a9e83fa26bacf000360')}, "limit"=>1, "singleBatch"=>true}
+MONGODB | localhost:27017 | app_development.find | SUCCEEDED | 0.0021879999999999998s
+Completed 200 OK in 54ms (Views: 9.7ms)
+```

data/lib/mongo_active_instrumentation.rb

@@ -0,0 +1,6 @@
+require 'active_support'
+require 'mongo_active_instrumentation/log_subscriber'
+require 'mongo_active_instrumentation/railtie' if defined?(Rails)
+
+module MongoActiveInstrumentation
+end

data/lib/mongo_active_instrumentation/controller_runtime.rb

@@ -0,0 +1,50 @@
+require "active_support/core_ext/module/attr_internal"
+require "active_record/log_subscriber"
+
+module MongoActiveInstrumentation
+  module ControllerRuntime #:nodoc:
+    extend ActiveSupport::Concern
+
+    protected
+
+    attr_internal :mongo_runtime
+
+    private
+
+    def process_action(action, *args)
+      # We also need to reset the runtime before each action
+      # because of queries in middleware or in cases we are streaming
+      # and it won't be cleaned up by the method below.
+      MongoActiveInstrumentation::LogSubscriber.reset_runtime
+      super
+    end
+
+    def cleanup_view_runtime
+      if logger && logger.info? && ActiveRecord::Base.connected?
+        mongo_rt_before_render = MongoActiveInstrumentation::LogSubscriber.reset_runtime
+        self.mongo_runtime = (mongo_runtime || 0) + mongo_rt_before_render
+        runtime = super
+        mongo_rt_after_render = MongoActiveInstrumentation::LogSubscriber.reset_runtime
+        self.mongo_runtime += mongo_rt_after_render
+        runtime - mongo_rt_after_render
+      else
+        super
+      end
+    end
+
+    def append_info_to_payload(payload)
+      super
+      if ActiveRecord::Base.connected?
+        payload[:mongo_runtime] = (mongo_runtime || 0) + MongoActiveInstrumentation::LogSubscriber.reset_runtime
+      end
+    end
+
+    module ClassMethods # :nodoc:
+      def log_process_action(payload)
+        messages, mongo_runtime = super, payload[:mongo_runtime]
+        messages << ("Mongo: %.1fms" % mongo_runtime.to_f) if mongo_runtime
+        messages
+      end
+    end
+  end
+end

data/lib/mongo_active_instrumentation/log_subscriber.rb

@@ -0,0 +1,67 @@
+module MongoActiveInstrumentation
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def self.runtime=(value)
+      Thread.current["mongo_runtime"] = value
+    end
+
+    def self.runtime
+      Thread.current["mongo_runtime"] ||= 0
+    end
+
+    def self.reset_runtime
+      rt, self.runtime = runtime, 0
+      rt
+    end
+
+    def initialize(options = {})
+      super()
+      @events = {}
+    end
+
+    def started(event)
+      return unless logger.debug?
+      @events[event.request_id] = event
+    end
+
+    def succeeded(event)
+      return unless logger.debug?
+      completed event, CYAN
+    end
+
+    def failed(event)
+      return unless logger.debug?
+      completed event, RED
+    end
+
+    private
+
+    def completed(event, name_color)
+      started_event = @events.delete(event.request_id)
+      if started_event
+        duration = event.duration * 1000
+        self.class.runtime += duration
+        command_name = started_event.command_name.to_s
+        name  = "Mongo (#{(duration).round(1)}ms)"
+        name  = color(name, name_color, true)
+        command = event.respond_to?(:message) ? event.message : started_event.command.inspect
+        command = color(command, command_color(command_name), true)
+        debug "  #{name}  #{command}"
+      end
+    end
+
+    def command_color(command_name)
+      case command_name
+      when 'find', 'count', 'aggregate'
+        BLUE
+      when 'insert'
+        GREEN
+      when 'update'
+        YELLOW
+      when 'delete'
+        RED
+      else
+        MAGENTA
+      end
+    end
+  end
+end

data/lib/mongo_active_instrumentation/railtie.rb

@@ -0,0 +1,23 @@
+require 'mongo_active_instrumentation/controller_runtime'
+
+module MongoActiveInstrumentation
+  class Railtie < Rails::Railtie
+    initializer "mongo_active_instrumentation" do |app|
+      Mongo::Monitoring::Global.subscribe(
+        Mongo::Monitoring::COMMAND,
+        MongoActiveInstrumentation::LogSubscriber.new
+      )
+
+      # Disable the existing log subscriber
+      Mongo::Monitoring::CommandLogSubscriber.class_eval do
+        def started(event); end
+        def succeeded(event); end
+        def failed(event); end
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        include MongoActiveInstrumentation::ControllerRuntime
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mongo_active_instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edgars Beigarts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: ActiveSupport/Rails instrumentation for Mongo
+email:
+- edgars.beigarts@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/mongo_active_instrumentation.rb
+- lib/mongo_active_instrumentation/controller_runtime.rb
+- lib/mongo_active_instrumentation/log_subscriber.rb
+- lib/mongo_active_instrumentation/railtie.rb
+homepage: https://github.com/ebeigarts/mongo_active_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.5.2
+signing_key: 
+specification_version: 4
+summary: ActiveSupport/Rails instrumentation for Mongo
+test_files: []