steno 1.2.4 → 1.3.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmJiYWIyYzUzZjdlZjk2YzIwY2Q3ZDk5YTY4NTgxYzE4OWQ4MGJiZA==
-  data.tar.gz: !binary |-
-    MzUzMjIwZTNjYTAzYWIyZDE2MmNmNTNiOTBkMzIzZmRiMDJmMGFkOQ==
+SHA256:
+  metadata.gz: 288b5abe607dd9f6bd602815ebc1886736196f0b0aa826d81e1c9cbc3785e142
+  data.tar.gz: 3684b30c332791771282d0cc35a3bd971ca4d709b388718727062c27ba255560
 SHA512:
-  metadata.gz: !binary |-
-    ZGM2OWU1ZGZlYmEyZTVlODMyYzJiZDU5ZDliMWI0ZjExNWMwYzFmODU5NmNl
-    ZDRlYjY5NzEzMjA5NmI0NTQwMmE0MjBiNDBkNTc2NDQ2ZGIxZTVkNDhhNzA2
-    MDFiNWMxMjhhOTA2YzUyYzMxN2ZhMzk1YjZlYmIzYjdkZDk2ZjM=
-  data.tar.gz: !binary |-
-    Zjc3ZmVkY2QzNWZjZDUxYWNiYWQ5MWRhYjlkNjM2ZTg1Nzc0MDBhNWNlZWY4
-    ZDUzYjg1YWJiZDUxYzlkN2E0ZDg1NTk5YzMwMzdiMzRkMGZhNDdhOTMyMWUw
-    ZDE0YTVmNTBkZWI1MmNjNGEyNjgyOWI1YWQyYTRkNjgzNTFhZWY=
+  metadata.gz: d92167feac3ae2409d8692c13aabe84c66ca442d6573e68bbdeb76484ecde81c62bd28acc85bb3b6ea41f88ebccecea2ac62a3da2e3dd31492ed62bcf5d4ce83
+  data.tar.gz: cfbb78af6e114eeaf121d6ae1ca7a9b84bd625f1eedbf45c1beeb74706504134f4fc76207d26fb78bfdf30260d55a1dcbb83fb1898cab7b047fbacbd19164455

data/NOTICE

@@ -0,0 +1,14 @@
+Steno
+
+Copyright (c) 2015 - Present CloudFoundry.org Foundation, Inc. All Rights Reserved.
+
+This project contains software that is Copyright (c) 2012-2015 Pivotal Software, Inc.
+
+Other copyright notices for portions of this software are listed in the LICENSE file. 
+
+This product is licensed to you under the Apache License, Version 2.0 (the "License").  
+You may not use this product except in compliance with the License.  
+
+This product may include a number of subcomponents with separate copyright notices 
+and license terms. Your use of these subcomponents is subject to the terms and 
+conditions of the subcomponent's license, as noted in the LICENSE file.

data/Rakefile

@@ -1,16 +1,14 @@
 #!/usr/bin/env rake
-require "ci/reporter/rake/rspec"
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
-task :default => :spec
+task default: :spec
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new("spec") do |t|
+desc 'Run all specs'
+RSpec::Core::RakeTask.new('spec') do |t|
   t.rspec_opts = %w[--color --format documentation]
 end
 
-desc "Run all specs and provide output for ci"
-RSpec::Core::RakeTask.new("spec:ci" => "ci:setup:rspec") do |t|
+desc 'Run all specs and provide output for ci'
+RSpec::Core::RakeTask.new('spec:ci' => 'ci:setup:rspec') do |t|
   t.rspec_opts = %w[--no-color --format documentation]
 end
-

data/bin/steno-prettify

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 
-require "optparse"
-require "yajl"
+require 'optparse'
+require 'yajl'
 
-require "steno/json_prettifier"
+require 'steno/json_prettifier'
 
-Signal.trap("INT") { exit }
+Signal.trap('INT') { exit }
 
 def prettify_io(io, prettifier, ignore_parse_error = false)
   lineno = 1
@@ -25,7 +25,7 @@ def prettify_io(io, prettifier, ignore_parse_error = false)
       if ignore_parse_error
         print line
       else
-        STDERR.puts "steno-prettify: Malformed json at line #{lineno}, '#{line.strip}'"
+        warn "steno-prettify: Malformed json at line #{lineno}, '#{line.strip}'"
       end
     end
 
@@ -35,14 +35,13 @@ end
 
 def prettify_file(path, prettifier, ignore_parse_error = false)
   begin
