superlogger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8233a0f1140b23ad1a79d954256e9f406e7dbf4
+  data.tar.gz: 7fc49063ae14c89e033a224dc619e878401d8f33
+SHA512:
+  metadata.gz: 5bf2ca0272093a2b54928be31590756f57ddb0fb959c0fc4fc37cdd074cdaf51adbc903bfd5d549705708b53269e312afeb20ac04af50dec472ff41e7c4082c8
+  data.tar.gz: 1b181052bfb35cc721824dde111d9d87b4aadc0b8605d944b7c1657e0afff478a1b2052c6033b8df04f64f262de53b84744c709c177bed20985f9799ae8cafef

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Soh Yu Ming
+
+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,82 @@
+Superlogger - Machine-readable logging for Rails [![Build Status](https://travis-ci.org/moexmen/superlogger.svg?branch=master)](https://travis-ci.org/moexmen/superlogger)
+=======
+
+Rails' default request logging is easy to read for humans but difficult for log aggregators such as Kibana, Graylog and Splunk. Superlogger transforms the logs into key-value pairs for easy parsing and adds useful details like Timestamp and Session ID for tracing purposes.
+
+Default rails logging:
+```sh
+Started GET "/home/index" for ::1 at 2016-04-11 16:23:27 +0800
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Processing by HomeController#index as HTML
+  Something Load (0.2ms)  SELECT  "somethings".* FROM "somethings" WHERE "somethings"."paper" = ? AND "somethings"."stone" = ?  ORDER BY "somethings"."id" ASC LIMIT 1  [["paper", "123"], ["stone", "456"]]
+  Rendered home/_partial.html.erb (0.2ms)
+  Rendered home/index.html.erb within layouts/application (5.2ms)
+Completed 200 OK in 283ms (Views: 271.6ms | ActiveRecord: 0.6ms)
+
+Started GET "/assets/application.self-e80e8f2318043e8af94dddc2adad5a4f09739a8ebb323b3ab31cd71d45fd9113.css?body=1" for ::1 at 2016-04-11 16:23:27 +0800
+
+Started GET "/assets/application.self-8f06a73c35179188914ab50e057157639fce1401c1cdca640ac9cec33746fc5b.js?body=1" for ::1 at 2016-04-11 16:23:27 +0800
+```
+
+Machine-readable logging with Superlogger:
+```sh
+2016-04-11 16:18:22.279 | b48534ea049a | I | middleware:28 | method=GET | path=/home/index | ip=::1
+2016-04-11 16:18:22.293 | b48534ea049a | D | action_controller_log_subscriber:9 | controller=HomeController | action=index | params={}
+2016-04-11 16:18:22.305 | b48534ea049a | D | active_record_log_subscriber:24 | sql=SELECT  "somethings".* FROM "somethings" WHERE "somethings"."paper" = ? AND "somethings"."stone" = ?  ORDER BY "somethings"."id" ASC LIMIT 1 | params=["'123'", "'456'"] | duration=0.48
+2016-04-11 16:18:22.316 | b48534ea049a | D | action_view_log_subscriber:6 | view=_partial.html.erb | duration=0.3
+2016-04-11 16:18:22.316 | b48534ea049a | D | action_view_log_subscriber:6 | view=index.html.erb | duration=5.6
+2016-04-11 16:18:22.541 | b48534ea049a | I | action_controller_log_subscriber:29 | status=200 | total_duration=247.16 | view_duration=235.25 | db_duration=0.78
+```
+
+## Features ##
+- Timestamp (milliseconds)
+- Session ID for logs across requests
+- Key-value pairs for log data
+- Muting of assets logging
+- File and line numbers
+- Recording of IP address
+
+## Installation ##
+
+Add superlogger to your application's Gemfile
+
+```ruby
+gem "superlogger"
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+## Usage ##
+
+```ruby
+require 'superlogger'
+
+class SomeClass
+    include Superlogger
+
+    def some_method
+        Logger.debug name:'john', age: '21'
+        Logger.info name:'john', age: '21'
+        Logger.warn name:'john', age: '21'
+        Logger.error name:'john', age: '21'
+        Logger.fatal name:'john', age: '21'
+    end
+end
+```
+
+## Output Format ##
+```sh
+2015-03-26 23:37:38.086 | 970298669a40   | I            | log_subscriber:24           | status:200 | total:858.35 | view:597.46 | db:34.96
+< timestamp >           | < session id > | < severity > | < file >:< line num >       | < data you pass in ... >
+```
+
+### Severity Levels ###
+- **D** - Debug
+- **I** - Info
+- **W** - Warn
+- **E** - Error
+- **F** - Fatal

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Superlogger'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/superlogger.rb

@@ -0,0 +1,54 @@
+require 'superlogger/version'
+require 'superlogger/logger'
+
+module Superlogger
+  module_function
+
+  def setup(app)
+    overwrite_rails_rack_logger
+    overwrite_action_dispatch_debug_exceptions
+    insert_superlogger_middleware(app)
+    detach_all_existing_log_subscribers
+    attach_superlogger_log_subscribers
+  end
+
+  def overwrite_rails_rack_logger
+    require 'superlogger/rails_rack_logger'
+  end
+
+  def overwrite_action_dispatch_debug_exceptions
+    require 'superlogger/action_dispatch_debug_exceptions'
+  end
+
+  def insert_superlogger_middleware(app)
+    require 'superlogger/middleware'
+
+    # important to insert after session middleware so we can get the session id
+    app.middleware.use Superlogger::Middleware
+  end
+
+  def detach_all_existing_log_subscribers
+    # force log subscribers to attach first so we can remove them all
+    require 'action_controller/log_subscriber'
+    require 'active_record/log_subscriber'
+    require 'action_view/log_subscriber'
+    require 'action_mailer/log_subscriber'
+
+    # remove log subscribers
+    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+      subscriber.patterns.each do |pattern|
+        ActiveSupport::Notifications.unsubscribe pattern
+      end
+    end
+
+    ActiveSupport::LogSubscriber.log_subscribers.clear
+  end
+
+  def attach_superlogger_log_subscribers
+    require 'superlogger/action_controller_log_subscriber'
+    require 'superlogger/action_view_log_subscriber'
+    require 'superlogger/active_record_log_subscriber'
+  end
+end
+
+require 'superlogger/railtie' if defined?(Rails)

data/lib/superlogger/action_controller_log_subscriber.rb

@@ -0,0 +1,35 @@
+module Superlogger
+  class ActionControllerLogSubscriber < ActiveSupport::LogSubscriber
+    INTERNAL_PARAMS = %w(controller action format _method only_path)
+
+    # start of controller action
+    def start_processing(event)
+      payload = event.payload
+
+      Logger.debug controller: payload[:controller], action: payload[:action], params: payload[:params].except(*INTERNAL_PARAMS)
+    end
+
+    # end of controller action
+    def process_action(event)
+      payload = event.payload
+
+      if payload[:exception]
+        status = ActionDispatch::ExceptionWrapper.status_code_for_exception(payload[:exception][0])
+
+        Logger.fatal status: status, exception: payload[:exception]
+      else
+        # Assume status 401 if action finishes without status code and no exception
+        # https://github.com/pcg79/devise/commit/1e2dab3c0ce49efe2b5940c15f47388c69d6731b
+        payload[:status] ||= 401
+
+        total_duration = event.duration.to_f.round(2)
+        view_duration  = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+        db_duration    = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
+
+        Logger.info status: payload[:status], total_duration: total_duration, view_duration: view_duration, db_duration: db_duration
+      end
+    end
+  end
+end
+
+Superlogger::ActionControllerLogSubscriber.attach_to :action_controller

data/lib/superlogger/action_dispatch_debug_exceptions.rb

@@ -0,0 +1,11 @@
+class ActionDispatch::DebugExceptions
+  alias_method :old_log_error, :log_error
+  def log_error(request, wrapper)
+    if wrapper.exception.is_a?  ActionController::RoutingError
+      # Change routing errors to warn instead
+      Superlogger::Logger.warn routing_error: request['PATH_INFO'].inspect
+    else
+      old_log_error request, wrapper
+    end
+  end
+end

data/lib/superlogger/action_view_log_subscriber.rb

@@ -0,0 +1,13 @@
+module Superlogger
+  class ActionViewLogSubscriber < ActiveSupport::LogSubscriber
+    def render_template(event)
+      payload = event.payload
+
+      Logger.debug view: payload[:identifier].split('/').last, duration: event.duration.round(1)
+    end
+    alias :render_partial :render_template
+    alias :render_collection :render_template
+  end
+end
+
+Superlogger::ActionViewLogSubscriber.attach_to :action_view

data/lib/superlogger/active_record_log_subscriber.rb

@@ -0,0 +1,29 @@
+module Superlogger
+  class ActiveRecordLogSubscriber < ActiveSupport::LogSubscriber
+    IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN", "ActiveRecord::SchemaMigration Load"]
+
+    def self.runtime=(value)
+      ActiveRecord::RuntimeRegistry.sql_runtime = value
+    end
+
+    def self.runtime
+      ActiveRecord::RuntimeRegistry.sql_runtime ||= 0
+    end
+
+    def sql(event)
+      self.class.runtime += event.duration
+
+      return if Rails.env.production?
+
+      payload = event.payload
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      sql = payload[:sql]
+      params = payload[:binds].map { |_, value| "'#{value}'"}
+
+      Logger.debug sql: sql, params: params, duration: event.duration.round(2)
+    end
+  end
+end
+
+Superlogger::ActiveRecordLogSubscriber.attach_to :active_record

data/lib/superlogger/logger.rb

@@ -0,0 +1,79 @@
+require 'request_store'
+
+module Superlogger
+  module Logger
+    def self.session_id=(session_id)
+      RequestStore.store[:superlogger_session_id] = session_id
+    end
+
+    def self.session_id
+      RequestStore.store[:superlogger_session_id] || "NS-#{Thread.current.object_id}"
+    end
+
+    def self.debug(*args)
+      Rails.logger.debug { format_msg(args) }
+    end
+
+    def self.info(*args)
+      Rails.logger.info { format_msg(args) }
+    end
+
+    def self.warn(*args)
+      Rails.logger.warn { format_msg(args) }
+    end
+
+    def self.error(*args)
+      Rails.logger.error { format_msg(args) }
+    end
+
+    def self.fatal(*args)
+      Rails.logger.fatal { format_msg(args) }
+    end
+
+    private
+
+    def self.format_msg(args)
+      "#{get_caller_location} | #{format_args(args)}"
+    end
+
+    def self.get_caller_location
+      # Find the last method call on Superlogger::Logger
+      count = 0
+      location_index = caller_locations(0).find_index do |location|
+        count += 1 if location && location.path.include?('superlogger/logger.rb')
+        count == 4
+      end
+
+      # Add 1 to get the caller of the logger
+      location = caller_locations(location_index + 1).first
+
+      # extract filename without file extension from location.path
+      # eg. superlogger/lib/superlogger/logger.rb
+      file = location.path.split('/').last.split('.').first
+
+      "#{file}:#{location.lineno}"
+    end
+
+    def self.format_args(args)
+      # format args in key=value pair, separated by pipes
+      args.map do |arg|
+        arg = {nil: arg} unless arg.is_a?(Hash)
+
+        arg.map do |key, value|
+          "#{key}=#{value}"
+        end
+      end.flatten.join(' | ')
+    end
+  end
+end
+
+# for overriding default Rails Logger format
+class Logger
+  def format_message(severity, time, _progname, msg)
+    timestamp = time.strftime('%Y-%m-%d %H:%M:%S.%L')
+    session_id = Superlogger::Logger.session_id[0..11]
+    severity = severity.to_s.upcase[0]
+
+    "#{timestamp} | #{session_id} | #{severity} | #{msg}\n"
+  end
+end

data/lib/superlogger/middleware.rb

@@ -0,0 +1,31 @@
+module Superlogger
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new(env)
+
+      # only process the actual request, less the assets
+      if request.path.start_with?('/assets/') == false
+        process_request(request)
+      end
+
+      @app.call(env)
+    end
+
+    def process_request(request)
+      if request.env['rack.session']
+        # Session is lazy loaded. Force session to load if it is not already loaded.
+        request.env['rack.session'].send(:load!) unless request.env['rack.session'].id
+
+        # Store session id before any actual logging is done
+        Superlogger::Logger.session_id = request.env['rack.session'].id
+      end
+
+      # Start of request logging
+      Logger.info method: request.method, path: request.fullpath, ip: request.ip
+    end
+  end
+end

data/lib/superlogger/rails_rack_logger.rb

@@ -0,0 +1,11 @@
+class Rails::Rack::Logger
+  # Overwrite the default call_app method to mute the following line:
+  # Started GET “/session/new” for 127.0.0.1 at 2012-09-26 14:51:42 -0700
+  def call_app(_request, env)
+    @app.call(env)
+  ensure
+    ActiveSupport::LogSubscriber.flush_all!
+  end
+end
+
+

data/lib/superlogger/railtie.rb

@@ -0,0 +1,7 @@
+module Superlogger
+  class Railtie < Rails::Railtie
+    initializer :superlogger do |app|
+      Superlogger.setup(app)
+    end
+  end
+end

data/lib/superlogger/version.rb

@@ -0,0 +1,3 @@
+module Superlogger
+  VERSION = "0.0.1"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.