sawmill 0.1.15 → 0.1.16

data/lib/sawmill/multi_parser.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill multi-stream parser utility
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,31 +35,31 @@
 
 
 module Sawmill
-  
-  
+
+
   # A logfile parser that parses log entries from multiple logfile streams,
   # sorts by timestamp, and sends them to a processor.
-  
+
   class MultiParser
-    
-    
+
+
     # Create a new parser that reads from the given streams.
-    # 
+    #
     # You should provide a processor to receive the data from the logfile.
     # The processor may be either an entry processor or a record processor.
     # You may also pass nil for the processor. In this case, the generated
     # log entries will not be sent to a processor but will still be returned
     # by the parse_one_entry method.
-    # 
+    #
     # Recognized options include:
-    # 
+    #
     # [<tt>:levels</tt>]
     #   Sawmill::LevelGroup to use to parse log levels.
     #   If not specified, Sawmill::STANDARD_LEVELS is used by default.
     # [<tt>:emit_incomplete_records_at_eof</tt>]
     #   If set to true, causes any incomplete log records to be emitted
     #   in their incomplete state when EOF is reached on all streams.
-    
+
     def initialize(io_array_, processor_, opts_={})
       @emit_incomplete_records_at_eof = opts_.delete(:emit_incomplete_records_at_eof)
       @heap = Util::Heap.new{ |a_, b_| a_[1].timestamp <=> b_[1].timestamp }
@@ -80,12 +80,12 @@ module Sawmill
       end
       @classifier = @processor ? EntryClassifier.new(@processor) : nil
     end
-    
-    
+
+
     # Parse one log entry from the streams and emit it to the processor.
     # Also returns the log entry.
     # Returns nil if EOF has been reached on all streams.
-    
+
     def parse_one_entry
       entry_ = @queue.dequeue
       unless entry_
@@ -102,18 +102,18 @@ module Sawmill
       @classifier.entry(entry_) if entry_
       entry_
     end
-    
-    
+
+
     # Parse until EOF is reached on all streams, and emit the log
     # entries to the processor.
-    
+
     def parse_all
       while parse_one_entry; end
     end
-    
-    
+
+
     private
-    
+
     def _enqueue(parser_)  # :nodoc:
       loop do
         entry_ = parser_.parse_one_entry
@@ -126,9 +126,9 @@ module Sawmill
         end
       end
     end
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/sawmill/parser.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill stream parser utility
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,13 +35,13 @@
 
 
 module Sawmill
-  
-  
+
+
   # A logfile parser that parses log entries from a logfile and sends them
   # to an entry processor.
-  
+
   class Parser
-    
+
     # :stopdoc:
     LINE_REGEXP = /^\[\s*([[:graph:]]+)\s+(\d{4})-(\d{2})-(\d{2})(T|\s)(\d{2}):(\d{2}):(\d{2})(.(\d{1,6}))?Z?\s?([+-]\d{4})?\s+([[:graph:]]+)(\s+([[:graph:]]+))?\s+([\^$.=])\]\s(.*)$/
     DIRECTIVE_REGEXP = /^#\s+sawmill_format:\s+(\w+)=(.*)$/
@@ -49,18 +49,18 @@ module Sawmill
     SUPPORTS_ENCODING = defined?(::Encoding)
     ENCODING_OPTS = {:invalid => :replace, :undef => :replace}
     # :startdoc:
-    
-    
+
+
     # Create a new parser that reads from the given stream.
-    # 
+    #
     # You should provide a processor to receive the data from the logfile.
     # The processor may be either an entry processor or a record processor.
     # You may also pass nil for the processor. In this case, the generated
     # log entries will not be sent to a processor but will still be returned
     # by the parse_one_entry method.
-    # 
+    #
     # Recognized options include:
-    # 
+    #
     # [<tt>:levels</tt>]
     #   Sawmill::LevelGroup to use to parse log levels.
     #   If not specified, Sawmill::STANDARD_LEVELS is used by default.
@@ -77,7 +77,7 @@ module Sawmill
     #   Transcodes strings as they are read. (Ruby 1.9 only). If specified,
     #   lines are transcoded into this encoding after they are read from
     #   the stream. If not specified, no post-transcoding is done.
-    
+
     def initialize(io_, processor_, opts_={})
       @io = io_
       @processor = nil
@@ -96,12 +96,12 @@ module Sawmill
         @internal_encoding = ::Encoding.find(@internal_encoding) if @internal_encoding && !@internal_encoding.kind_of?(::Encoding)
       end
     end
