buffered_syslogger 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 László Bácsi, Secret Sauce Partners, Inc.
+Copyright (c) 2010 Cyril Rohr, INRIA Rennes-Bretagne Atlantique
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= BufferedSyslogger
+
+A drop-in replacement for the Rails 3 default BufferedLogger library,
+that logs to syslog instead of a log file. Builds on the `syslogger` gem.
+
+== Installation
+
+Put it into your Gemfile:
+
+  gem 'buffered_syslogger'
+
+== Usage
+  # Somewhere in you application initialization (e.g. production.rb)
+  # will send all messages to the local0 facility, adding the process id in the message
+  config.logger = BufferedSyslogger.new("app_name", Syslog::LOG_PID, Syslog::LOG_LOCAL0)
+  
+  # Later...
+  # Send messages that are at least of the Logger::INFO level
+  Rails.logger.level = Logger::INFO # use Logger levels
+  
+  Rails.logger.debug "will not appear"
+  Rails.logger.info "will appear"
+  Rails.logger.warn "will appear"
+
+== Copyright
+
+Copyright (c) 2010 László Bács, Secret Sauce Partners, Inc.
+Copyright (c) 2010 Cyril, INRIA Rennes-Bretagne Atlantique.
+
+See LICENSE for details.

data/lib/buffered_syslogger.rb

@@ -0,0 +1,85 @@
+require 'syslog'
+require 'logger'
+require 'active_support/buffered_logger'
+
+class BufferedSyslogger < ActiveSupport::BufferedLogger
+  attr_reader :ident, :options, :facility
+
+  MAPPING = {
+    Logger::DEBUG => Syslog::LOG_DEBUG,
+    Logger::INFO => Syslog::LOG_INFO,
+    Logger::WARN => Syslog::LOG_NOTICE,
+    Logger::ERROR => Syslog::LOG_WARNING,
+    Logger::FATAL => Syslog::LOG_ERR,
+    Logger::UNKNOWN => Syslog::LOG_ALERT
+  }
+
+  #
+  # Initializes default options for the logger
+  # <tt>ident</tt>:: the name of your program [default=$0].
+  # <tt>options</tt>::  syslog options [default=<tt>Syslog::LOG_PID | Syslog::LOG_CONS</tt>].
+  #                     Correct values are:
+  #                       LOG_CONS    : writes the message on the console if an error occurs when sending the message;
+  #                       LOG_NDELAY  : no delay before sending the message;
+  #                       LOG_PERROR  : messages will also be written on STDERR;
+  #                       LOG_PID     : adds the process number to the message (just after the program name)
+  # <tt>facility</tt>:: the syslog facility [default=nil] Correct values include:
+  #                       Syslog::LOG_DAEMON
+  #                       Syslog::LOG_USER
+  #                       Syslog::LOG_SYSLOG
+  #                       Syslog::LOG_LOCAL2
+  #                       Syslog::LOG_NEWS
+  #                       etc.
+  #
+  # Usage:
+  #   logger = BufferedSyslogger.new("my_app", Syslog::LOG_PID | Syslog::LOG_CONS, Syslog::LOG_LOCAL0)
+  #   logger.level = Logger::INFO # use Logger levels
+  #   logger.warn "warning message"
+  #   logger.debug "debug message"
+  #
+  def initialize(ident = $0, options = Syslog::LOG_PID | Syslog::LOG_CONS, facility = nil)
+    @ident = ident
+    @options = options || (Syslog::LOG_PID | Syslog::LOG_CONS)
+    @facility = facility
+
+    @level = Logger::INFO
+    @buffer = {}
+    @auto_flushing = 1
+    @guard = Mutex.new
+  end
+
+  # Low level method to add a message.
+  # +severity+::  the level of the message. One of Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR, Logger::FATAL, Logger::UNKNOWN
+  # +message+:: the message string. If nil, the method will call the block and use the result as the message string.
+  # +progname+:: unsupported, kept for compatibility
+  def add(severity, message = nil, progname = nil, &block)
+    return if @level > severity
+    (message || (block && block.call) || progname).to_s.chomp.tap do |m|
+      buffer << [severity, m]
+      auto_flush
+    end
+  end
+
+  def flush
+    @guard.synchronize do
+      unless buffer.empty?
+        old_buffer = buffer
+        Syslog.open(@ident, @options, @facility) do |s|
+          s.mask = Syslog::LOG_UPTO(MAPPING[@level])
+          old_buffer.each do |severity, message|
+            message.split(/[\r\f\n]/).each { |m| s.log(MAPPING[severity], m) }
+          end
+        end
+      end
+
+      # Important to do this even if buffer was empty or else @buffer will
+      # accumulate empty arrays for each request where nothing was logged.
+      clear_buffer
+    end
+  end
+
+  def close
+    flush
+  end
+
+end

