outland-tag_runes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07f173cc03377ce577805642a9058df35d55d63d
+  data.tar.gz: 31c96cfa3adf59b23b271d3d1ae06f8a6154dcaa
+SHA512:
+  metadata.gz: 80e124536d45bf3e1b9a13b99aaf7ec64022db8b415267c80bade563687ef9cf422baabea42a669c871d54ad3d2467ac4b6bce04dfb1894f4ee1349682714379
+  data.tar.gz: 6e230cf59991beea4197db2b3f086890c465190a62e7661a71c5787837ef5e82339988bd9fc12e743ff77a7db928611d5e7923067c806e8b932d8a93aa007df3

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+**1.0** (February 27, 2017)
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Outland Labs
+
+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,75 @@
+# Outland::TagRunes
+
+The Outland TagRunes 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, TagRunes 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:
+
+```ruby
+gem 'outland-tag_runes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install outland-tag_runes
+
+## Usage
+
+In your initialization, add:
+
+    config.log_tags = [ Outland::TagRunes.rails_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 quickly produce the entire log output for that request.
+  
+The gem also wraps the standard Rails log formatter so that multiline log messages will be
+tagged properly on each line.
+
+The glyphs were chosen for legibility in OSX terminal fonts.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/outland/tag_runes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

data/bin/setup

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

data/lib/outland/tag_runes/version.rb

@@ -0,0 +1,7 @@
+module Outland
+module TagRunes
+
+    VERSION = "1.0.0"
+
+end
+end

data/lib/outland/tag_runes.rb

@@ -0,0 +1,82 @@
+require 'outland/tag_runes/version'
+
+module Outland
+module TagRunes
+
+  # These glyphs should be chosen to maximize visual distinctiveness
+  # while being available in 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.rails_tag
+    Proc.new do |req|
+      # Set the tag in the rack environment so it can be picked up by
+      # tools like Airbrake.
+      sess_id = req.cookies[Rails.application.config.session_options[:key]]
+      req.env['request_tag'] = signature(sess_id, req.uuid)
+    end
+  end
+
+
+  # ensure tags appear on each line of a multiline log statement.
+  module MultilineFormatter
+
+    def call(severity, timestamp, progname, msg)
+      if msg && msg.index("\n")
+        msg.lines.map{|l| super(severity, timestamp, progname, l.chomp)}.join
+      else
+        super
+      end
+    end
+    
+  end
+
+
+  # Hook Rails init process
+  class Railtie < Rails::Railtie
+    initializer 'outland-tag_runes' do |app|
+
+      Rails.logger.formatter.extend MultilineFormatter
+
+      # 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
+end

data/outland-tag_runes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outland/tag_runes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "outland-tag_runes"
+  spec.version       = Outland::TagRunes::VERSION
+  spec.authors       = ["Bill Lipa"]
+  spec.email         = ["dojo@masterleep.com"]
+
+  spec.summary       = %q{Encode Rails session and request id into the log using only 7 columns, via Unicode.}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/outland/tag_runes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: outland-tag_runes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bill Lipa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 
+email:
+- dojo@masterleep.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/outland/tag_runes.rb
+- lib/outland/tag_runes/version.rb
+- outland-tag_runes.gemspec
+homepage: https://github.com/outland/tag_runes
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Encode Rails session and request id into the log using only 7 columns, via
+  Unicode.
+test_files: []