-    
-    
+
+
     # Parse one log entry from the stream and emit it to the processor.
     # Also returns the log entry.
     # Returns nil if EOF has been reached.
-    
+
     def parse_one_entry
       str_ = _get_next_line
       entry_ = nil
@@ -181,19 +181,19 @@ module Sawmill
       end
       entry_
     end
-    
-    
+
+
     # Parse the rest of the stream until EOF is reached, and emit the log
     # entries to the processor.
-    
+
     def parse_all
       while parse_one_entry; end
     end
-    
-    
+
+
     private
-    
-    
+
+
     def _get_next_line  # :nodoc:
       str_ = @io.gets
       if str_ && SUPPORTS_ENCODING
@@ -202,8 +202,8 @@ module Sawmill
       end
       str_
     end
-    
-    
+
+
     def _set_parser_directive(key_, value_)  # :nodoc:
       case key_
       when 'encoding'
@@ -213,9 +213,9 @@ module Sawmill
         end
       end
     end
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/sawmill/railtie.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill railtie
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -39,29 +39,29 @@ require 'rails/railtie'
 
 
 module Sawmill
-  
-  
+
+
   # Railtie that replaces the default Rails logger with a Sawmill logger.
   # Sets the Rails logger to a Sawmill::Logger, and installs a
   # Sawmill::LogRecordMiddleware to enable record-based logging.
-  # 
+  #
   # To install into a Rails app, include this line in your
   # config/application.rb:
   #   require 'sawmill/railtie'
   # It should appear before your application configuration.
-  # 
+  #
   # You can then configure sawmill using the standard rails configuration
   # mechanism. The sawmill configuration lives in the config.sawmill
   # configuration namespace. See Sawmill::Railtie::Configuration for the
   # configuration options.
-  
+
   class Railtie < ::Rails::Railtie
-    
-    
+
+
     # Configuration options. These are attributes of config.sawmill.
-    
+
     class Configuration
-      
+
       def initialize  # :nodoc:
         @logfile = ::STDERR
         @include_id = false
@@ -82,11 +82,11 @@ module Sawmill
         @pre_logger = nil
         @post_logger = nil
       end
-      
+
       # The log file to write to. This should be either an IO object, or
       # a Sawmill::Rotater. Default is STDERR.
       attr_accessor :logfile
-      
+
       # This option is passed to Sawmill::EntryProcessor::Format::new
       attr_accessor :include_id
       # This option is passed to Sawmill::EntryProcessor::Format::new
@@ -99,7 +99,7 @@ module Sawmill
       attr_accessor :iso_8601_time
       # This option is passed to Sawmill::EntryProcessor::Format::new
       attr_accessor :length_limit
-      
+
       # This option is passed to Sawmill::Logger::new
       attr_accessor :level
       # This option is passed to Sawmill::Logger::new
@@ -110,7 +110,7 @@ module Sawmill
       attr_accessor :record_progname
       # This option is passed to Sawmill::Logger::new
       attr_accessor :record_id_generator
-      
+
       # This option is passed to Sawmill::LogRecordMiddleware::new
       attr_accessor :request_id_key
       # This option is passed to Sawmill::LogRecordMiddleware::new
@@ -119,8 +119,8 @@ module Sawmill
       attr_accessor :end_time_attribute
       # This option is passed to Sawmill::LogRecordMiddleware::new
       attr_accessor :elapsed_time_attribute
-      
-      
+
+
       def pre_logger(proc_=false, &block_)
         if block_
           @pre_logger = block_
@@ -130,7 +130,7 @@ module Sawmill
         @pre_logger
       end
       attr_writer :pre_logger
-      
+
       def post_logger(proc_=false, &block_)
         if block_
           @post_logger = block_
@@ -140,13 +140,13 @@ module Sawmill
         @post_logger
       end
       attr_writer :post_logger
-      
+
     end
-    
-    
+
+
     config.sawmill = Configuration.new
-    
-    
+
+
     initializer :initialize_sawmill, :before => :initialize_logger do |app_|
       myconfig_ = app_.config.sawmill
       formatter_ = Formatter.new(myconfig_.logfile || ::STDERR,
@@ -173,9 +173,9 @@ module Sawmill
         :pre_logger => myconfig_.pre_logger,
         :post_logger => myconfig_.post_logger)
     end
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/sawmill/record.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill log record class
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,15 +35,15 @@
 
 
 module Sawmill
-  
-  
+
+
   # A log record.
-  # 
+  #
   # Log records are sequences of related log entries with a common record
   # ID, beginning with a begin_record and ending with an end_record. Log
   # records therefore can be analyzed as a group, for example to measure the
   # time taken by an aggregate action such as a website request.
