sensu-plugins-log-pattern 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80637aee656f586af0f648d4a088b5a084ea9e16
+  data.tar.gz: 309df90ec8a6ec62e59ef58c7b2e22cffdc67a75
+SHA512:
+  metadata.gz: 93579e0ff5da9895016760109ce54e91439a0d35f173173bc5839b2969eb9b3ad60846da93adfcfba07e5d9a4fd1701d0fcdc756f9a1ac687795c23977c9ebb6
+  data.tar.gz: 1682205c02cc12616c0c71746dbe13d42a500083b2f18ec6c5f8e94f2042caafd6a2a6d011939b70f52a9c23015fbabafe7e6f2403dc25335f944859d5f30f7b

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased
+
+## [0.0.1] - 2016-01-06
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+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,26 @@
+# Sensu plugin for monitoring patterns in log files
+
+A sensu plugin to monitor patterns in log files.
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-log-pattern.rb (options)
+    -c, --crit <COUNT>               Critical if number of matches exceeds COUNT
+    -f, --file <PATH>                Comma separated list of files (including globs) where pattern will be searched
+        --ignore-case                Ignore case sensitive
+    -i, --ignore-pattern <PATTERN>   Comma separated list of patterns to ignore
+    -p, --pattern <PATTERN>          Comma separated list of patterns to search for (required)
+        --print-matches              Print log lines that match patterns
+    -s, --source <file>              Defines the log source (default: file) (required)
+        --state-dir <PATH> (default: /var/cache/check-log-pattern)
+                                     State directory
+    -w, --warn <COUNT>               Warning if number of matches exceeds COUNT (default: 1)
+```
+
+Currently, only file is supported as source. Systemd journald support will be added in future releases.
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-log-pattern.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/env ruby
+#
+# check-log-pattern.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'fileutils'
+require 'digest/md5'
+
+class CheckLogPattern < Sensu::Plugin::Check::CLI
+  option :source,
+         :description => "Defines the log source (default: file)",
+         :short => "-s <file>",
+         :long => "--source <file>",
+         :in => ["file"],
+         :default => "file",
+         :required => true
+
+  option :file,
+         :description => "Comma separated list of files (including globs) where pattern will be searched",
+         :short => "-f <PATH>",
+         :long => "--file <PATH>",
+         :proc => proc { |s| s.split(',') },
+         :default => []
+
+  option :pattern,
+         :description => "Comma separated list of patterns to search for",
+         :short => "-p <PATTERN>",
+         :long => "--pattern <PATTERN>",
+         :proc => proc { |s| s.split(',') },
+         :required => true
+
+  option :ignore_pattern,
+         :description => "Comma separated list of patterns to ignore",
+         :short => "-i <PATTERN>",
+         :long => "--ignore-pattern <PATTERN>",
+         :proc => proc { |s| s.split(',') },
+         :default => []
+
+  option :state_dir,
+         :description => "State directory",
+         :long => "--state-dir <PATH> (default: /var/cache/check-log-pattern)",
+         :default => "/var/cache/check-log-pattern"
+
+  option :ignore_case,
+         :description => "Ignore case sensitive",
+         :long => "--ignore-case",
+         :boolean => true,
+         :default => false
+
+  option :print_matches,
+         :description => "Print log lines that match patterns",
+         :long => "--print-matches",
+         :boolean => true,
+         :default => false
+
+  option :warn,
+         :description => "Warning if number of matches exceeds COUNT (default: 1)",
+         :short => "-w <COUNT>",
+         :long => "--warn <COUNT>",
+         :default => 1
+
+  option :crit,
+         :description => "Critical if number of matches exceeds COUNT",
+         :short => "-c <COUNT>",
+         :long => "--crit <COUNT>",
+         :default => nil
+
+  def initialize()
+    super
+
+    @files = []
+
+    case config[:source]
+      when "file"
+        raise "Must specify one or more files with the --file command line option when source is file" unless config[:file].size > 0
+
+        # determine list of files
+        config[:file].each do |file|
+          @files += Dir.glob(file)
+        end
+    end
+
+    raise "Warning threshold must be lower than the critical threshold" if (config[:crit] != nil and config[:warn] > config[:crit])
+
+    # prepare state directory
+    FileUtils.mkdir_p(config[:state_dir]) unless File.directory?(config[:state_dir])
+  end
+
+  def run
+    case config[:source]
+      when "file"
+        problems = 0
+        matches = {}
+
+        @files.each do |file|
+          hash = Digest::MD5.hexdigest("#{file}_#{config[:pattern]}")
+          cursor_file = config[:state_dir] + "/" + hash + ".last_cursor"
+
+          if File.exists?(cursor_file)
+            last_cursor = File.read(cursor_file).chomp.to_i
+          else
+            last_cursor = 0
+          end
+
+          fd = File.open(file)
+          fd.seek(last_cursor, File::SEEK_SET) if last_cursor > 0
+          bread = 0
+          fd.each_line do |line|
+            bread += line.bytesize
+
+            str = config[:ignore_case] ? line.downcase : line
+
+            config[:ignore_pattern].each do |pattern|
+              next if match = str.match(pattern)
+            end
+
+            config[:pattern].each do |pattern|
+              if match = str.match(pattern)
+                matches[pattern] ||= {}
+                matches[pattern][file] ||= []
+                matches[pattern][file] << line
+                problems += 1
+              end
+            end
+          end
+
+          # update cursor file
+          File.open(cursor_file, 'w') { |f| f.write(last_cursor + bread) }
+        end
+
+        msg = []
+        bottom = []
+
+        matches.each do |pattern, files|
+          files.each do |file, lines|
+            msg << "#{lines.size} lines matching '#{pattern}' in #{file}"
+
+            if config[:print_matches]
+              bottom << "  Lines matching '#{pattern}' in #{file}:"
+              lines.each do |line|
+                bottom << "    * #{line.chomp}"
+              end
+              bottom << ""
+            end
+          end
+        end
+
+        msg << "\n\n" if config[:print_matches]
+
+        if config[:crit]
+          critical("Found " + msg.join(', ') + bottom.join("\n")) if problems > config[:crit]
+        end
+        warning("Found " + msg.join(', ') + bottom.join("\n")) if problems > config[:warn]
+        ok("Found no lines matching '#{config[:pattern].join(', ')}'")
+    end
+  end
+end

data/lib/sensu-plugins-log-pattern.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-log-pattern/version'

data/lib/sensu-plugins-log-pattern/version.rb

@@ -0,0 +1,9 @@
+module SensuPluginsLogPattern
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-log-pattern
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: This plugin provides facilities for monitoring patterns in log files
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-log-pattern.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-log-pattern.rb
+- lib/sensu-plugins-log-pattern.rb
+- lib/sensu-plugins-log-pattern/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-log-pattern
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring patterns in log files
+test_files: []