-    f = File.open(path, "r")
-  rescue => e
-    STDERR.puts "steno-prettify: Failed opening '#{path}', #{e}"
+    f = File.open(path, 'r')
+  rescue StandardError => e
+    warn "steno-prettify: Failed opening '#{path}', #{e}"
     return
   end
 
   prettify_io(f, prettifier, ignore_parse_error)
-
 ensure
   f.close if f
 end
@@ -51,33 +50,33 @@ excluded_fields = []
 ignore_parse_error = false
 
 option_parser = OptionParser.new do |op|
-  op.banner =<<EOT
-Usage: steno-prettify [OPTS] [FILE...]
+  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.
+    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`):
+    Examples (shamelessly stolen from `man cat`):
 
-  steno-prettify f - g
-    Prettify f's contents, then standard input, then g's contents.
+      steno-prettify f - g
+        Prettify f's contents, then standard input, then g's contents.
 
-  steno-prettify
-    Prettify contents of stdin.
+      steno-prettify
+        Prettify contents of stdin.
 
-Options:
-EOT
+    Options:
+  EOT
 
-  op.on("-h", "--help", "Display help") do
+  op.on('-h', '--help', 'Display help') do
     puts op
     exit
   end
 
-  op.on("-a", "--align", "Omit location and data in order to provide well-aligned logs") do
+  op.on('-a', '--align', 'Omit location and data in order to provide well-aligned logs') do
     excluded_fields = %w[location data]
   end
 
-  op.on("-s", "--no-messages", "Donot complain about errors in parsing logs") do
+  op.on('-s', '--no-messages', 'Donot complain about errors in parsing logs') do
     ignore_parse_error = true
   end
 end
@@ -88,10 +87,10 @@ STDOUT.sync = true
 prettifier = Steno::JsonPrettifier.new(excluded_fields)
 
 inputs = ARGV.dup
-inputs << "-" if inputs.empty?
+inputs << '-' if inputs.empty?
 
 inputs.each do |path|
-  if path == "-"
+  if path == '-'
     prettify_io(STDIN, prettifier, ignore_parse_error)
   else
     prettify_file(path, prettifier, ignore_parse_error)

data/lib/steno/codec/base.rb

@@ -27,7 +27,7 @@ class Steno::Codec::Base
       if (ord_val > 31) && (ord_val < 127)
         c
       else
-        "\\x%02x" % [ord_val]
+        format('\\x%02x', ord_val)
       end
     end.join
   end

data/lib/steno/codec/json.rb

@@ -1,6 +1,6 @@
-require "yajl"
+require 'yajl'
 
-require "steno/codec/base"
+require 'steno/codec/base'
 
 module Steno
   module Codec
@@ -8,29 +8,39 @@ module Steno
 end
 
 class Steno::Codec::Json < Steno::Codec::Base
+  def initialize(opts = {})
+    @iso8601_timestamps = opts[:iso8601_timestamps] || false
+  end
+
   def encode_record(record)
     msg =
       if record.message.valid_encoding?
         record.message
       else
         # Treat the message as an arbitrary sequence of bytes.
-        escape_nonprintable_ascii(record.message.dup.force_encoding("BINARY"))
+        escape_nonprintable_ascii(record.message.dup.force_encoding('BINARY'))
       end
 
     h = {
-      "timestamp"  => record.timestamp.to_f,
-      "message"    => msg,
-      "log_level"  => record.log_level.to_s,
-      "source"     => record.source,
-      "data"       => record.data,
-      "thread_id"  => record.thread_id,
-      "fiber_id"   => record.fiber_id,
-      "process_id" => record.process_id,
-      "file"       => record.file,
-      "lineno"     => record.lineno,
-      "method"     => record.method,
+      'timestamp' => record.timestamp.to_f,
+      'message' => msg,
+      'log_level' => record.log_level.to_s,
+      'source' => record.source,
+      'data' => record.data,
+      'thread_id' => record.thread_id,
+      'fiber_id' => record.fiber_id,
+      'process_id' => record.process_id,
+      'file' => record.file,
+      'lineno' => record.lineno,
+      'method' => record.method
     }
 
+    h['timestamp'] = Time.at(record.timestamp).utc.iso8601(6) if iso8601_timestamps?
+
     Yajl::Encoder.encode(h) + "\n"
   end
+
+  def iso8601_timestamps?
+    @iso8601_timestamps
+  end
 end

data/lib/steno/codec.rb

@@ -1,2 +1,2 @@
-require "steno/codec/base"
-require "steno/codec/json"
+require 'steno/codec/base'
+require 'steno/codec/json'

data/lib/steno/config.rb

@@ -1,9 +1,9 @@
-require "yaml"
+require 'yaml'
 
-require "steno/codec"
-require "steno/context"
-require "steno/logger"
-require "steno/sink"
+require 'steno/codec'
+require 'steno/context'
+require 'steno/logger'
+require 'steno/sink'
 
 module Steno
 end
@@ -23,7 +23,7 @@ class Steno::Config
     # @return [Steno::Config]
     def from_file(path, overrides = {})
       h = YAML.load_file(path)
-      h = h["logging"] || {}
+      h = h['logging'] || {}
       new(to_config_hash(h).merge(overrides))
     end
 
@@ -37,13 +37,15 @@ class Steno::Config
 
       level = hash[:level] || hash[:default_log_level]
       opts = {
-        :sinks => [],
-        :default_log_level => level.nil? ? :info : level.to_sym
+        sinks: [],
+        default_log_level: level.nil? ? :info : level.to_sym
       }
 
+      opts[:codec] = Steno::Codec::Json.new(iso8601_timestamps: true) if hash[:iso8601_timestamps]
+
       if hash[:file]
         max_retries = hash[:max_retries]
-        opts[:sinks] << Steno::Sink::IO.for_file(hash[:file], :max_retries => max_retries)
+        opts[:sinks] << Steno::Sink::IO.for_file(hash[:file], max_retries: max_retries)
       end
 
       if Steno::Sink::WINDOWS
@@ -51,20 +53,14 @@ class Steno::Config
           Steno::Sink::Eventlog.instance.open(hash[:eventlog])
           opts[:sinks] << Steno::Sink::Eventlog.instance
         end
-      else
-        if hash[:syslog]
-          Steno::Sink::Syslog.instance.open(hash[:syslog])
-          opts[:sinks] << Steno::Sink::Syslog.instance
-        end
+      elsif hash[:syslog]
+        Steno::Sink::Syslog.instance.open(hash[:syslog])
+        opts[:sinks] << Steno::Sink::Syslog.instance
       end
 
-      if hash[:fluentd]
-        opts[:sinks] << Steno::Sink::Fluentd.new(hash[:fluentd])
-      end
+      opts[:sinks] << Steno::Sink::Fluentd.new(hash[:fluentd]) if hash[:fluentd]
 
-      if opts[:sinks].empty?
-        opts[:sinks] << Steno::Sink::IO.new(STDOUT)
-      end
+      opts[:sinks] << Steno::Sink::IO.new(STDOUT) if opts[:sinks].empty?
 
       opts
     end
@@ -74,23 +70,20 @@ class Steno::Config
     end
   end
 
-  attr_reader :sinks
-  attr_reader :codec
-  attr_reader :context
-  attr_reader :default_log_level
+  attr_reader :sinks, :codec, :context, :default_log_level
 
   def initialize(opts = {})
     @sinks             = opts[:sinks] || []
     @codec             = opts[:codec] || Steno::Codec::Json.new
-    @context           = opts[:context] ||Steno::Context::Null.new
+    @context           = opts[:context] || Steno::Context::Null.new
 
     @sinks.each { |sink| sink.codec = @codec }
 
-    if opts[:default_log_level]
-      @default_log_level = opts[:default_log_level].to_sym
-    else
-      @default_log_level = :info
-    end
+    @default_log_level = if opts[:default_log_level]
+                           opts[:default_log_level].to_sym
+                         else
+                           :info
+                         end
   end
 
   private_class_method :symbolize_keys

data/lib/steno/context.rb

@@ -1,5 +1,5 @@
-require "fiber"
-require "thread"
+require 'fiber'
+require 'thread'
 
 class Fiber
   def __steno_context_data__
@@ -36,7 +36,7 @@ module Steno::Context
   end
 
   class ThreadLocal < Base
-    THREAD_LOCAL_KEY = "__steno_locals__"
+    THREAD_LOCAL_KEY = '__steno_locals__'
 
     def data
       Thread.current[THREAD_LOCAL_KEY] ||= {}

data/lib/steno/json_prettifier.rb

@@ -1,6 +1,6 @@
-require "digest/md5"
-require "set"
-require "yajl"
+require 'digest/md5'
+require 'set'
+require 'yajl'
 
 module Steno
 end
@@ -24,7 +24,7 @@ class Steno::JsonPrettifier
   end
 
   def initialize(excluded_fields = [])
-    @time_format = "%Y-%m-%d %H:%M:%S.%6N"
+    @time_format = '%Y-%m-%d %H:%M:%S.%6N'
     @excluded_fields = Set.new(excluded_fields)
     @max_src_len = MIN_COL_WIDTH
   end
@@ -49,8 +49,8 @@ class Steno::JsonPrettifier
       next if @excluded_fields.include?(field_name)
 
       exists = nil
-      pred_meth = "check_#{field_name}".to_sym
-      if respond_to?(pred_meth)
+      pred_meth = :"check_#{field_name}"
+      if respond_to?(pred_meth, true)
         exists = send(pred_meth, record)
       elsif record.respond_to?(:has_key?)
         exists = record.has_key?(field_name)
@@ -59,35 +59,35 @@ class Steno::JsonPrettifier
         raise ParseError, msg
       end
 
-      if exists
-        fields << send("format_#{field_name}".to_sym, record)
-      else
-        fields << "-"
-      end
+      fields << if exists
+                  send(:"format_#{field_name}", record)
+                else
+                  '-'
+                end
     end
 
-    fields.join(" ") + "\n"
+    fields.join(' ') + "\n"
   end
 
   def format_timestamp(record)
-    Time.at(record["timestamp"]).strftime(@time_format)
+    Time.at(record['timestamp']).strftime(@time_format)
   end
 
   def format_source(record)
-    @max_src_len = [@max_src_len, record["source"].length].max
-    record["source"].ljust(@max_src_len)
+    @max_src_len = [@max_src_len, record['source'].length].max
+    record['source'].ljust(@max_src_len)
   end
 
   def format_process_id(record)
-    "pid=%-5s" % [record["process_id"]]
+    format('pid=%-5s', record['process_id'])
   end
 
   def format_thread_id(record)
-    "tid=%s" % [shortid(record["thread_id"])]
+    format('tid=%s', shortid(record['thread_id']))
   end
 
   def format_fiber_id(record)
-    "fid=%s" % [shortid(record["fiber_id"])]
+    format('fid=%s', shortid(record['fiber_id']))
   end
 
   def check_location(record)
@@ -95,36 +95,37 @@ class Steno::JsonPrettifier
   end
 
   def format_location(record)
-    parts = record["file"].split("/")
+    parts = record['file'].split('/')
 
     trimmed_filename = nil
-    if parts.size == 1
-      trimmed_filename = parts[0]
-    else
-      trimmed_filename = parts.slice(-2, 2).join("/")
-    end
+    trimmed_filename = if parts.size == 1
+                         parts[0]
+                       else
+                         parts.slice(-2, 2).join('/')
+                       end
 
-    "%s/%s:%s" % [trimmed_filename, record["method"], record["lineno"]]
+    format('%s/%s:%s', trimmed_filename, record['method'], record['lineno'])
   end
 
   def check_data(record)
-    record["data"].is_a?(Hash)
+    record['data'].is_a?(Hash)
   end
 
   def format_data(record)
-    record["data"].map { |k, v| "#{k}=#{v}" }.join(",")
+    record['data'].map { |k, v| "#{k}=#{v}" }.join(',')
   end
 
   def format_log_level(record)
-    "%7s" % [record["log_level"].upcase]
+    format('%7s', record['log_level'].upcase)
   end
 
   def format_message(record)
-    "-- %s" % [record["message"]]
+    format('-- %s', record['message'])
   end
 
   def shortid(data)
-    return "-" if data.nil?
+    return '-' if data.nil?
+
     digest = Digest::MD5.hexdigest(data.to_s)
     digest[0, 4]
   end

data/lib/steno/log_level.rb

@@ -4,8 +4,7 @@ end
 class Steno::LogLevel
   include Comparable
 
-  attr_reader :name
-  attr_reader :priority
+  attr_reader :name, :priority
 
   # @param [String]  name      "info", "debug", etc.
   # @param [Integer] priority  "info" > "debug", etc.

data/lib/steno/logger.rb

@@ -1,22 +1,22 @@
-require "thread"
+require 'thread'
 
-require "steno/errors"
-require "steno/log_level"
+require 'steno/errors'
+require 'steno/log_level'
 
 module Steno
 end
 
 class Steno::Logger
   LEVELS = {
-    :off    => Steno::LogLevel.new(:off,     0),
-    :fatal  => Steno::LogLevel.new(:fatal,   1),
-    :error  => Steno::LogLevel.new(:error,   5),
-    :warn   => Steno::LogLevel.new(:warn,   10),
-    :info   => Steno::LogLevel.new(:info,   15),
-    :debug  => Steno::LogLevel.new(:debug,  16),
-    :debug1 => Steno::LogLevel.new(:debug1, 17),
-    :debug2 => Steno::LogLevel.new(:debug2, 18),
-    :all    => Steno::LogLevel.new(:all,    30),
+    off: Steno::LogLevel.new(:off, 0),
+    fatal: Steno::LogLevel.new(:fatal,   1),
+    error: Steno::LogLevel.new(:error,   5),
+    warn: Steno::LogLevel.new(:warn,   10),
+    info: Steno::LogLevel.new(:info,   15),
+    debug: Steno::LogLevel.new(:debug, 16),
+    debug1: Steno::LogLevel.new(:debug1, 17),
+    debug2: Steno::LogLevel.new(:debug2, 18),
+    all: Steno::LogLevel.new(:all, 30)
   }
 
   class << self
@@ -28,19 +28,17 @@ class Steno::Logger
     end
 
     def define_logf_method(name)
-      define_method(name.to_s + "f") { |fmt, *args| log(name, fmt % args) }
+      define_method(name.to_s + 'f') { |fmt, *args| log(name, fmt % args) }
     end
 
     def define_level_active_predicate(name)
-      define_method(name.to_s + "?") { level_active?(name) }
+      define_method(name.to_s + '?') { level_active?(name) }
     end
 
     def lookup_level(name)
       level = LEVELS[name]
 
-      if level.nil?
-        raise Steno::Error.new("Unknown level: #{name}")
-      end
+      raise Steno::Error.new("Unknown level: #{name}") if level.nil?
 
       level
     end
@@ -85,8 +83,6 @@ class Steno::Logger
     level = self.class.lookup_level(level_name)
 
     @min_level_lock.synchronize { @min_level = level }
-
-    nil
   end
 
   # Returns the name of the current log level
@@ -113,7 +109,7 @@ class Steno::Logger
 
   # @return [nil]
   def log_exception(ex, user_data = {})
-    warn("Caught exception: #{ex}", user_data.merge(:backtrace => ex.backtrace))
+    warn("Caught exception: #{ex}", user_data.merge(backtrace: ex.backtrace))
   end
 
   # Adds a record to the configured sinks.
@@ -123,7 +119,7 @@ class Steno::Logger
   # @param [Hash] user_data
   #
   # @return [nil]
-  def log(level_name, message = nil, user_data = nil, &blk)
+  def log(level_name, message = nil, user_data = nil)
     return unless level_active?(level_name)
 
     message = yield if block_given?
@@ -153,18 +149,18 @@ class Steno::Logger
   private
 
   def parse_record_loc(callstack)
-    file, lineno, method = nil, nil, nil
+    file = nil
+    lineno = nil
+    method = nil
 
     callstack.each do |frame|
       next if frame =~ /logger\.rb/
 
-      file, lineno, method = frame.split(":")
+      file, lineno, method = frame.split(':')
 
       lineno = lineno.to_i
 
-      if method =~ /in `([^']+)/
-        method = $1
-      end
+      method = ::Regexp.last_match(1) if method =~ /in `([^']+)/
 
       break
     end

data/lib/steno/record.rb

@@ -1,22 +1,12 @@
-require "digest/md5"
-require "thread"
+require 'digest/md5'
+require 'thread'
 
 module Steno
 end
 
 class Steno::Record
-
-  attr_reader :timestamp
-  attr_reader :message
-  attr_reader :log_level
-  attr_reader :source
-  attr_reader :data
-  attr_reader :thread_id
-  attr_reader :fiber_id
-  attr_reader :process_id
-  attr_reader :file
-  attr_reader :lineno
-  attr_reader :method
+  attr_reader :timestamp, :message, :log_level, :source, :data, :thread_id, :fiber_id, :process_id, :file, :lineno,
+              :method
 
   # @param [String] source  Identifies message source.
   # @param [Symbol] log_level
@@ -25,7 +15,7 @@ class Steno::Record
   #        Format is [<filename>, <lineno>, <method>].
   # @param [Hash]   data       User-supplied data
   def initialize(source, log_level, message, loc = [], data = {})
-    raise "Log level must be a Symbol" unless log_level.is_a? Symbol
+    raise 'Log level must be a Symbol' unless log_level.is_a? Symbol
 
     @timestamp  = Time.now
     @source     = source

data/lib/steno/sink/base.rb

@@ -1,5 +1,5 @@
-require "rbconfig"
-require "thread"
+require 'rbconfig'
+require 'thread'
 
 module Steno
   module Sink
@@ -10,7 +10,6 @@ end
 # Sinks represent the final destination for log records. They abstract storage
 # mediums (like files) and transport layers (like sockets).
 class Steno::Sink::Base
-
   attr_accessor :codec
 
   # @param [Steno::Codec::Base] formatter Transforms log records to their