steno 0.0.8 → 0.0.10

data/bin/steno-prettify

@@ -10,6 +10,8 @@ require "yajl"
 
 require "steno/json_prettifier"
 
+Signal.trap("INT") { exit }
+
 def prettify_io(io, prettifier)
   lineno = 0
   io.each_line do |line|
@@ -38,6 +40,8 @@ ensure
   f.close if f
 end
 
+excluded_fields = []
+
 option_parser = OptionParser.new do |op|
   op.banner =<<EOT
 Usage: steno-prettify [OPTS] [FILE...]
@@ -60,12 +64,16 @@ EOT
     puts op
     exit
   end
+
+  op.on("-a", "--align", "Omit location and data in order to provide well-aligned logs") do
+    excluded_fields = %w[location data]
+  end
 end
 
 option_parser.parse!(ARGV)
 
 STDOUT.sync = true
-prettifier = Steno::JsonPrettifier.new
+prettifier = Steno::JsonPrettifier.new(excluded_fields)
 
 inputs = ARGV.dup
 inputs << "-" if inputs.empty?

data/lib/steno/json_prettifier.rb

@@ -1,4 +1,5 @@
 require "digest/md5"
+require "set"
 require "yajl"
 
 module Steno
@@ -6,11 +7,12 @@ end
 
 # Transforms JSON log lines into a more human readable format
 class Steno::JsonPrettifier
+  FIELD_ORDER = %w[timestamp source process_id thread_id fiber_id location data
+                   log_level message]
 
-  attr_reader :time_format
-
-  def initialize
+  def initialize(excluded_fields = [])
     @time_format = "%Y-%m-%d %H:%M:%S.%6N"
+    @excluded_fields = Set.new(excluded_fields)
   end
 
   def prettify_line(line)
@@ -19,55 +21,79 @@ class Steno::JsonPrettifier
     format_record(json_record)
   end
 
-  private
+  protected
 
   def format_record(record)
-    timestamp = nil
-    if record.has_key?("timestamp")
-      timestamp = Time.at(record["timestamp"]).strftime(@time_format)
-    else
-      timestamp = "-"
+    fields = []
+
+    FIELD_ORDER.each do |field_name|
+      next if @excluded_fields.include?(field_name)
+
+      exists = nil
+      pred_meth = "check_#{field_name}".to_sym
+      if respond_to?(pred_meth)
+        exists = send(pred_meth, record)
+      else
+        exists = record.has_key?(field_name)
+      end
+
+      if exists
+        fields << send("format_#{field_name}".to_sym, record)
+      else
+        fields << "-"
+      end
     end
 
-    log_level = nil
-    if record.has_key?("log_level")
-      log_level = record["log_level"].upcase
-    else
-      log_level = "-"
-    end
+    fields.join(" ") + "\n"
+  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" % [trim_filename(record["file"]),
-                            record["method"] || "-",
-                            record["lineno"] || "-"],
-              format_data(record["data"]),
-              "%7s" % [log_level],
-              "--",
-              record["message"] || "-"]
+  def format_timestamp(record)
+    Time.at(record["timestamp"]).strftime(@time_format)
+  end
 
-    fields.join(" ") + "\n"
+  def format_source(record)
+    "%14s" % record["source"]
   end
 
-  def trim_filename(path)
-    return "-" if path.nil?
+  def format_process_id(record)
+    "pid=%-5s" % [record["process_id"]]
+  end
 
-    parts = path.split("/")
+  def format_thread_id(record)
+    "tid=%s" % [shortid(record["thread_id"])]
+  end
 
+  def format_fiber_id(record)
+    "fid=%s" % [shortid(record["fiber_id"])]
+  end
+
+  def check_location(record)
+    %w[file lineno method].reduce(true) { |ok, k| ok && record.has_key?(k) }
+  end
+
+  def format_location(record)
+    parts = record["file"].split("/")
+
+    trimmed_filename = nil
     if parts.size == 1
-      parts[0]
+      trimmed_filename = parts[0]
     else
-      parts.slice(-2, 2).join("/")
+      trimmed_filename = parts.slice(-2, 2).join("/")
     end
+
+    "%s/%s:%s" % [trimmed_filename, record["method"], record["lineno"]]
+  end
+
+  def format_data(record)
+    record["data"].map { |k, v| "#{k}=#{v}" }.join(",")
   end
 
-  def format_data(data = {})
-    return "-" if data.empty?
+  def format_log_level(record)
+    "%7s" % [record["log_level"].upcase]
+  end
 
-    data.map { |k, v| "#{k}=#{v}" }.join(",")
+  def format_message(record)
+    "-- %s" % [record["message"]]
   end
 
   def shortid(data)

data/lib/steno/version.rb

@@ -1,3 +1,3 @@
 module Steno
-  VERSION = "0.0.8"
+  VERSION = "0.0.10"
 end

data/spec/unit/json_prettifier_spec.rb

@@ -21,10 +21,10 @@ describe Steno::JsonPrettifier do
                    'fid=\w{4}',                # Fiber shortid
                    'filename\/method:line',    # Location
                    'test=data',                # User supplied data
-                   '\s+INFO',                  # Level
+                   'INFO',                     # Level
                    '--',
                    'message',                  # Log message
-                   ].join(" ") + "\n"
+                   ].join("\s+") + "\n"
       prettified.should match(exp_regex)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steno
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000Z
+date: 2012-07-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
-  requirement: &8836080 !ruby/object:Gem::Requirement
+  requirement: &18015280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8836080
+  version_requirements: *18015280
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &8831880 !ruby/object:Gem::Requirement
+  requirement: &18014180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8831880
+  version_requirements: *18014180
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &8831240 !ruby/object:Gem::Requirement
+  requirement: &18010240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8831240
+  version_requirements: *18010240
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &8830680 !ruby/object:Gem::Requirement
+  requirement: &17993800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8830680
+  version_requirements: *17993800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &8829840 !ruby/object:Gem::Requirement
+  requirement: &17989080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8829840
+  version_requirements: *17989080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8829060 !ruby/object:Gem::Requirement
+  requirement: &17978960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8829060
+  version_requirements: *17978960
 description: A thread-safe logging library designed to support multiple log destinations.
 email:
 - mpage@rbcon.com