steno 0.0.5 → 0.0.6

data/bin/steno-prettify

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "bundler"
+Bundler.setup
+
+require "optparse"
+require "yajl"
+
+require "steno/json_prettifier"
+
+def prettify_io(io, prettifier)
+  lineno = 0
+  io.each_line do |line|
+    begin
+      prettified = prettifier.prettify_line(line)
+      print line
+    rescue Yajl::ParseError => e
+      STDERR.puts "steno-prettify: Malformed json at line #{lineno}, '#{line.strip}'"
+    end
+
+    lineno += 1
+  end
+end
+
+def prettify_file(path, prettifier)
+  begin
+    f = File.open(path, "r")
+  rescue => e
+    STDERR.puts "steno-prettify: Failed opening '#{path}', #{e}"
+    return
+  end
+
+  prettify_io(f, prettifier)
+
+ensure
+  f.close if f
+end
+
+option_parser = OptionParser.new do |op|
+  op.banner =<<EOT
+Usage: steno-prettify [OPTS] [FILE...]
+
+Parses json formatted log lines from FILE(s), or stdin,
+and displays a more human friendly version of each line to stdout.
+
+Examples (shamelessly stolen from `man cat`):
+
+  steno-prettify f - g
+    Prettify f's contents, then standard input, then g's contents.
+
+  steno-prettify
+    Prettify contents of stdin.
+
+Options:
+EOT
+
+  op.on("-h", "--help", "Display help") do
+    puts op
+    exit
+  end
+end
+
+option_parser.parse!(ARGV)
+
+STDOUT.sync = true
+prettifier = Steno::JsonPrettifier.new
+
+inputs = ARGV.dup
+inputs << "-" if inputs.empty?
+
+inputs.each do |path|
+  if path == "-"
+    prettify_io(STDIN, prettifier)
+  else
+    prettify_file(path, prettifier)
+  end
+end
+

data/lib/steno/json_prettifier.rb

@@ -0,0 +1,66 @@
+require "digest/md5"
+require "yajl"
+
+module Steno
+end
+
+# Transforms JSON log lines into a more human readable format
+class Steno::JsonPrettifier
+
+  attr_reader :time_format
+
+  def initialize
+    @time_format = "%Y-%m-%d %H:%M:%S.%6N"
+  end
+
+  def prettify_line(line)
+    json_record = Yajl::Parser.parse(line)
+
+    format_record(json_record)
+  end
+
+  private
+
+  def format_record(record)
+    timestamp = nil
+    if record.has_key?("timestamp")
+      timestamp = Time.at(record["timestamp"]).strftime(@time_format)
+    else
+      timestamp = "-"
+    end
+
+    log_level = nil
+    if record.has_key?("log_level")
+      log_level = record["log_level"].upcase
+    else
+      log_level = "-"
+    end
+
+    fields = [timestamp,
+              record["source"] || "-",
+              "pid=%s" % [record["process_id"] || "-"],
+              "tid=%s" % [shortid(record["thread_id"])],
+              "fid=%s" % [shortid(record["fiber_id"])],
+              "%s/%s:%s" % [record["file"]   || "-",
+                            record["method"] || "-",
+                            record["lineno"] || "-"],
+              format_data(record["data"]),
+              "%7s" % [log_level],
+              "--",
+              record["message"] || "-"]
+
+    fields.join(" ") + "\n"
+  end
+
+  def format_data(data = {})
+    return "-" if data.empty?
+
+    data.map { |k, v| "#{k}=#{v}" }.join(",")
+  end
+
+  def shortid(data)
+    return "-" if data.nil?
+    digest = Digest::MD5.hexdigest(data.to_s)
+    digest[0, 4]
+  end
+end

data/lib/steno/version.rb

@@ -1,3 +1,3 @@
 module Steno
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/unit/json_prettifier_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+require "steno/json_prettifier"
+
+describe Steno::JsonPrettifier do
+  let(:prettifier) { Steno::JsonPrettifier.new }
+  let(:codec) { Steno::Codec::Json.new }
+
+  describe "#prettify_line" do
+    it "should return a properly formatted string" do
+      record = Steno::Record.new("test", :info, "message",
+                                 ["filename", "line", "method"], "test" => "data")
+      encoded = codec.encode_record(record)
+      prettified = prettifier.prettify_line(encoded)
+
+      exp_regex = ['\d{4}-\d{2}-\d{2}',        # YYYY-MM-DD
+                   '\d{2}:\d{2}:\d{2}\.\d{6}', # HH:MM:SS.uS
+                   'test',                     # Source
+                   'pid=\d+',                  # Process id
+                   'tid=\w{4}',                # Thread shortid
+                   'fid=\w{4}',                # Fiber shortid
+                   'filename\/method:line',    # Location
+                   'test=data',                # User supplied data
+                   '\s+INFO',                  # Level
+                   '--',
+                   'message',                  # Log message
+                   ].join(" ") + "\n"
+      prettified.should match(exp_regex)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steno
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
-  requirement: &15618460 !ruby/object:Gem::Requirement
+  requirement: &23171120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15618460
+  version_requirements: *23171120
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &15617860 !ruby/object:Gem::Requirement
+  requirement: &23168040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15617860
+  version_requirements: *23168040
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &15617180 !ruby/object:Gem::Requirement
+  requirement: &23162620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15617180
+  version_requirements: *23162620
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &15616200 !ruby/object:Gem::Requirement
+  requirement: &23160780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15616200
+  version_requirements: *23160780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15615780 !ruby/object:Gem::Requirement
+  requirement: &23154300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15615780
+  version_requirements: *23154300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15615360 !ruby/object:Gem::Requirement
+  requirement: &23151740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,11 +76,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15615360
+  version_requirements: *23151740
 description: A thread-safe logging library designed to support multiple log destinations.
 email:
 - mpage@rbcon.com
-executables: []
+executables:
+- steno-prettify
 extensions: []
 extra_rdoc_files: []
 files:
@@ -89,6 +90,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/steno-prettify
 - lib/steno.rb
 - lib/steno/codec.rb
 - lib/steno/codec/base.rb
@@ -98,6 +100,7 @@ files:
 - lib/steno/core_ext.rb
 - lib/steno/errors.rb
 - lib/steno/http_handler.rb
+- lib/steno/json_prettifier.rb
 - lib/steno/log_level.rb
 - lib/steno/logger.rb
 - lib/steno/record.rb
@@ -117,6 +120,7 @@ files:
 - spec/unit/http_handler_spec.rb
 - spec/unit/io_sink_spec.rb
 - spec/unit/json_codec_spec.rb
+- spec/unit/json_prettifier_spec.rb
 - spec/unit/log_level_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/record_spec.rb
@@ -159,6 +163,7 @@ test_files:
 - spec/unit/http_handler_spec.rb
 - spec/unit/io_sink_spec.rb
 - spec/unit/json_codec_spec.rb
+- spec/unit/json_prettifier_spec.rb
 - spec/unit/log_level_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/record_spec.rb