sensu-plugins-logs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca00d7419177ed84a34e3bd7b9d302e108bb126
-  data.tar.gz: 920733496f7eed50cba97b593df62f39c4eaf0da
+  metadata.gz: 929c81f862960a2e581bf3e46e6bb2128612ff7d
+  data.tar.gz: defbc634359dbba7c00af2b90d2b61c44c67ef1d
 SHA512:
-  metadata.gz: 377795148728c7bd23665e28a0f0b090f3b1ae0d6dba29c73421762dcf539f5dba34d53d60872c2f029c7d5fcc3c3e2a225c893800a03f7d5fa4b953c192254f
-  data.tar.gz: a493f106877b0a25dcc0e9b0e4c430a1f528174667b1071a10c5c7d452297ac14a9c3b41b6660709ec805f022279950ec5a03c0277f7735f032c4a65c4fffe8d
+  metadata.gz: d805b4d8b93e77d0f3f065eb6d781e0d749c3691b3ddc416a42388c28d8ad143fd267d7dd02a44e99071f2090cd8f3258785111d28965220b746a8f1f14ed8a2
+  data.tar.gz: 1c884973770d313379614cbc0a4374e65d2ba899b9117953f0300d4f271a1782b539e6f75b6f1658a987420b4276525e97303528c6d02844f52e95e56baac7e0

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
+## [1.1.0] - 2017-05-20
+### Added
+- Add `return-length` option to support custom length for returned matched lines
+- Add `log-pattern` option to support read and match against whole log entry instead of single line
 
 ## [1.0.0] - 2017-03-07
 ### Fixed
@@ -36,7 +40,9 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.0.0...1.1.0
+[0.0.4]:
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/0.0.4...1.0.0
 [0.0.4]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/0.0.3...0.0.4
 [0.0.3]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/0.0.2...0.0.3

data/bin/check-log.rb

@@ -57,6 +57,21 @@ class CheckLog < Sensu::Plugin::Check::CLI
          short: '-q PAT',
          long: '--pattern PAT'
 
+  # this check currently makes no attempt to try to save you from
+  # a bad regex such as being unbound. Regexes ending in anything like:
+  # `.*`, `.+`, `[0-9-A-Z-a-z]+`, etc. Having regex without a real
+  # boundry could force the entire log file into memory at once rather
+  # line by line and could have signifigant performance impact. Please
+  # if you are going to use this please make sure you have log rotation
+  # set up and test your regex to make sure that it will catch what
+  # you want. I would reccomend placing several log examples into
+  # something like http://regexr.com/ and ensure that your regex properly
+  # catches the boundries. You have been warned.
+  option :log_pattern,
+         description: 'The log format of each log entry',
+         short: '-l PAT',
+         long: '--log-pattern PAT'
+
   option :exclude,
          description: 'Pattern to exclude from matching',
          short: '-E PAT',
@@ -106,6 +121,13 @@ class CheckLog < Sensu::Plugin::Check::CLI
          boolean: true,
          default: false
 
+  option :return_content_length,
+         description: 'Matched line length',
+         short: '-L N',
+         long: '--return-length N',
+         proc: proc(&:to_i),
+         default: 250
+
   def run
     unknown 'No log file specified' unless config[:log_file] || config[:file_pattern]
     unknown 'No pattern specified' unless config[:pattern]
@@ -180,6 +202,10 @@ class CheckLog < Sensu::Plugin::Check::CLI
     @log.seek(@bytes_to_skip, File::SEEK_SET) if @bytes_to_skip > 0
     # #YELLOW
     @log.each_line do |line|
+      if config[:log_pattern]
+        line = get_log_entry(line)
+      end
+
       line = line.encode('UTF-8', invalid: :replace, replace: '')
       bytes_read += line.bytesize
       if config[:case_insensitive]
@@ -188,7 +214,7 @@ class CheckLog < Sensu::Plugin::Check::CLI
         m = line.match(config[:pattern]) unless line.match(config[:exclude])
       end
       if m
-        accumulative_error += "\n" + line.slice(0, 250)
+        accumulative_error += "\n" + line.slice(0..config[:return_content_length])
         if m[1]
           if config[:crit] && m[1].to_i > config[:crit]
             n_crits += 1
@@ -210,4 +236,20 @@ class CheckLog < Sensu::Plugin::Check::CLI
     end
     [n_warns, n_crits, accumulative_error]
   end
+
+  def get_log_entry(first_line)
+    log_entry = [first_line]
+
+    @log.each_line do |line|
+      if !line.match(config[:log_pattern])
+        log_entry.push(line)
+      else
+        @log.pos = @log.pos - line.bytesize if line
+        break
+      end
+    end
+
+    log_entry = log_entry.join('')
+    log_entry
+  end
 end

data/lib/sensu-plugins-logs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-logs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin