mongo_logs_on_roids 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2dc3e286069213c9fd659853527b025e790c549
+  data.tar.gz: e7f1c201e0a22fed17675e183435ee0839730c2a
+SHA512:
+  metadata.gz: bf7e529c572148a86d9dcb8998edb6a8bfb80b6c576a2abc5f69aae3cfd6d8d6e15f5a14e81dacc4218921c694d902ab569f82e300195f9d4546b4d12382264e
+  data.tar.gz: df0da61a49b27c6d790f30f59ccf5eb7a25f1630891e3192ca753b3be375ced585bf6cfae1c873c39b8574ad7915a453e9de4df4fe6b6826ad730c3586f0118c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo_logs_on_roids.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 thomas morgan
+
+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,43 @@
+# MongoLogsOnRoids
+
+Better logging for mongodb on Ruby.
+
+Compatible with just the `mongo` gem (v2.1+). Auto-detects Mongoid 5 and Rails and enables appropriate features.
+
+Makes mongo logs more awesome with:
+
+* Colorized logging
+* Calculating and displaying total time in mongo (Rails):
+  `Completed 200 OK in 13ms (Views: 0.2ms | Mongo: 3.2ms)`
+* Showing mongo logs in console, for faster debugging
+
+
+## Installation
+
+Install like any other gem. Add to your Gemfile:
+
+```ruby
+gem 'mongo_logs_on_roids'
+```
+
+
+## Usage
+
+Under normal circumstances, should activate itself automatically.
+
+<!-- ## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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). -->
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zarqman/mongo_logs_on_roids.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Inspired by [mongoid_colored_logger](https://github.com/romanbsd/mongoid_colored_logger), by Roman Shterenzon (thanks!).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongo_logs_on_roids"
+
+# 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

data/bin/setup

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

data/lib/mongo_logs_on_roids/colorize_command_log.rb

@@ -0,0 +1,69 @@
+module MongoLogsOnRoids
+  module ColorizeCommandLog
+
+    CLEAR   = "\e[0m"
+    BOLD    = "\e[1m"
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
+
+    def started(event)
+      if logger.debug?
+        log_debug("#{prefix(event)} | #{MAGENTA}STARTED#{BLUE} | #{format_command(event.command)}")
+      end
+    end
+
+    def succeeded(event)
+      if logger.debug?
+        log_debug("#{prefix(event)} | #{BOLD}#{GREEN}SUCCEEDED#{CLEAR}#{BLUE} | #{'%.3f' % (event.duration*1000)}ms")
+      end
+    end
+
+    def failed(event)
+      if logger.debug?
+        log_debug("#{prefix(event)} | #{RED}FAILED#{BLUE} | #{YELLOW}#{event.message}#{BLUE} | #{'%.3f' % (event.duration*1000)}ms")
+      end
+    end
+
+
+    private
+
+    def format_command(args)
+      message = super
+      WHITE+message.gsub(/=>/){|m| MAGENTA+m+WHITE }+BLUE
+      # message.gsub(/\[?\{.+?\}\]?(\s|$)/) do |m|
+      #   m.gsub!(/=>/) {|m2| color(m2, MAGENTA) + WHITE }
+      #   color(m, WHITE)+BLUE
+      # end
+    end
+
+    PREFIX = Mongo::Loggable::PREFIX
+
+    def format_message(message)
+      format("#{BLUE}%s | %s#{CLEAR}".freeze, PREFIX, message)
+    end
+
+    def prefix(event)
+      "#{event.address.to_s} | #{CYAN}#{event.database_name}#{BLUE}.#{YELLOW}#{event.command_name}#{BLUE}"
+    end
+
+
+    # def color(text, color, bold=false)
+    #   # return text unless colorize_logging
+    #   color = self.class.const_get(color.upcase) if color.is_a?(Symbol)
+    #   bold  = bold ? BOLD : ""
+    #   "#{bold}#{color}#{text}#{CLEAR}"
+    # end
+    # def color(text, color, bold=false)
+    #   color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+    #   "#{BOLD if bold}#{color}#{text}#{CLEAR}"
+    # end
+
+  end
+end

data/lib/mongo_logs_on_roids/railtie.rb

@@ -0,0 +1,17 @@
+module MongoLogsOnRoids
+  class Railtie < Rails::Railtie
+
+    ActiveSupport.on_load(:action_controller) do
+      Mongo::Monitoring::Global.subscribe(Mongo::Monitoring::COMMAND, MongoLogsOnRoids::RuntimeSubscriber.new)
+      include MongoLogsOnRoids::ControllerRuntime
+    end
+
+    console do |app|
+      Mongo::Logger.logger = Logger.new($stdout)
+      if defined?(Mongoid)
+        config.mongoid.logger = Mongo::Logger.logger
+      end
+    end
+
+  end
+end

data/lib/mongo_logs_on_roids/runtime_subscriber.rb

@@ -0,0 +1,75 @@
+require 'active_support/log_subscriber'
+
+module MongoLogsOnRoids
+  class RuntimeSubscriber < ActiveSupport::LogSubscriber
+
+    class << self
+      def runtime=(value)
+        Thread.current['mongo_runtime'] = value
+      end
+
+      def runtime
+        Thread.current['mongo_runtime'] ||= 0
+      end
+
+      def reset_runtime
+        rt, self.runtime = runtime, 0
+        rt
+      end
+    end
+
+
+    def started(event)
+      # noop
+    end
+    def succeeded(event)
+      self.class.runtime += event.duration*1000
+    end
+    def failed(event)
+      self.class.runtime += event.duration*1000
+    end
+  end
+
+  # Extends ActionController's logging system so as to include
+  #   cumulative runtime at the end of each action's log entry.
+  # See ActiveRecord::Railties::ControllerRuntime for reference
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+    protected
+
+    attr_internal :runtime
+
+    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.
+      MongoLogsOnRoids::RuntimeSubscriber.reset_runtime
+      super
+    end
+
+    def cleanup_view_runtime
+      rt_before_render = MongoLogsOnRoids::RuntimeSubscriber.reset_runtime
+      self.runtime = (runtime || 0) + rt_before_render
+      runtime = super
+      rt_after_render = MongoLogsOnRoids::RuntimeSubscriber.reset_runtime
+      self.runtime += rt_after_render
+      runtime - rt_after_render
+    end
+
+    def append_info_to_payload(payload)
+      super
+      payload[:mongo_runtime] = (runtime || 0) + MongoLogsOnRoids::RuntimeSubscriber.reset_runtime
+    end
+
+
+    module ClassMethods
+      def log_process_action(payload)
+        messages, rt = super, payload[:mongo_runtime]
+        messages << ("Mongo: %.1fms" % rt.to_f) if rt && rt > 0
+        messages
+      end
+    end
+
+  end
+end

data/lib/mongo_logs_on_roids/version.rb

@@ -0,0 +1,3 @@
+module MongoLogsOnRoids
+  VERSION = '1.0.0'
+end

data/lib/mongo_logs_on_roids.rb

@@ -0,0 +1,11 @@
+require 'mongo'
+
+require 'mongo_logs_on_roids/version'
+require 'mongo_logs_on_roids/colorize_command_log'
+
+Mongo::Monitoring::CommandLogSubscriber.prepend MongoLogsOnRoids::ColorizeCommandLog
+
+if defined?(Rails)
+  require 'mongo_logs_on_roids/runtime_subscriber'
+  require 'mongo_logs_on_roids/railtie'
+end

data/mongo_logs_on_roids.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_logs_on_roids/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongo_logs_on_roids"
+  spec.version       = MongoLogsOnRoids::VERSION
+  spec.authors       = ["thomas morgan"]
+  spec.email         = ["tm@iprog.com"]
+
+  spec.summary       = %q{Better logging for mongodb. Compatible w/Mongoid 5, Rails, etc.}
+  spec.description   = %q{Add color, DB time (Rails), etc to your mongo logs. Requires just mongo gem; compatible with Mongoid 5, Rails, etc.}
+  spec.homepage      = "https://github.com/zarqman/mongo_logs_on_roids"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem 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
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mongoid", "~> 5.0"
+  spec.add_development_dependency "rails", "~> 4.2"
+  spec.add_dependency "mongo", "~> 2.1"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: mongo_logs_on_roids
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- thomas morgan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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'
+description: Add color, DB time (Rails), etc to your mongo logs. Requires just mongo
+  gem; compatible with Mongoid 5, Rails, etc.
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongo_logs_on_roids.rb
+- lib/mongo_logs_on_roids/colorize_command_log.rb
+- lib/mongo_logs_on_roids/railtie.rb
+- lib/mongo_logs_on_roids/runtime_subscriber.rb
+- lib/mongo_logs_on_roids/version.rb
+- mongo_logs_on_roids.gemspec
+homepage: https://github.com/zarqman/mongo_logs_on_roids
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Better logging for mongodb. Compatible w/Mongoid 5, Rails, etc.
+test_files: []