sawmill 0.0.1

data/lib/sawmill/entry_processor/filter_basic_fields.rb

@@ -0,0 +1,145 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill entry processor that checks for entry field values.
+# 
+# -----------------------------------------------------------------------------
+# 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,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * 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
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module Sawmill
+  
+  module EntryProcessor
+    
+    
+    # A basic filter that knows how to check level and progname.
+    # 
+    # This is a boolean processor, so it merely returns true or false based
+    # on the filter result. Use this in conjunction with an If processor to
+    # actually perform other actions based on the result.
+    
+    class FilterBasicFields < Base
+      
+      
+      # Create a new filter.
+      # 
+      # Recognized options include:
+      # 
+      # <tt>:level</tt>::
+      #   Lowest level that will be accepted. This should be either a
+      #   Sawmill::Level object or an integer value or string/symbol that
+      #   represents a level. If set to nil or not specified, this filter
+      #   does not check the level.
+      # <tt>:progname</tt>::
+      #   Progname filter. This can be either a string or a Regexp. If set
+      #   to nil or not specified, this filter does not check the progname.
+      # <tt>:accept_record_delimiters</tt>::
+      #   If set to true, accepts all begin_record and end_record entries
+      #   regardless of the level or progname. If set to false, accepts no
+      #   such entries. Otherwise, if not specified, those entries are
+      #   subject to the usual level and progname filters.
+      # <tt>:accept_attributes</tt>::
+      #   If set to true, accepts all attribute and multi_attribute entries
+      #   regardless of the level or progname. If set to false, accepts no
+      #   such entries. Otherwise, if not specified, those entries are
+      #   subject to the usual level and progname filters.
+      # <tt>:accept_incomparable_levels</tt>::
+      #   If set to true, accepts entries whose level is not comparable to
+      #   the given <tt>:level</tt> setting. Otherwise, rejects all such
+      #   entries.
+      # <tt>:accept_unknown</tt>::
+      #   If set to true, accepts all entries of type :unknown_data.
+      #   Otherwise, rejects all such entries.
+      
+      def initialize(opts_={})
+        @level = opts_[:level]
+        @progname = opts_[:progname]
+        @accept_record_delimiters = opts_[:accept_record_delimiters]
+        @accept_attributes = opts_[:accept_attributes]
+        @accept_incomparable_levels = opts_[:accept_incomparable_levels]
+        @accept_unknown = opts_[:accept_unknown]
+      end
+      
+      
+      def begin_record(entry_)
+        @accept_record_delimiters.nil? ? _check_filter(entry_) : @accept_record_delimiters
+      end
+      
+      def end_record(entry_)
+        @accept_record_delimiters.nil? ? _check_filter(entry_) : @accept_record_delimiters
+      end
+      
+      def message(entry_)
+        _check_filter(entry_)
+      end
+      
+      def attribute(entry_)
+        @accept_attributes.nil? ? _check_filter(entry_) : @accept_attributes
+      end
+      
+      def unknown_data(entry_)
+        @accept_unknown
+      end
+      
+      
+      def close
+      end
+      
+      
+      private
+      
+      
+      def _check_filter(entry_)  # :nodoc:
+        if @level
+          level_ = entry_.level
+          if @level.kind_of?(::Sawmill::Level)
+            check_level_ = @level
+            if level_.group != check_level_.group
+              return false unless @accept_incomparable_levels
+            end
+          else
+            check_level_ = level_.group.get(@level)
+            unless check_level_
+              return false unless @accept_incomparable_levels
+            end
+          end
+          return false if check_level_ && level_ < check_level_
+        end
+        return false if @progname && entry_.progname != @progname
+        true
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/sawmill/entry_processor/format.rb

