aioli_log_formatter 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thomas Baustert
+
+MIT License
+
+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,122 @@
+# Aioli Logging Formatter
+
+Aioli logger (All In One LIne Logger) is a logging formatter for Rails 3.
+
+Aioli make our meals delicious, right?
+
+By default it logs lines of format:
+
+    <date> <host> rails[<processId>] <sessionId> u<userId>>: <message>
+
+Examples:
+
+    Nov 23 14:27:56 host rails[19572] f79a2d8633 u18: Completed in 1218ms (View: 772, DB: 209) | 200 OK [http://localhost/claims]
+    Nov 23 14:27:56 host rails[19572] 0 u0: Completed in 1218ms (View: 772, DB: 209) | 200 OK [http://localhost/claims]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aioli_log_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aioli_log_formatter
+
+## Usage
+
+Enable the formatter:
+
+    # config/application.rb
+    ...
+      class Application < Rails::Application
+        ...
+        config.aioli_log_formatter.enabled = true
+
+
+Enable before filters to retrieve session ID and user ID from default sources.
+
+    class ApplicationController < ActionController::Base
+
+      aioli_log_formatter
+      ...
+    end
+
+This is the same as:
+
+    class ApplicationController < ActionController::Base
+
+      aioli_log_formatter user_id: lambda { |controller| controller.session[:user_id] },
+                       session_id: lambda { |controller| controller.request.session_options[:id] }
+      ...
+    end
+
+To get the values from different sources simply change the procs, e.g.:
+
+    class ApplicationController < ActionController::Base
+
+      aioli_log_formatter user_id: lambda { |controller| controller.session[:account_id] }
+      ...
+    end
+
+When using [Devise](https://github.com/plataformatec/devise) gem you can get the user ID as follows:
+
+    class ApplicationController < ActionController::Base
+
+      aioli_log_formatter user_id: lambda { |controller|
+        user = controller.env['warden'].user
+        user ? user.id : nil
+      }
+      ...
+    end
+
+## Define your own Formatter
+
+Define your formatter by inheriting from `AioliLogFormatter::Formatter` for example:
+
+    class MyAwesomeFormatter < AioliLogFormatter::Formatter
+
+      # I like different formatting
+      def call(severity, timestamp, progname, message)
+        "#{timestamp} #{hostname} pid=#{process_id} sid=#{shorten_session_id} uid=#{user_id} msg=#{sanitize(message)}\n"
+      end
+
+    end
+
+Have a look into source code of `AioliLogFormatter::Formatter` for more methods to overwrite.
+
+Enable the formatter:
+
+    # config/application.rb
+    require_relative "../path/to/my_awesome_formatter"
+
+    ...
+      class Application < Rails::Application
+        ...
+        config.aioli_log_formatter.enabled = true
+        config.aioli_log_formatter.formatter = MyAwesomeFormatter.new
+
+
+See new formatting:
+
+    2013-11-12 16:16:50 +0100 host pid=69402 sid=e36db0f022 uid=u42 msg=Started GET "/...
+
+## Tests
+
+Examples are located under `spec` and `test/dummy/spec` and are executed via:
+
+    $ cd path/to/aioli_log_formatter
+    $ bundle exec rake spec
+
+
+## Credits
+
+Inspired by [logjam_logger](https://github.com/alpinegizmo/logjam_logger)
+
+## License
+
+Copyright © 2013 [Thomas Baustert](http://thomasbaustert.de), released under the MIT license

data/lib/aioli_log_formatter/active_support/buffered_logger.rb

@@ -0,0 +1,22 @@
+#
+# ActiveSupport::BufferedLogger is the central logger class for all Rails loggers
+# (e.g. ActiveRecord::Base.logger, ActionMailer::Base.logger, ActionController::Base.logger).
+# Unfortunately it does not support setting a formatter so we have to monkey patch it.
+#
+module ActiveSupport
+  class BufferedLogger
+
+    private
+
+      def open_logfile(log)
+        logger = Logger.new log
+
+        if AioliLogFormatter::Engine.config.aioli_log_formatter.enabled
+          logger.formatter = AioliLogFormatter::Engine.config.aioli_log_formatter.formatter
+        end
+
+        logger
+      end
+
+  end
+end

data/lib/aioli_log_formatter/controller/extension.rb

@@ -0,0 +1,33 @@
+module AioliLogFormatter
+  module Controller
+
+    module Extension
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module InstanceMethods
+      end
+
+      module ClassMethods
+        SESSION_ID_PROC = lambda { |controller| controller.request.session_options[:id] }
+        USER_ID_PROC = lambda { |controller| controller.session[:user_id] }
+
+        def aioli_log_formatter(options = {})
+          if session_id = options.fetch(:session_id, SESSION_ID_PROC)
+            before_filter { |controller| ($session_id ||= {})[Thread.current] = session_id.call(controller) || 0 }
+          end
+
+          if user_id = options.fetch(:user_id, USER_ID_PROC)
+            before_filter { |controller| ($user_id ||= {})[Thread.current] = user_id.call(controller) || 0 }
+          end
+
+        end
+      end
+    end
+
+  end
+end

data/lib/aioli_log_formatter/engine.rb

@@ -0,0 +1,11 @@
+module AioliLogFormatter
+  class Engine < ::Rails::Engine
+    config.aioli_log_formatter = ActiveSupport::OrderedOptions.new
+    config.aioli_log_formatter.enabled = false
+    config.aioli_log_formatter.formatter = Formatter.new
+
+    initializer :aioli_log_formatter do |app|
+      AioliLogFormatter.setup(app) if app.config.aioli_log_formatter.enabled
+    end
+  end
+end

data/lib/aioli_log_formatter/formatter.rb

@@ -0,0 +1,50 @@
+require 'socket'
+
+module AioliLogFormatter
+
+  class Formatter
+
+    # Rails 2
+    def format(message)
+      "#{timestamp} #{hostname} rails[#{process_id}] #{shorten_session_id} #{user_id}: #{sanitize(message)}\n"
+    end
+
+    # Rails 3
+    def call(severity, timestamp, progname, message)
+      format(message)
+    end
+
+    private
+
+    def timestamp
+      Time.now.strftime("%b %d %H:%M:%S")
+    end
+
+    def hostname
+      @parsed_hostname ||= Socket.gethostname.split('.').first
+    end
+
+    def process_id
+      $$
+    end
+
+    def shorten_session_id
+      session_id[0,10]
+    end
+
+    # before_filter { |controller| ($session_id ||= {})[Thread.current] = controller.session_id || 0 }
+    def session_id
+      defined?($session_id) ? "#{$session_id[Thread.current] || 0}" : '0'
+    end
+
+    # before_filter { |controller| ($user_id ||= {})[Thread.current] = controller.session[:user_id] || 0 }
+    def user_id
+      defined?($user_id) ? "u#{$user_id[Thread.current] || 0}" : 'u0'
+    end
+
+    def sanitize(message)
+      message.to_s.gsub(/\n/, ' ').lstrip
+    end
+
+  end
+end

data/lib/aioli_log_formatter/version.rb

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

data/lib/aioli_log_formatter.rb

@@ -0,0 +1,13 @@
+require 'aioli_log_formatter/version'
+require 'aioli_log_formatter/formatter'
+require 'aioli_log_formatter/engine'
+require 'aioli_log_formatter/active_support/buffered_logger'
+require 'aioli_log_formatter/controller/extension'
+
+module AioliLogFormatter
+
+  def self.setup(app)
+    ActionController::Base.send(:include, AioliLogFormatter::Controller::Extension)
+  end
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: aioli_log_formatter
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Baustert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: timecop
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Logging formatter for Rails
+email:
+- business@thomasbaustert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aioli_log_formatter/active_support/buffered_logger.rb
+- lib/aioli_log_formatter/controller/extension.rb
+- lib/aioli_log_formatter/engine.rb
+- lib/aioli_log_formatter/formatter.rb
+- lib/aioli_log_formatter/version.rb
+- lib/aioli_log_formatter.rb
+- MIT-LICENSE
+- README.md
+homepage: https://github.com/thomasbaustert/aioli_log_formatter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 607169139388963087
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 607169139388963087
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Aioli logger (All In One LIne Logger) is a logging formatter for Rails
+test_files: []