sawmill 0.1.16 → 0.1.17

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 0.1.17 / 2012-12-14
+
+* The Rails config now supports an entry_filter setting, which lets you pre-filter log entries before they get handed over to the formatter.
+* Implemented Sawmill::EntryProcessor::FilterByMessage.
+* The gemspec no longer includes the timestamp in the version, so that bundler can pull from github. (Reported by corneverbruggen)
+
 === 0.1.16 / 2012-06-04
 
 * The :local_time and :iso_8601_time arguments to Sawmill::EntryProcessor::Format didn't have their advertised effect. Fixed.

data/README.rdoc

@@ -27,7 +27,7 @@ Sawmill is an extension to the standard ruby Logger mechanism that enables autom
 === Requirements
 
 * Ruby 1.8.7 or later (Ruby 1.9.2 or later recommended), or JRuby 1.4 or later.
-* Blockenspiel 0.4.3 or later.
+* Blockenspiel 0.4.5 or later.
 
 === Installation
 
@@ -39,23 +39,29 @@ Sawmill is currently under development, and some features are not yet complete o
 
 === Development and support
 
-Documentation is available at http://virtuoso.rubyforge.org/sawmill/README_rdoc.html
+Documentation is available at http://dazuma.github.com/sawmill/rdoc
 
 Source code is hosted on Github at http://github.com/dazuma/sawmill
 
+Contributions are welcome. Fork the project on Github.
+
+Build status: {<img src="https://secure.travis-ci.org/dazuma/sawmill.png" />}[http://travis-ci.org/dazuma/sawmill]
+
 Report bugs on Github issues at http://github.org/dazuma/sawmill/issues
 
 Contact the author at dazuma at gmail dot com.
 
 === Author / Credits
 
-Sawmill is written by Daniel Azuma (http://www.daniel-azuma.com/).
+Sawmill is written by Daniel Azuma (http://www.daniel-azuma.com).
+
+Development is supported by Pirq (http://www.pirq.com).
 
-Development of Sawmill is sponsored by GeoPage (http://www.geopage.com/).
+Continuous integration service provided by Travis-CI (http://travis-ci.org).
 
 === License
 
-Copyright 2009-2011 Daniel Azuma.
+Copyright 2009-2012 Daniel Azuma.
 
 All rights reserved.
 

data/Version

@@ -1 +1 @@
-0.1.16
+0.1.17

data/lib/sawmill.rb

@@ -53,6 +53,7 @@ require 'sawmill/entry_processor'
 require 'sawmill/entry_processor/conditionals'
 require 'sawmill/entry_processor/simple_queue'
 require 'sawmill/entry_processor/filter_by_basic_fields'
+require 'sawmill/entry_processor/filter_by_message'
 require 'sawmill/entry_processor/filter_by_block'
 require 'sawmill/entry_processor/build_records'
 require 'sawmill/entry_processor/format'

data/lib/sawmill/entry_processor/filter_by_message.rb

@@ -0,0 +1,96 @@
+# -----------------------------------------------------------------------------
+#
+# Sawmill entry processor that checks message content.
+#
+# -----------------------------------------------------------------------------
+# Copyright 2012 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 message content.
+    #
+    # 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 FilterByMessage < Base
+
+
+      # Create a new filter. you must provide content, which can be a
+      # string or a regex.
+      #
+      # Recognized options include:
+      #
+      # [<tt>:accept_non_messages</tt>]
+      #   If set to true, accepts entries that are not messages. Otherwise,
+      #   if set to false or not specified, rejects such entries.
+
+      def initialize(content_, opts_={})
+        @content = content_
+        @accept_non_messages = opts_[:accept_non_messages] ? true : false
+      end
+
+
+      def begin_record(entry_)
+        @accept_non_messages
+      end
+
+      def end_record(entry_)
+        @accept_non_messages
+      end
+
+      def message(entry_)
+        @content === entry_.message
+      end
+
+      def attribute(entry_)
+        @accept_non_messages
+      end
+
+      def unknown_data(entry_)
+        @accept_non_messages
+      end
+
+      def finish
+        nil
+      end
+
+
+    end
+
+
+  end
+
+end

data/lib/sawmill/railtie.rb

@@ -81,12 +81,17 @@ module Sawmill
         @elapsed_time_attribute = nil
         @pre_logger = nil
         @post_logger = nil
+        @entry_filter = 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
 
+      # An optional filter to run on log entries before they get passed
+      # to the formatter.
+      attr_accessor :entry_filter
+
       # This option is passed to Sawmill::EntryProcessor::Format::new
       attr_accessor :include_id
       # This option is passed to Sawmill::EntryProcessor::Format::new
@@ -156,8 +161,13 @@ module Sawmill
         :local_time => myconfig_.local_time,
         :iso_8601_time => myconfig_.iso_8601_time,
         :length_limit => myconfig_.length_limit)
+      if (filter_ = myconfig_.entry_filter)
+        processor_ = EntryProcessor::If.new(filter_, formatter_)
+      else
+        processor_ = formatter_
+      end
       logger_ = Logger.new(
-        :processor => formatter_,
+        :processor => processor_,
         :level => myconfig_.level,
         :attribute_level  => myconfig_.attribute_level,
         :progname => myconfig_.progname,

data/test/tc_entry_processors.rb

@@ -81,6 +81,21 @@ module Sawmill
       end
 
 
+      # Test a message filter
+
+      def test_basic_message_filter
+        processor_ = ::Sawmill::EntryProcessor::build do
+          If(FilterByMessage(/hello/), @entries)
+        end
+        @logger = ::Sawmill::Logger.new(:processor => processor_)
+        @logger.info('hi Hello')
+        @logger.info('ho hello')
+        @logger.info('he Hello')
+        assert_equal('ho hello', @entries.dequeue.message)
+        assert_equal(0, @entries.size)
+      end
+
+
       # Test an "AND" filter
 
       def test_conjunction_and

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sawmill
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blockenspiel
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.5
 description: Sawmill is a logging and log analysis system for Ruby. It extends the
   basic Ruby logging facility with log records and parsing abilities.
 email: dazuma@gmail.com
@@ -44,6 +44,7 @@ files:
 - lib/sawmill/entry_processor/count_entries.rb
 - lib/sawmill/entry_processor/filter_by_basic_fields.rb
 - lib/sawmill/entry_processor/filter_by_block.rb
+- lib/sawmill/entry_processor/filter_by_message.rb
 - lib/sawmill/entry_processor/format.rb
 - lib/sawmill/entry_processor/interpret_stats.rb
 - lib/sawmill/entry_processor/simple_queue.rb
@@ -89,7 +90,7 @@ files:
 - History.rdoc
 - README.rdoc
 - Version
-homepage: http://virtuoso.rubyforge.org/sawmill
+homepage: http://dazuma.github.com/sawmill
 licenses: []
 post_install_message: 
 rdoc_options: []