data/spec/buffered_syslogger_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe BufferedSyslogger do
+
+  let(:syslog) { mock("syslog", :mask= => true) }
+
+  it "should log to the default syslog facility, with the default options" do
+    logger = BufferedSyslogger.new
+    Syslog.should_receive(:open).with($0, Syslog::LOG_PID | Syslog::LOG_CONS, nil).and_yield(syslog)
+    syslog.should_receive(:log).with(Syslog::LOG_NOTICE, "Some message")
+    logger.warn "Some message"
+  end
+
+  it "should log to the user facility, with specific options" do
+    logger = BufferedSyslogger.new("my_app", Syslog::LOG_PID, Syslog::LOG_USER)
+    Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog)
+    syslog.should_receive(:log).with(Syslog::LOG_NOTICE, "Some message")
+    logger.warn "Some message"
+  end
+
+  %w{debug info warn error fatal unknown}.each do |logger_method|
+    it "should respond to the #{logger_method.inspect} method" do
+      BufferedSyslogger.new.should respond_to logger_method.to_sym
+    end
+  end
+
+  %w{debug info warn error fatal unknown}.each do |logger_method|
+    it "should respond to the #{logger_method.inspect}? method" do
+      BufferedSyslogger.new.should respond_to "#{logger_method}?".to_sym
+    end
+  end
+
+  describe "add" do
+    before do
+      @logger = BufferedSyslogger.new("my_app", Syslog::LOG_PID, Syslog::LOG_USER)
+    end
+    it "should respond to add" do
+      @logger.should respond_to(:add)
+    end
+    it "should correctly log" do
+      Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog)
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
+      @logger.add(Logger::INFO, "message")
+    end
+    it "should take the message from the block if :message is nil" do
+      Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog)
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "my message")
+      @logger.add(Logger::INFO) { "my message" }
+    end
+  end
+
+  context "when used in buffered mode" do
+    before { subject.auto_flushing = false }
+
+    it "without flushing should not send anything to syslog" do
+      Syslog.should_not_receive(:open)
+      subject.warn "Self destruction in progress..."
+    end
+
+    it "should send the messages to syslog when flushed" do
+      Syslog.should_receive(:open).and_yield(syslog)
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "Self destruction in 3...")
+      syslog.should_receive(:log).with(Syslog::LOG_NOTICE, "2..")
+      syslog.should_receive(:log).with(Syslog::LOG_WARNING, "1.")
+      subject.info "Self destruction in 3..."
+      subject.warn "2.."
+      subject.error "1."
+      subject.flush
+    end
+
+    it "should split messages with multiple lines and send separately" do
+      Syslog.should_receive(:open).and_yield(syslog)
+      syslog.should_receive(:log).with(Syslog::LOG_WARNING, "Self destruction in 3...")
+      syslog.should_receive(:log).with(Syslog::LOG_WARNING, "2..")
+      syslog.should_receive(:log).with(Syslog::LOG_WARNING, "1.")
+      subject.error "Self destruction in 3...\n2..\n1."
+      subject.flush
+    end
+  end
+
+  # TODO: test logger level
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'buffered_syslogger'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: buffered_syslogger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- !binary |
+  TMOhc3psw7MgQsOhY3Np
+
+- Cyril Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+description: |
+  A drop-in replacement for the Rails 3 default BufferedLogger library,
+  that logs to syslog instead of a log file. Builds on the syslogger gem.
+
+email: lackac@secretsaucepartners.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/buffered_syslogger.rb
+- spec/buffered_syslogger_spec.rb
+- spec/spec_helper.rb
+- README.rdoc
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/sspinc/buffered_syslogger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Buffered syslogger based on the syslogger gem.
+test_files: []
+