@@ -0,0 +1,228 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill entry processor that formats for log files
+# 
+# -----------------------------------------------------------------------------
+# 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,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * 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
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module Sawmill
+  
+  module EntryProcessor
+    
+    
+    # This processor formats log entries and writes them to a destination.
+    
+    class Format < Base
+      
+      
+      # Create a formatter.
+      # 
+      # The destination can be a ruby IO object, a Sawmill::Rotater, or any
+      # object that responds to the "write" and "close" methods as defined
+      # by the ruby IO class.
+      # 
+      # Recognized options include:
+      # 
+      # <tt>:include_id</tt>::
+      #   Include the record ID in every log entry. Default is false.
+      # <tt>:fractional_second_digits</tt>::
+      #   Number of digits of fractional seconds to display in timestamps.
+      #   Default is 2. Accepted values are 0 to 6.
+      # <tt>:level_width</tt>::
+      #   Column width of the level field.
+      # <tt>:local_time</tt>::
+      #   If true, outputs local time with the timezone offset indicator.
+      #   If false (the default), outputs UTC.
+      # <tt>:iso_8601_time</tt>::
+      #   If true, outputs time in strict ISO 8601 format.
+      #   If false (the default), outputs a slightly more readable format.
+      
+      def initialize(destination_, opts_={})
+        if destination_.kind_of?(Rotater)
+          @rotater = destination_
+          @channels = {}
+          @standby_channel = nil
+        elsif destination_.respond_to?(:close) && destination_.respond_to?(:write)
+          @io = destination_
+        else
+          raise ArgumentError, "Unknown destination type"
+        end
+        @include_id = opts_[:include_id]
+        @fractional_second_digits = (opts_[:fractional_second_digits] || 2).to_i
+        @fractional_second_digits = 0 if @fractional_second_digits < 0
+        @fractional_second_digits = 6 if @fractional_second_digits > 6
+        @usec_factor = 1
+        (6 - @fractional_second_digits).times{ @usec_factor *= 10 }
+        @level_width = opts_[:level_width]
+      end
+      
+      
+      def begin_record(entry_)
+        return false unless @io || @rotater
+        record_id_ = entry_.record_id
+        if @rotater
+          if @standby_channel
+            io_ = @standby_channel
+            @standby_channel = nil
+          else
+            io_ = @rotater.create_channel
+          end
+          @channels[record_id_] = io_
+        else
+          io_ = @io
+        end
+        io_.write(_format_entry(entry_, '^', "BEGIN #{record_id_}"))
+        true
+      end
+      
+      def end_record(entry_)
+        return false unless @io || @rotater
+        record_id_ = entry_.record_id
+        str_ = _format_entry(entry_, '$', "END #{record_id_}")
+        if @rotater
+          if (channel_ = @channels.delete(record_id_))
+            @standby_channel.close if @standby_channel
+            @standby_channel = channel_
+          else
+            @standby_channel ||= @rotater.create_channel
+          end
+          @standby_channel.write(str_)
+          @standby_channel.check_rotate
+        else
+          @io.write(str_)
+        end
+        true
+      end
+      
+      def message(entry_)
+        return false unless @io || @rotater
+        _write_str(_format_entry(entry_, '.', entry_.message), entry_.record_id)
+        true
+      end
+      
+      def attribute(entry_)
+        return false unless @io || @rotater
+        opcode_ = entry_.operation == :append ? '+' : '='
+        str_ = _format_entry(entry_, '=', "#{entry_.key} #{opcode_} #{entry_.value}")
+        _write_str(str_, entry_.record_id)
+        true
+      end
+      
+      def unknown_data(entry_)
+        return false unless @io || @rotater
+        _write_str(entry_.line+"\n", entry_.record_id)
+        true
+      end
+      
+      def close
+        if @rotater
+          @default_channel.close
+          @channels.values.each{ |channel_| channel_.close }
+          @rotater = nil
+        elsif @io
+          @io.close
+          @io = nil
+        end
+      end
+      
+      private
+      
+      def _write_str(str_, record_id_)  # :nodoc:
+        if @rotater
+          io_ = @channels[record_id_]
+          if io_
+            io_.write(str_)
+          else
+            @standby_channel ||= @rotater.create_channel
+            @standby_channel.write(str_)
+            @standby_channel.check_rotate
+          end
+        else
+          @io.write(str_)
+        end
+      end
+      
+      def _format_entry(entry_, marker_, str_)  # :nodoc:
+        id_ = @include_id ? entry_.record_id : nil
+        id_ = id_ ? ' '+id_ : ''
+        time_ = entry_.timestamp.getutc
+        str_ = str_.split("\n", -1).map do |line_|
+          if line_ =~ /(\\+)$/
+            "#{$`}#{$1}#{$1}"
+          else
+            line_
+          end
+        end.join("\\\n")
+        time_ = entry_.timestamp
+        if @local_time
+          time_ = time_.getlocal
+        else
+          time_ = time_.getutc
+        end
+        if @iso_8601_time
+          timestr_ = time_.strftime('%Y-%m-%dT%H:%M:%S')
+        else
+          timestr_ = time_.strftime('%Y-%m-%d %H:%M:%S')
+        end
+        if @fractional_second_digits > 0
+          timestr_ << (".%0#{@fractional_second_digits}d" % (time_.usec / @usec_factor))
+        end
+        if @local_time
+          offset_ = time_.utc_offset
+          neg_ = offset_ < 0
+          offset_ = -offset_ if neg_
+          offsetstr_ = "%s%02d%02d" % [(neg_ ? '-' : '+'), offset_ / 3600, (offset_ % 3600) / 60]
+          if @iso_8601_time
+            timestr_ << offsetstr_
+          else
+            timestr_ << ' ' << offsetstr_
+          end
+        elsif @iso_8601_time
+          timestr_ << 'Z'
+        end
+        levelstr_ = entry_.level.name.to_s
+        levelstr_ = levelstr_.rjust(@level_width) if @level_width
+        "[#{levelstr_} #{timestr_} #{entry_.progname}#{id_} #{marker_}] #{str_}\n"
+      end
+      
+    end
+    
+    
+  end
+  
+  
+  # Sawmill::Formatter is an alternate name for
+  # Sawmill::EntryProcessor::Format
+  Formatter = EntryProcessor::Format
+  
+  
+end

