sawmill 0.0.1

data/lib/sawmill/record_processor/filter_by_attributes.rb

@@ -0,0 +1,87 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill record processor that checks record attribute 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 RecordProcessor
+    
+    
+    # A record filter that checks attribute values.
+    # 
+    # 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 FilterByAttributes < Base
+      
+      
+      # Create a new filter. Pass the attribute names and values to check
+      # as a hash.
+      
+      def initialize(attributes_)
+        @attributes = {}
+        attributes_.each{ |key_, value_| @attributes[key_.to_s] = value_ }
+      end
+      
+      
+      def record(record_)
+        @attributes.each do |key_, value_|
+          record_value_ = record_.attribute(key_.to_s)
+          case record_value_
+          when Array
+            return false unless record_value_.find{ |rval_| value_ === rval_ }
+          when String
+            return false unless value_ === record_value_
+          when nil
+            return false unless value_.nil?
+          end
+        end
+        true
+      end
+      
+      def extra_entry(entry_)
+        false
+      end
+      
+      def close
+      end
+      
+    end
+    
+    
+  end
+  
+end

data/lib/sawmill/record_processor/filter_by_record_id.rb

@@ -0,0 +1,77 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill record processor that checks record IDs
+# 
+# -----------------------------------------------------------------------------
+# 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 RecordProcessor
+    
+    
+    # A record filter that checks record IDs.
+    # 
+    # 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 FilterByRecordID < Base
+      
+      
+      # Create a new filter that checks against the given record ID.
+      # The given ID may be a string or a Regexp, in which case the filter
+      # will check for equality or regular expression match, respectively.
+      
+      def initialize(id_)
+        @record_id = id_
+      end
+      
+      
+      def record(record_)
+        @record_id === record_.record_id
+      end
+      
+      def extra_entry(entry_)
+        id_ = entry_.respond_to?(:record_id) ? entry_.record_id : nil
+        @record_id === id_
+      end
+      
+      def close
+      end
+      
+    end
+    
+    
+  end
+  
+end

data/lib/sawmill/record_processor/format.rb

@@ -0,0 +1,88 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill record 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 RecordProcessor
+    
+    
+    # This processor formats log records 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.
+      
+      def initialize(destination_, opts_={})
+        @formatter = EntryProcessor::Format.new(destination_, opts_)
+        @classifier = EntryClassifier.new(@formatter)
+      end
+      
+      
+      def record(record_)
+        record_.each_entry{ |entry_| @classifier.entry(entry_) }
+        true
+      end
+      
+      def extra_entry(entry_)
+        @classifier.entry(entry_)
+        true
+      end
+      
+      def close
+        @formatter.close
+      end
+      
+    end
+    
+    
+  end
+  
+end

data/lib/sawmill/record_processor/simple_queue.rb

@@ -0,0 +1,117 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill record processor queues log records
+# 
+# -----------------------------------------------------------------------------
+# 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 RecordProcessor
+    
+    
+    # This processor simply queues up log records for later use.
+    
+    class SimpleQueue < Base
+      
+      
+      # Create a queue. This processor actually maintains two separate
+      # queues, one for records and another for extra entries.
+      # 
+      # 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_)
+        @extra_entries_queue = Util::Queue.new(opts_)
+        @closed = false
+      end
+      
+      
+      # Return the oldest record in the record queue, or nil if the record
+      # queue is empty.
+      
+      def dequeue
+        @queue.dequeue
+      end
+      
+      
+      # Return the number of records in the record queue.
+      
+      def size
+        @queue.size
+      end
+      
+      
+      # Return the oldest entry in the extra entry queue, or nil if the
+      # extra entry queue is empty.
+      
+      def dequeue_extra_entry
+        @extra_entries_queue.dequeue
+      end
+      
+      
+      # Return the number of entries in the extra entry queue.
+      
+      def extra_entries_size
+        @extra_entries_queue.size
+      end
+      
+      
+      def record(record_)
+        @queue.enqueue(record_) unless @closed
+      end
+      
+      def extra_entry(entry_)
+        @extra_entries_queue.enqueue(entry_) unless @closed
+      end
+      
+      def close
+        @closed = true
+      end
+      
+      
+    end
+    
+    
+  end
+  
+  
+end

data/lib/sawmill/record_processor.rb

@@ -0,0 +1,137 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill record 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 records and
+  # perform some action. Some processors perform their own action, while
+  # others could filter records and forward them to other processors.
+  # 
+  # The API contract for a record processor is specified by the class
+  # Sawmill::RecordProcessor::Base. Processors could subclass that base
+  # class, or could just duck-type the methods.
+  # 
+  # Sawmill's basic record processor classes live into this module's
+  # namespace, but this is not a requirement for your own processors.
+  
+  module RecordProcessor
+    
+    
+    class Builder  # :nodoc:
+      include ::Blockenspiel::DSL
+    end
+    
+    
+    # A base class for record processors.
+    # 
+    # Record 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 RecordProcessor
+    # namespace, then it will automatically be available in the build
+    # interface. See RecordProcessor#build.
+    
+    class Base
+      
+      
+      # Receive and process a Sawmill::Record.
+      
+      def record(record_)
+        true
+      end
+      
+      
+      # Receive and process an entry that falls outside a record.
+      
+      def extra_entry(entry_)
+        true
+      end
+      
+      
+      # Close down the processor. After this is called, the processor should
+      # ignore any further records.
+      
+      def close
+      end
+      
+      
+      def self.inherited(subclass_)  # :nodoc:
+        if subclass_.name =~ /^Sawmill::RecordProcessor::(.*)$/
+          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

data/lib/sawmill/rotater/base.rb

@@ -0,0 +1,90 @@
+# -----------------------------------------------------------------------------
+# 
+# Sawmill formatter 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,
+#   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
+  
+  class Rotater
+    
+    
+    # This class defines the rotation strategy contract. Classes that
+    # implement rotation strategies need not subclass this base class, but
+    # must implement the methods defined here.
+    # 
+    # This base class itself merely writes to STDOUT and does not do
+    # any rotation.
+    
+    class Base
+      
+      
+      # Return the currently preferred handle, identifying which io stream
+      # should be written to preferentially unless a channel is constrained
+      # to use an earlier stream.
+      
+      def preferred_handle
+        0
+      end
+      
+      
+      # Open and return an IO object for the given handle.
+      # This is guaranteed not to be called twice unless the stream has been
+      # closed in the meantime.
+      
+      def open_handle(handle_)
+        STDOUT
+      end
+      
+      
+      # Close the IO object for the given handle.
+      # This is guaranteed not be called unless the stream has been opened.
+      
+      def close_handle(handle_, io_)
+      end
+      
+      
+      # This is a hook that is called before every write request to any
+      # stream managed by this rotater. You may optionally perform any
+      # periodic tasks here, such as renaming log files.
+      
+      def before_write
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end