-  # 
+  #
   # Log records must follow a particular protocol:
   #
   # * The first entry must be begin_record.
@@ -51,21 +51,21 @@ module Sawmill
   # * No other begin_record or end_record entries may be present.
   # * All entries must have the same non-nil record_id.
   # * Entries must be in nondecreasing order of timestamp.
-  # 
+  #
   # The only exception to these rules are incomplete log records, in which
   # the final end_record is not present.
-  
+
   class Record
-    
-    
+
+
     # Create a log record.
-    # 
+    #
     # You may optionally pass in an array of log entries to populate the
     # record either partially or completely. If you do, note that
     # Errors::IllegalRecordError may be raised if the log entries do not
     # follow the log record protocol-- e.g. if the first entry is not a
     # begin_record, etc.
-    
+
     def initialize(entries_=nil)
       @started = false
       @complete = false
@@ -79,32 +79,32 @@ module Sawmill
         end
       end
     end
-    
-    
+
+
     def to_s  # :nodoc:
       "#{type}: #{@line}"
     end
-    
+
     def inspect  # :nodoc:
       "#<#{self.class}:0x#{object_id.to_s(16)} record_id=#{record_id.inspect}>"
     end
-    
-    
+
+
     def eql?(obj_)  # :nodoc:
       return false unless obj_.kind_of?(Record)
       return @entries == obj_.instance_variable_get(:@entries)
     end
-    
+
     def ==(obj_)  # :nodoc:
       eql?(obj_)
     end
-    
-    
+
+
     # Append a log entry to this record.
-    # 
+    #
     # Entries must be added in order. Raises Errors::IllegalRecordError if
     # the log record protocol is violated
-    
+
     def add_entry(entry_)
       empty_ = @entries.size == 0
       if entry_.type == :unknown_data
@@ -156,70 +156,70 @@ module Sawmill
       end
       @entries << entry_
     end
-    
-    
+
+
     # Returns true if the initial begin_record has been added.
-    
+
     def started?
       @started
     end
-    
-    
+
+
     # Returns true if the final end_record has been added.
-    
+
     def complete?
       @complete
     end
-    
-    
+
+
     # Returns the record ID as a string.
-    
+
     def record_id
       @entries.size > 0 ? @entries.first.record_id : nil
     end
-    
-    
+
+
     # Returns the beginning timestamp as a Time object, if the log record
     # has been started, or nil otherwise.
-    
+
     def begin_timestamp
       @started ? @entries.first.timestamp : nil
     end
-    
-    
+
+
     # Returns the ending timestamp as a Time object, if the log record
     # has been completed, or nil otherwise.
-    
+
     def end_timestamp
       @complete ? @entries.last.timestamp : nil
     end
-    
-    
+
+
     # Returns the number of log entries currently in this record.
-    
+
     def entry_count
       @entries.size
     end
-    
+
     alias_method :size, :entry_count
-    
-    
+
+
     # Returns the number of message entries currently in this record.
-    
+
     def message_count
       @message_count
     end
-    
-    
+
+
     # Iterate over all log entries, passing each to the given block.
-    
+
     def each_entry(&block_)
       @entries.each(&block_)
     end
-    
-    
+
+
     # Iterate over all log message entries, passing each to the given block.
-    
+
     def each_message
       @entries.each do |entry_|
         if entry_.type == :message
@@ -227,53 +227,53 @@ module Sawmill
         end
       end
     end
-    
-    
+
+
     # Returns an array of all log entries.
-    
+
     def all_entries
       @entries.dup
     end
-    
-    
+
+
     # Returns an array of all log message entries.
-    
+
     def all_messages
       @entries.find_all{ |entry_| entry_.type == :message }
     end
-    
-    
+
+
     # Get the value of the given attribute.
     # Returns a string if the attribute has a single value.
     # Returns an array of strings if the attribute has multiple values.
     # Returns nil if the attribute is not set.
-    
+
     def attribute(key_)
       @attributes[key_.to_s]
     end
-    
-    
+
+
     # Get an array of attribute keys present in this log record.
-    
+
     def attribute_keys
       @attributes.keys
     end
-    
-    
+
+
     # Compute and cache a value.
     # This is a convenient way for RecordProcessor objects to share
     # computed information about a record.
-    # 
+    #
     # Returns the computed value with the given key.
     # If the given key has not been computed yet, computes it by
     # calling the given block and passing self.
-    
+
     def compute(key_)
       @computations[key_] ||= yield self
     end
-    
-    
+
+
   end
-  
-  
+
+
 end