data/lib/sawmill/entry_processor/simple_queue.rb

@@ -0,0 +1,116 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill entry processor that queues entries
+# 
+# -----------------------------------------------------------------------------
+# 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,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * 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
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module Sawmill
+  
+  
+  module EntryProcessor
+    
+    
+    # This processor simply queues up log entries for later use.
+    
+    class SimpleQueue < Base
+      
+      
+      # Create a queue.
+      # 
+      # Recognized options include:
+      # 
+      # <tt>:limit</tt>::
+      #   Size limit for the queue. If not specified, the queue can grow
+      #   arbitrarily large.
+      # <tt>:drop_oldest</tt>::
+      #   If set to true, then when an item is added to a full queue, the
+      #   oldest item is dropped. If set to false or not specified, then
+      #   the new item is not added.
+      
+      def initialize(opts_={})
+        @queue = Util::Queue.new(opts_)
+        @closed = false
+      end
+      
+      
+      # Return the oldest entry in the queue, or nil if the queue is empty.
+      
+      def dequeue
+        @queue.dequeue
+      end
+      
+      
+      # Return the size of the queue, which is 0 if the queue is empty.
+      
+      def size
+        @queue.size
+      end
+      
+      
+      def begin_record(entry_)
+        @queue.enqueue(entry_) unless @closed
+        !@closed
+      end
+      
+      def end_record(entry_)
+        @queue.enqueue(entry_) unless @closed
+        !@closed
+      end
+      
+      def message(entry_)
+        @queue.enqueue(entry_) unless @closed
+        !@closed
+      end
+      
+      def attribute(entry_)
+        @queue.enqueue(entry_) unless @closed
+        !@closed
+      end
+      
+      def unknown_data(entry_)
+        @queue.enqueue(entry_) unless @closed
+        !@closed
+      end
+      
+      def close
+        @closed = true
+      end
+      
+      
+    end
+    
+    
+  end
+  
+  
+end

data/lib/sawmill/entry_processor.rb

@@ -0,0 +1,158 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill entry processor interface
+# 
+# -----------------------------------------------------------------------------
+# 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,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * 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
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module Sawmill
+  
+  
+  # Entry processors are objects that receive a stream of log entries and
+  # perform some action. Some processors perform their own action, while
+  # others could filter entries and forward them to other processors.
+  # 
+  # The API contract for an entry processor is specified by the class
+  # Sawmill::EntryProcessor::Base. Processors could subclass that base
+  # class, or could just duck-type the methods.
+  # 
+  # Sawmill's basic entry processor classes live into this module's
+  # namespace, but this is not a requirement for your own processors.
+  
+  module EntryProcessor
+    
+    
+    class Builder  # :nodoc:
+      include ::Blockenspiel::DSL
+    end
+    
+    
+    # A base class for entry processors.
+    # 
+    # Entry processors need not necessarily subclass this class, but should
+    # at least duck-type the methods.
+    # 
+    # If a class subclasses this class, *and* lives in the EntryProcessor
+    # namespace, then it will automatically be available in the build
+    # interface. See EntryProcessor#build.
+    
+    class Base
+      
+      
+      # Receive and process a Sawmill::Entry::BeginRecord.
+      
+      def begin_record(entry_)
+        true
+      end
+      
+      
+      # Receive and process a Sawmill::Entry::EndRecord.
+      
+      def end_record(entry_)
+        true
+      end
+      
+      
+      # Receive and process a Sawmill::Entry::Message.
+      
+      def message(entry_)
+        true
+      end
+      
+      
+      # Receive and process a Sawmill::Entry::Attribute.
+      
+      def attribute(entry_)
+        true
+      end
+      
+      
+      # Receive and process a Sawmill::Entry::UnknownData.
+      
+      def unknown_data(entry_)
+        true
+      end
+      
+      
+      # Close down the processor. After this is called, the processor should
+      # ignore any further entries.
+      
+      def close
+      end
+      
+      
+      def self.inherited(subclass_)  # :nodoc:
+        if subclass_.name =~ /^Sawmill::EntryProcessor::(.*)$/
+          name_ = $1
+          Builder.class_eval do
+            define_method(name_) do |*args_|
+              subclass_.new(*args_)
+            end
+          end
+        end
+      end
+      
+      
+      private
+      
+      def _interpret_processor_array(param_)  # :nodoc:
+        param_.flatten.map{ |processor_| _interpret_processor(processor_) }
+      end
+      
+      def _interpret_processor(param_)  # :nodoc:
+        case param_
+        when Class
+          param_.new
+        when Base
+          param_
+        else
+          raise ArgumentError, "Unknown processor object of type #{param_.class.name}"
+        end
+      end
+      
+      
+    end
+    
+    
+    # A convenience DSL for building sets of processors. This is typically
+    # useful for constructing if-expressions using the boolean operation
+    # processors.
+    
+    def self.build(&block_)
+      ::Blockenspiel.invoke(block_, Builder.new)
+    end
+    
+    
+  end
+  
+  
+end