log2mail 0.0.1.pre2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49c942792863111482748c2728b262aac98222c7
+  data.tar.gz: b6dbfb965e80cc032ad80cf2e9c208be7847ad1c
+SHA512:
+  metadata.gz: 06740c4944bfe2cd8f6f4d0ecfa01321c84ce99d2efc1c308b0055bf6f8dfa7ec0d0e495a7ca546106fdacfd501d28233b34376a226d1ca1be3f534c5eae134a
+  data.tar.gz: 27bf8b30600f937341290214b5f60dd8610b47a8ec9ac2240e1531aa33df68d55d518819f5504e99b9dfca1e4103ea646fdf1d17ad0f67457e72cbfcd37720d4

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/example/
+*.gem
+*.log
+/man/*.html
+/bin/rake

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1"
+  - "2.2"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log2mail.gemspec
+gemspec

data/INSTALL

@@ -0,0 +1,51 @@
+log2mail.rb Installation
+========================
+
+Requirements
+------------
+
+* Ruby 1.9.3
+
+Debian 7 (and higher)
+---------------------
+
+To install Ruby:
+
+    sudo apt-get install ruby
+
+To get this pre-release version of log2mail.rb:
+
+    rbenv shell system  # if using rbenv
+    sudo gem install log2mail --pre
+
+Next Steps
+----------
+
+Create a configuration file, e.g. at `/usr/local/etc/log2mail.conf`:
+
+    cat > /usr/local/etc/log2mail.conf <<EOF
+    defaults
+      mailto = your@mail.address
+    file = /tmp/test.log
+      pattern = test
+    EOF
+
+Test the configuration:
+
+    log2mail.rb configtest --config /usr/local/etc/log2mail.conf
+
+should return:
+
+    +---------------+---------+-------------------+----------+
+    | File          | Pattern | Recipient         | Settings |
+    +---------------+---------+-------------------+----------+
+    | /tmp/test.log | test    | your@mail.address |          |
+    +---------------+---------+-------------------+----------+
+
+Run *log2mail.rb* in foreground (`-N`) in verbose mode (`-v`) and 10 seconds sleep time in the processing loop:
+
+    log2mail.rb start --config /usr/local/etc/log2mail.conf -Nv --sleeptime 10
+
+`echo "a first test" >> /tmp/test.log` should result in an email report after few seconds.
+
+See `gem man log2mail` for more information.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Markus Strauss
+
+MIT License
+
+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.md

@@ -0,0 +1,123 @@
+log2mail.rb(1) -- monitors (log) files for patterns and reports hits by mail
+============================================================================
+
+## SYNOPSIS
+
+`log2mail.rb` (start|stop|status|configtest) [<var>options</var>]:
+
+## DESCRIPTION
+
+`log2mail.rb` helps having an eye on your systems' log files.  It efficiently monitors multiple files and reports as soon as specified (regular expression) patterns match.
+
+On startup, `log2mail.rb` opens all files on the 'watch list' and seeks to EOF.  All new data are parsed about once a minute (see `--sleeptime`). <!-- If necessary, i.e. when multiline patterns are set for the file, every new data is put into a fixed-size buffer.  The buffer is rolled over when it gets full. --> Matched patterns are reported to the configured mail address(es) (see `mailto` configuration option).
+
+Log files are reopened automatically when rotated.
+
+`log2mail.rb` is a pure ruby clone of [log2mail](https://packages.debian.org/squeeze/log2mail) which supports most of the original's features and configuration syntax and adds multiline regular expression matching.  Actually it should be possible to use `log2mail.rb` with your existing configuration you may have for log2mail(8).
+
+## OPTIONS
+
+  * `--config`=<var>path</var>, `-c` <var>path</var>:
+    Specifies the configuration file or directory path.  If <var>path</var> is a directory, all files (except such ending in `~` or `#`) are parsed in sorted order. Sorting is by character code, i.e. 0-9 before A-Z followed by a-z.
+    Default value: `/etc/log2mail/conf`.
+    This can also be set by environment variable `LOG2MAIL_CONF`.
+
+  * `--sleeptime`=<var>seconds</var>:
+    Specifies at which interval (in seconds) the log files are parsed.  Default value: 60.
+
+## ENVIRONMENT
+
+`log2mail.rb` uses the environment variable `LOG2MAIL_CONF`, if present (see option `--config`).  The value supplied by option takes precedence.
+
+## CONFIGURATION (OLD-STYLE)
+
+The old-style configuration syntax is directly cloned from log2mail(8)'s behavior and should be mostly compatible.  It may seem a bit awkward first, but this is how it works:  There are two possible top-level 'sections', `defaults` and `file=`<var>path-to-log-file</var> sections. The only statement allowed after a `file=...` section are one or more `pattern=`<var>pattern</var> entries.  After the `pattern=...` there may be one or more `mailto=`<var>single-mail-recipient</var> entries.  After each `mailto=...` there may be options for that recipient.  Also, these options are set from the special `defaults` section, if present (usually it is).
+
+The basic layout looks like follows:
+
+    # comments start with pound sign (aka hash or number sign)
+
+    defaults
+      fromaddr   = DEFAULT FROMADDR
+      sendtime   = DEFAULT SENDTIME   # seconds
+      resendtime = DEFAULT RESENDTIME # seconds
+      maxlines   = DEFAULT MAXLINES   # number of lines
+      template   = DEFAULT TEMPLATE   # filename or path
+      sendmail   = DEFAULT SENDMAIL   # path to executable with arguments
+      mailto     = DEFAULT RECIPIENT  # new to log2mail.rb
+      # awkward, not recommended, but possible:
+      pattern    = DEFAULT PATTERN    # this pattern would be applied to every file
+      mailto     = DEFAULT RECIPIENT for previous DEFAULT PATTERN
+
+    # one or more file sections follow
+    file = FILENAME
+
+      # each file can have one or more patterns
+      pattern = PATTERN
+
+        # each pattern can have one or more mailto recipients
+        # each recipient gets its own mailto=... statement
+        mailto = MAIL
+
+          # every option NOT stated here is supplied from defaults
+          fromaddr   = ...
+          sendtime   = ...
+          resendtime = ...
+          maxlines   = ...
+          template   = ...
+          sendmail   = ...
+
+    # "include" includes the contents of file at the exact place of the
+    # include statement
+    include = PATH TO FILE
+
+Note that indentation is done for readability purposes only.  It serves no role syntactically.
+
+Splitting the configuration into multiple files is possible, and convenient when using automation tools to distribute settings.  In opposition to classic log2mail, with `log2mail.rb` it does not matter at which place the `defaults` section is parsed.  Keep in mind though, that later definitions may override earlier ones. In that case a warning is logged.
+
+## CONFIGURATION (NEW-STYLE)
+
+None (yet).  More features might warrant a new configuration syntax.
+
+## SECURITY CONSIDERATIONS
+
+It is neither necessary nor recommended to run this software as root.
+
+## BUGS
+
+Configuration options `sendtime`, `resendtime`, `maxlines` not implemented yet.  Every match produces a single mail which is sent out immediately - which could produce a lot of mails.
+
+## HISTORY
+
+December 2014:
+This software is not feature-complete and in pre-release testing.
+
+## AUTHOR
+
+Markus Strauss <<log2mail@dev.sieb.mx>>
+
+## THANKS
+
+Many thanks to Michael Krax for writing the classic **log2mail** in the first place.
+
+## SEE ALSO
+
+Documentation for the classic log2mail software by Michael Krax:
+
+  * log2mail(8), log2mail.conf(5)
+  * [Configuration notice from the Debian project]( https://raw.githubusercontent.com/lordlamer/log2mail/e6beb36644ce74639cbc453e664a08ed15f138b9/Configuration)
+
+
+[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
+[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
+[OPTIONS]: #OPTIONS "OPTIONS"
+[ENVIRONMENT]: #ENVIRONMENT "ENVIRONMENT"
+[SECURITY CONSIDERATIONS]: #SECURITY-CONSIDERATIONS "SECURITY CONSIDERATIONS"
+[BUGS]: #BUGS "BUGS"
+[HISTORY]: #HISTORY "HISTORY"
+[AUTHOR]: #AUTHOR "AUTHOR"
+[THANKS]: #THANKS "THANKS"
+[SEE ALSO]: #SEE-ALSO "SEE ALSO"
+
+
+[log2mail.rb(1)]: log2mail.1.html

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+require 'rake/notes/rake_task'
+
+task :default => [:spec, :features, :man]
+
+desc 'Build the manual'
+task :man do
+  require 'ronn'
+  sh "ronn -w -s toc -r5 --markdown man/*.ronn"
+  FileUtils.mv("man/log2mail.1.markdown", "README.md")
+end

data/bin/log2mail.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'log2mail'
+require 'log2mail/main'

data/features/configtest-mode.feature

@@ -0,0 +1,22 @@
+Feature: Configuration Examination
+  In order verify correct configuration
+  As a respnosible system administrator
+  I want to see a configuration summary
+
+  Scenario: Show configuration settings
+    Given I use mode "configtest"
+    And config "config_1"
+    When log2mail is run
+    Then the output should be:
+      | File     | Pattern          | Recipient                   | Settings |
+      | test.log | string pattern   | recipient@test.itstrauss.eu |          |
+      | test.log | /regexp pattern/ | recipient@test.itstrauss.eu |          |
+  Scenario: Show effective configuration settings
+    Given I use mode "configtest"
+    And config "config_1"
+    And parameter "-e"
+    When log2mail is run
+    Then the output should be:
+      | File     | Pattern          | Recipient                   | Effective Settings |
+      | test.log | string pattern   | recipient@test.itstrauss.eu | fromaddr=log2mail  |
+      | test.log | /regexp pattern/ | recipient@test.itstrauss.eu | fromaddr=log2mail  |

data/features/log2mail_configurations/config_1

@@ -0,0 +1,7 @@
+# old-style syntax
+defaults
+  mailto   = recipient@test.itstrauss.eu
+  fromaddr = log2mail
+file = test.log
+  pattern = string pattern
+  pattern = /regexp pattern/

data/features/step_definitions/log2mail_steps.rb

@@ -0,0 +1,41 @@
+def parse_configtest_output( txt )
+  rows = []; keys = nil
+  first_line = true
+  txt.each_line do |line|
+    next if line =~ /[+-]+/
+    if first_line
+      keys = line.split('|').map(&:strip) - ['|', '']
+      first_line = false
+    else
+      values = line.split('|').map(&:strip) - ['|', '']
+      rows << Hash[keys.zip(values)]
+    end
+  end
+  rows
+end
+
+Given(/^I use mode "(.*?)"$/) do |mode|
+  @mode = mode
+end
+
+Given(/^config "(.*?)"$/) do |config|
+  @config = config
+end
+
+Given(/^parameter "(.*?)"$/) do |args|
+  @args = args
+end
+
+When(/^log(\d+)mail is run$/) do |arg1|
+  @output = `bundle exec bin/log2mail.rb #{@mode} --config features/log2mail_configurations/#{@config} #{@args}`
+  # puts @output.inspect
+  # puts parse_configtest_output(@output).inspect
+end
+
+Then(/^the output should be:$/) do |table|
+  # table is a Cucumber::Ast::Table
+  table.map_headers!
+  table.map_column!(:Settings) { |cell| cell.empty? ? nil : cell } \
+    if table.hashes.first[:Settings]
+  table.diff! parse_configtest_output(@output), :surplus_col => true
+end

data/lib/ext/kernel.rb

@@ -0,0 +1,13 @@
+unless Kernel.respond_to?(:Hash)
+  module Kernel
+    def Hash(arg)
+      if arg.respond_to?(:to_hash)
+        return arg.to_hash
+      elsif arg.nil?
+        return {}
+      else
+        fail TypeError, "TypeError: can't convert #{arg.class} into Hash"
+      end
+    end
+  end
+end

data/lib/ext/main.rb

@@ -0,0 +1,24 @@
+module Main
+  class Program
+    module InstanceMethods
+
+      def logger= log
+        unless(defined?(@logger) and @logger == log)
+          case log
+            when ::Logger, Logger, Syslog::Logger
+              @logger = log
+            else
+              if log.is_a?(Array)
+                @logger = Logger.new(*log)
+              else
+                @logger = Logger.new(log)
+                @logger.level = logger_level
+              end
+          end
+        end
+        @logger
+      end
+
+    end
+  end
+end

data/lib/ext/string.rb

@@ -0,0 +1,23 @@
+class String
+  # based on https://www.ruby-forum.com/topic/193809#844629
+  def to_r
+    if self.strip.match(/\A\/(.*)\/(.*)\Z/mx)
+      regexp, flags = $1, $2
+      fail "Not a valid regular expression. Valid flags in (/regexp/flags) are x, i and m" \
+        if !regexp || flags =~ /[^xim]/m
+
+      x = /x/.match(flags) && Regexp::EXTENDED
+      i = /i/.match(flags) && Regexp::IGNORECASE
+      m = /m/.match(flags) && Regexp::MULTILINE
+
+      rxp = Regexp.new regexp , [x,i,m].inject(0){|a,f| f ? a+f : a }
+      def rxp.from_string?; false end
+      rxp
+    else
+      # build regexp from regular string
+      rxp = Regexp.new( self )
+      def rxp.from_string?; true end
+      rxp
+    end
+  end
+end

data/lib/ext/syslog_logger.rb

@@ -0,0 +1,208 @@
+require 'syslog'
+require 'logger'
+
+##
+# Syslog::Logger is a Logger work-alike that logs via syslog instead of to a
+# file.  You can use Syslog::Logger to aggregate logs between multiple
+# machines.
+#
+# By default, Syslog::Logger uses the program name 'ruby', but this can be
+# changed via the first argument to Syslog::Logger.new.
+#
+# NOTE! You can only set the Syslog::Logger program name when you initialize
+# Syslog::Logger for the first time.  This is a limitation of the way
+# Syslog::Logger uses syslog (and in some ways, a limitation of the way
+# syslog(3) works).  Attempts to change Syslog::Logger's program name after
+# the first initialization will be ignored.
+#
+# === Example
+#
+# The following will log to syslogd on your local machine:
+#
+#   require 'syslog/logger'
+#
+#   log = Syslog::Logger.new 'my_program'
+#   log.info 'this line will be logged via syslog(3)'
+#
+# Also the facility may be set to specify the facility level which will be used:
+#
+#   log.info 'this line will be logged using Syslog default facility level'
+#
+#   log_local1 = Syslog::Logger.new 'my_program', Syslog::LOG_LOCAL1
+#   log_local1.info 'this line will be logged using local1 facility level'
+#
+#
+# You may need to perform some syslog.conf setup first.  For a BSD machine add
+# the following lines to /etc/syslog.conf:
+#
+#  !my_program
+#  *.*                                             /var/log/my_program.log
+#
+# Then touch /var/log/my_program.log and signal syslogd with a HUP
+# (killall -HUP syslogd, on FreeBSD).
+#
+# If you wish to have logs automatically roll over and archive, see the
+# newsyslog.conf(5) and newsyslog(8) man pages.
+
+class Syslog::Logger
+  # Default formatter for log messages.
+  class Formatter
+    def call severity, time, progname, msg
+      clean msg
+    end
+
+    private
+
+    ##
+    # Clean up messages so they're nice and pretty.
+
+    def clean message
+      message = message.to_s.strip
+      message.gsub!(/\e\[[0-9;]*m/, '') # remove useless ansi color codes
+      return message
+    end
+  end
+
+  ##
+  # The version of Syslog::Logger you are using.
+
+  VERSION = '2.1.0'
+
+  ##
+  # Maps Logger warning types to syslog(3) warning types.
+  #
+  # Messages from Ruby applications are not considered as critical as messages
+  # from other system daemons using syslog(3), so most messages are reduced by
+  # one level.  For example, a fatal message for Ruby's Logger is considered
+  # an error for syslog(3).
+
+  LEVEL_MAP = {
+    ::Logger::UNKNOWN => Syslog::LOG_ALERT,
+    ::Logger::FATAL   => Syslog::LOG_ERR,
+    ::Logger::ERROR   => Syslog::LOG_WARNING,
+    ::Logger::WARN    => Syslog::LOG_NOTICE,
+    ::Logger::INFO    => Syslog::LOG_INFO,
+    ::Logger::DEBUG   => Syslog::LOG_DEBUG,
+  }
+
+  ##
+  # Returns the internal Syslog object that is initialized when the
+  # first instance is created.
+
+  def self.syslog
+    @@syslog
+  end
+
+  ##
+  # Specifies the internal Syslog object to be used.
+
+  def self.syslog= syslog
+    @@syslog = syslog
+  end
+
+  ##
+  # Builds a methods for level +meth+.
+
+  def self.make_methods meth
+    level = ::Logger.const_get(meth.upcase)
+    eval <<-EOM, nil, __FILE__, __LINE__ + 1
+      def #{meth}(message = nil, &block)
+        add(#{level}, message, &block)
+      end
+
+      def #{meth}?
+        @level <= #{level}
+      end
+    EOM
+  end
+
+  ##
+  # :method: unknown
+  #
+  # Logs a +message+ at the unknown (syslog alert) log level, or logs the
+  # message returned from the block.
+
+  ##
+  # :method: fatal
+  #
+  # Logs a +message+ at the fatal (syslog err) log level, or logs the message
+  # returned from the block.
+
+  ##
+  # :method: error
+  #
+  # Logs a +message+ at the error (syslog warning) log level, or logs the
+  # message returned from the block.
+
+  ##
+  # :method: warn
+  #
+  # Logs a +message+ at the warn (syslog notice) log level, or logs the
+  # message returned from the block.
+
+  ##
+  # :method: info
+  #
+  # Logs a +message+ at the info (syslog info) log level, or logs the message
+  # returned from the block.
+
+  ##
+  # :method: debug
+  #
+  # Logs a +message+ at the debug (syslog debug) log level, or logs the
+  # message returned from the block.
+
+  Logger::Severity::constants.each do |severity|
+    make_methods severity.downcase
+  end
+
+  ##
+  # Log level for Logger compatibility.
+
+  attr_accessor :level
+
+  # Logging formatter, as a +Proc+ that will take four arguments and
+  # return the formatted message. The arguments are:
+  #
+  # +severity+:: The Severity of the log message.
+  # +time+:: A Time instance representing when the message was logged.
+  # +progname+:: The #progname configured, or passed to the logger method.
+  # +msg+:: The _Object_ the user passed to the log message; not necessarily a
+  #         String.
+  #
+  # The block should return an Object that can be written to the logging
+  # device via +write+.  The default formatter is used when no formatter is
+  # set.
+  attr_accessor :formatter
+
+  ##
+  # The facility argument is used to specify what type of program is logging the message.
+
+  attr_accessor :facility
+
+  ##
+  # Fills in variables for Logger compatibility.  If this is the first
+  # instance of Syslog::Logger, +program_name+ may be set to change the logged
+  # program name. The +facility+ may be set to specify the facility level which will be used.
+  #
+  # Due to the way syslog works, only one program name may be chosen.
+
+  def initialize program_name = 'ruby', facility = nil
+    @level = ::Logger::DEBUG
+    @formatter = Formatter.new
+
+    @@syslog ||= Syslog.open(program_name)
+
+    @facility = (facility || @@syslog.facility)
+  end
+
+  ##
+  # Almost duplicates Logger#add.  +progname+ is ignored.
+
+  def add severity, message = nil, progname = nil, &block
+    severity ||= ::Logger::UNKNOWN
+    @level <= severity and
+      @@syslog.log( (LEVEL_MAP[severity] | @facility), '%s', formatter.call(severity, Time.now, progname, (message || block.call)) )
+    true
+  end
+end