log_runes 1.1.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 William Lipa
+
+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,66 @@
+# Log Runes
+
+The Log Runes gem adds unicode glyphs to the Rails logger output that encode the session and request id
+in a way that occupies a minimum of visual space but provides very useful debugging capabilities.
+
+For example, it is easy to grep for a single session's log output, or the log output for a complete
+request, even if many requests are interleaved into the same log file.
+
+Beyond the debugging capabilities, Runic Logs tries to keep the log file output pleasant to work
+with by only occupying 10 columns of text.  It uses unicode to encode a full byte of data into each
+column position in a visually clear way.
+ 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'log_runes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_runes
+    
+
+## Usage
+
+Add the following setting to your config/application.rb file:
+
+    config.log_tags = [ LogRunes.tag ]
+
+Your log output will look something like the following.
+    
+    [★¿xÄ ϱm] Completed 200 OK in 78ms (Views: 0.7ms | ActiveRecord: 72.6ms)
+
+The format is:
+
+    [<encoded session id> <encoded request id>]
+
+So to look at a user's complete session log output, do the following:
+
+    grep "<encoded session id>" production.log
+
+Or for a particular request:
+
+    grep "<encoded request id>" production.log
+
+The tag is added to the Rack environment, so tools like Airbrake will contain it in
+their exception environment information.  You can therefore look at a recorded exception
+and immediately produce the entire log output for that request.
+  
+The glyphs were chosen for legibility in OSX terminal fonts.  The standard terminal does
+slow down quite a bit when there are many unicode characters; to get around this, use
+the almost identical but significantly faster iTerm 2.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/log_runes/cronolog.rb

@@ -0,0 +1,14 @@
+module LogRunes
+  class Cronolog
+  
+  def self.setup(config, log_base)
+    unless File.exists? '/usr/bin/cronolog'
+      puts "cronolog missing - reverting to standard logger"
+      return
+    end
+    crono_cmd = "/usr/bin/cronolog -S #{log_base}/#{Rails.env}.log #{log_base}/rot/#{Rails.env}-%Y-%m-%d.log"
+    config.logger = ActiveSupport::TaggedLogging.new(Logger.new(IO.popen(crono_cmd, "w")))
+  end
+
+end
+end

data/lib/log_runes/session_request_tagger.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module LogRunes
+class SessionRequestTagger
+  
+  # These glyphs should be chosen to maximize visual distinctiveness
+  # while being available in OSX terminal fonts.
+  
+  GLYPHS = %w(
+    a b c d e f g h i j k l m n o p q r s t u v w x y z 0 1 2 3 4 5
+    A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 6 7 8 9 ♓ ÿ
+    À Á ♑ Ã Ä Å Æ Ç È ♐ Ê Ë Ì Í Î Ï Ð Ñ Ò Ó ♋ Õ Ö × Ø Ù Ú Û Ü ♎ ♒ ♈
+    Ý Þ ß à á â ã ä å æ ç è é ê ë ì í î ï ð ñ ò ó ô õ ö ÷ ø ù ú û ü
+    ΐ § ¶ Γ Δ © ® ¥ Θ £ ¿ Λ « » Ξ ± Π ¤ Σ ¢ ¡ Φ ° Ψ Ω Ϊ Ϋ ά έ ή ί ΰ
+    α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ ς σ τ υ φ χ ψ ω ϊ ϋ ό ύ ώ ϐ ϑ
+    ϒ ϓ ϔ ϕ ϖ ϗ Ϙ ϙ Ϛ ϛ Ϝ ϝ Ϟ ϟ Ϡ ϡ Ϣ ϣ Ϥ ϥ Ϧ ϧ Ϩ ϩ Ϫ ϫ Ϭ ϭ Ϯ ϯ ϰ ϱ
+    ♥ Б ♦ ♠ Д ♣ Ж ★ И Й ☉ Л ☇ ☈ ☃ П ☂ ☀ ☄ ☆ Ф ☢ Ц Ч Ш Щ Ъ Ы ☥ Э Ю Я
+  )
+  
+
+  def self.sign(hex)
+    hex.scan(/\h\h/).map do |b|
+      GLYPHS[b.to_i(16)]
+    end.join
+  end
+  
+  def self.signature(sid, rid)
+    "#{sid ? sign(sid[0,8]) : '----'} #{sign(rid[0,4])}"
+  end
+  
+  # At this point in the middleware, we don't have access to the session.
+  # A good approximation is the passed-up session id, although it's
+  # controlled by the client.  We 'sign' it with a compressed visual
+  # representation that doesn't clutter up the log too badly and is still
+  # highly likely to be unique when used for debugging expeditions into
+  # the log.
+  #
+  # An abbreviated signature of the request id is added as well, to aid
+  # in understanding interleaved log entries.
+  
+  def self.proc
+    Proc.new do |req|
+      # Set the tag in the rack environment so it can be picked up by
+      # tools like Airbrake.
+      req.env['request_tag'] = signature(req.cookies['_session_id'], req.uuid)
+    end
+  end
+  
+  def self.wrap(wrapee)
+    
+    class << wrapee
+      
+      alias_method :add_original, :add
+      
+      # Tag each line if multiple are passed in.
+      def add(severity, message = nil, progname = nil, &block)
+        message = (block_given? ? block.call : progname) if message.nil?
+        if message && message.include?("\n")
+          message.lines{|l| add_original(severity, l.chomp)}
+        else
+          add_original(severity, message)
+        end
+      end
+      
+    end
+    
+  end
+   
+end
+end

data/lib/log_runes/version.rb

@@ -0,0 +1,3 @@
+module LogRunes
+  VERSION = "1.1.1"
+end

data/lib/log_runes.rb

@@ -0,0 +1,27 @@
+require "log_runes/cronolog"
+require "log_runes/session_request_tagger"
+require "log_runes/version"
+
+module LogRunes
+  
+  def self.tag
+    SessionRequestTagger.proc
+  end
+  
+  # Hook Rails init process
+  class Railtie < Rails::Railtie
+    initializer 'log_runes' do |app|
+
+      SessionRequestTagger.wrap(Rails.logger)
+
+      # Keep requests separated when deployed for sanity's sake
+      unless Rails.env.development?
+        ActiveSupport::Notifications.subscribe('process_action.action_controller') do |_|
+          Rails.logger.info "\n\n"
+        end
+      end
+
+    end
+  end
+  
+end

data/log_runes.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_runes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "log_runes"
+  gem.version       = LogRunes::VERSION
+  gem.authors       = ["wlipa"]
+  gem.email         = ["dojo@masterleep.com"]
+  gem.description   = %q{Encodes session and request ids into the Rails log output using Unicode single-width characters, thereby using only a minimum amount of column width but allowing easy grepping for an individual session or request.}
+  gem.summary       = %q{Encodes session and request ids into the Rails log output for easy grepping}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: log_runes
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+  prerelease: 
+platform: ruby
+authors:
+- wlipa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies: []
+description: Encodes session and request ids into the Rails log output using Unicode
+  single-width characters, thereby using only a minimum amount of column width but
+  allowing easy grepping for an individual session or request.
+email:
+- dojo@masterleep.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/log_runes.rb
+- lib/log_runes/cronolog.rb
+- lib/log_runes/session_request_tagger.rb
+- lib/log_runes/version.rb
+- log_runes.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Encodes session and request ids into the Rails log output for easy grepping
+test_files: []