sensu-plugins-logs 1.3.2 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d478deec3743ad1bc2aa766e7816b5db24bed2f21d6567f016b165e719a18b5
-  data.tar.gz: 7879c34388521e7ffc9822e6c47b76d8942bc106fd8ca865ef9724b75cf797a4
+  metadata.gz: 67528ab6e99c7b5ef3ee2c5d4aa5cc9089a26703fc2467999fb214abee536040
+  data.tar.gz: 5fc68d6402cf8217bb1375bc5bf13d02b2f7a240442bb7835ae0095ce3b6709d
 SHA512:
-  metadata.gz: a3473450a2d537d66c5d77b15330fd31766ec8081836b3a1cf567be480d835ac38ea67ff3d85f028305ba4180277827235362397e684ab6aba0bba3c1ab39275
-  data.tar.gz: 7009638ab2bb71a5690c6959ea6d22ea4e22d4df02e9ffe591c2c00c778507fe5b91d212d4a87c132c377a3670bd1ab930dc3b34c86439618f0a87c9bf13d63c
+  metadata.gz: 69cb00dcb54dabfc3c3a2c6a6ee807c635d5822386575571552b5e022f48373475882a7e73a6e43fff187e4e01075811d8c208fdcfbd2e1f984f95237543dbad
+  data.tar.gz: 7e7d022acd84d97700bc81d3cfe5523f572801415ca807d5f4e44ade2e66aa5fbd0abd46ed24bb95c35f1bfaaf5394f2a49e8fc037107c2a852c831d66e5766b

data/CHANGELOG.md

@@ -4,9 +4,61 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
+
+## [4.1.1] - 2020-11-13
+### Fixed
+- centos8 asset target
+
+## [4.1.0] - 2020-07-02
+### Changed
+- Updated rubocop development dependency to '~= 0.81.0'
+- Updated rake development dependency to '~= 13.0'
+
+### Added
+- Updated asset build targets to support centos6
+- Removed centos from bonsai asset definition
+
+### Fixed
+- debian asset target
+
+## [4.0.0] - 2019-05-07
+### Breaking Changes
+- Bump `sensu-plugin` dependency from `~> 3.0` to `~> 4.0` you can read the changelog entries for [4.0](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#400---2018-02-17), [3.0](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#300---2018-12-04), and [2.0](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#v200---2017-03-29)
+
+### Added
+- Travis build automation to generate Sensu Asset tarballs that can be used n conjunction with Sensu provided ruby runtime assets and the Bonsai Asset Index
+- Require latest sensu-plugin for [Sensu Go support](https://github.com/sensu-plugins/sensu-plugin#sensu-go-enablement)
+
+
+## [3.0.0] - 2018-12-15
+### Breaking Changes
+- updated to use sensu-plugin 3.0 with Sensu Go to Sensu Core 1.x migration option
+
+### Changes
+- Update handler-logevent.rb to gracefully handle missing check and client definitions in events.  Missing attributes will use 'unknown' fallback strings so that malformed events will still be captured in the event logging directory structure instead of erroring out.  Useful for diagnosing problems with malformed events when migrating to Sensu Go. (@jspaleta)
+
+### Added
+- add ruby 2.5.1 into travis automation (@jspaleta)
+
+### Fixed
+- add rdoc to development dependancy to fix rake task errors ruby 2.5.1 (@jspaleta) (@dependabot)
+- update dev dep for github-markup (@jspaleta) (@dependabot)
+- update dev dep for codeclimate-test-reporter (@jspaleta) (@dependabot)
+- update dev dep for serverspec (@jspaleta) (@dependabot)
+- update dev dep for mixlib-shellout (@jspaleta) (@dependabot)
+- update dev dep for rubocop (@jspaleta) (@dependabot)
+
+## [2.0.0] - 2018-09-30
+### Breaking Changes
+- remove support for ruby versions `< 2.3.0` (@jspaleta)
+
+### Added
+- updated to use sensu-plugin 2.7 with 2.x to 1.x migration option (@jspaleta)
+
+
 ### Fixed
-- check-log.rb: pattern is now required via option config
-- check-log.rb: update descriptions of crit and warn options
+- check-log.rb: pattern is now required via option config (@cgeers)
+- check-log.rb: update descriptions of crit and warn options (@cgeers)
 
 ## [1.3.1] - 2017-10-09
 ### Fixed
@@ -75,7 +127,12 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.3.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/4.0.0...4.1.0
+[4.0.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/3.0.0...4.0.0
+[3.0.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/2.0.0...3.0.0
+[3.0.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/2.0.0...3.0.0
+[2.0.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.3.1...2.0.0
 [1.3.1]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.3.0...1.3.1
 [1.3.0]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.2.1...1.3.0
 [1.2.1]: https://github.com/sensu-plugins/sensu-plugins-logs/compare/1.2.0...1.2.1

data/README.md

@@ -1,20 +1,114 @@
-## Sensu-Plugins-logs
-
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-logs)
 [ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-logs.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-logs)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-logs.svg)](http://badge.fury.io/rb/sensu-plugins-logs)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-logs/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-logs)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-logs/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-logs)
 [![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-logs.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-logs)
 
-## Functionality
+## Sensu Plugins Logs Plugin
+
+- [Overview](#overview)
+- [Files](#files)
+- [Usage examples](#usage-examples)
+- [Configuration](#configuration)
+  - [Sensu Go](#sensu-go)
+    - [Asset registration](#asset-registration)
+    - [Asset definition](#asset-definition)
+    - [Check definition](#check-definition)
+  - [Sensu Core](#sensu-core)
+    - [Check definition](#check-definition)
+- [Installation from source](#installation-from-source)
+- [Additional notes](#additional-notes)
+- [Contributing](#contributing)
+
+### Overview
 
-## Files
+This plugin provides native instrumentation for monitoring log files or system logs via journald for regular expressions and a Sensu handler for logging Sensu events to log files.
+
+### Files
  * bin/check-journal.rb
  * bin/check-log.rb
  * bin/handler-logevent.rb
  * bin/handler-show-event-config.rb
+ 
+**check-journal**
+Checks the systemd journal (`journald`) for a pattern.
 
-## Usage
+**check-log**
+Checks a log file for a regular expression, skipping lines that have already been read. Stores the number of bytes read and seeks to that position next time (instead of making a backup copy of the whole log file). 
+
+**handler-logevent**
+Logs last `settings['logevent']['keep']` JSON events in files as `settings['logevent']['eventdir']/client/check_name/timestamp.action`.
+
+**handler-show-event-config**
+Lists the handler's config and the event it read.
+
+## Usage examples
+
+### Help
+
+**check-journal.rb**
+```
+Usage: check-journal.rb (options)
+    -c, --critical COUNT             Number of matches to consider a critical issue.
+    -j "ARGS1 ARGS2 ...",            Pass additional arguments to journalctl, eg: "-u nginx.service"
+        --journalctl_args
+    -q, --pattern PAT                Pattern to search for
+    -s, --since TIMESPEC             Query journal entries on or newer than the specified date/time.
+    -v                               Verbose output. Helpful for debugging the plugin.
+    -w, --warning COUNT              Number of matches to consider a warning    
+```
+
+**handler-logevent.rb**
+```
+Usage: handler-logevent.rb (options)
+        --map-go-event-into-ruby     Enable Sensu Go to Sensu Ruby event mapping. Alternatively set envvar SENSU_MAP_GO_EVENT_INTO_RUBY=1.
+
+```
+
+## Configuration
+### Sensu Go
+#### Asset registration
+
+Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 or later, you can use the following command to add the asset: 
+
+`sensuctl asset add sensu-plugins/sensu-plugins-logs`
+
+If you're using an earlier version of sensuctl, you can download the asset definition from [this project's Bonsai asset index page](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-logs).
+
+#### Asset definition
+
+```yaml
+---
+type: Asset
+api_version: core/v2
+metadata:
+  name: sensu-plugins-logs
+spec:
+  url: https://assets.bonsai.sensu.io/9ba6c6b27b5ca36538de3a13f014718ead3a1215/sensu-plugins-logs_4.0.0_centos_linux_amd64.tar.gz
+  sha512: 4e29c549924b5df01c7a8e0ed105659b3e9e81ca5c919548efd03a2ccaaf83d8605130ab80132e93db6f5e25c7acddbd7f6e8c6d185567eb5f73cd420dcc2f06
+```
+
+#### Check definition
+
+```yaml
+---
+type: CheckConfig
+spec:
+  command: "check-journal.rb"
+  handlers: []
+  high_flap_threshold: 0
+  interval: 10
+  low_flap_threshold: 0
+  publish: true
+  runtime_assets:
+  - sensu-plugins/sensu-plugins-logs
+  - sensu/sensu-ruby-runtime
+  subscriptions:
+  - linux
+```
+
+#### Handler definition
 
 **handler-logevent**
 ```
@@ -26,8 +120,45 @@
 }
 ```
 
-## Installation
+### Sensu Core
+
+#### Check definition
+```json
+{
+  "checks": {
+    "check-journal": {
+      "command": "check-journal.rb",
+      "subscribers": ["linux"],
+      "interval": 10,
+      "refresh": 10,
+      "handlers": ["influxdb"]
+    }
+  }
+}
+```
+
+## Installation from source
+
+### Sensu Go
+
+See the instructions above for [asset registration](#asset-registration).
+
+### Sensu Core
+
+Install and setup plugins on [Sensu Core](https://docs.sensu.io/sensu-core/latest/installation/installing-plugins/).
+
+## Additional notes
+
+### Sensu Go Ruby Runtime Assets
+
+The Sensu assets packaged from this repository are built against the Sensu Ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator, or handler), make sure to include the corresponding [Sensu Ruby Runtime Asset](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the list of assets needed by the resource.
+
+### Use this plugin with Sensu Go
+
+To use the included handlers with Sensu Go, use the `--map-go-event-into-ruby` argument or set environment variable `SENSU_MAP_GO_EVENT_INTO_RUBY=1`.
+
+Make sure the required handler configuration JSON exists under `/etc/sensu/conf.d/` or at a path in the colon-separated list of files in the environment variable `SENSU_CONFIG_FILES`.
 
-[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+## Contributing
 
-## Notes
+See [CONTRIBUTING.md](https://github.com/sensu-plugins/sensu-plugins-logs/blob/master/CONTRIBUTING.md) for information about contributing to this plugin.

data/bin/check-journal.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 #  check-journal
 #

data/bin/check-log.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 #   check-log
 #
@@ -167,7 +169,7 @@ class CheckLog < Sensu::Plugin::Check::CLI
     file_list.each do |log_file|
       begin
         open_log log_file
-      rescue => e
+      rescue StandardError => e
         unknown "Could not open log file: #{e}"
       end
       n_warns, n_crits, accumulative_error = search_log
@@ -199,14 +201,15 @@ class CheckLog < Sensu::Plugin::Check::CLI
            end
 
     @state_file = File.join(state_dir, File.expand_path(log_file).sub(/^([A-Z]):\//, '\1/'))
-    @bytes_to_skip = begin
-      File.open(@state_file) do |file|
-        file.flock(File::LOCK_SH) unless Gem.win_platform?
-        file.readline.to_i
+    @bytes_to_skip =
+      begin
+        File.open(@state_file) do |file|
+          file.flock(File::LOCK_SH) unless Gem.win_platform?
+          file.readline.to_i
+        end
+      rescue StandardError
+        0
       end
-    rescue
-      0
-    end
   end
 
   def search_log

data/bin/handler-logevent.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # This handler logs last settings['logevent']['keep'] json events in files as
 # settings['logevent']['eventdir']/client/check_name/timestamp.action
@@ -13,16 +15,28 @@ require 'json'
 
 class LogEvent < Sensu::Handler
   def handle
-    eventdir = "#{settings['logevent']['eventdir']}/#{@event['client']['name']}/#{@event['check']['name']}"
+    event_action = @event['action']
+    event_action ||= 'unknown'
+    check_name = @event['check']['name'] if (@event.include? 'check') && (@event['check'].include? 'name')
+    check_name ||= 'unknown'
+    client_name = @event['client']['name'] if (@event.include? 'client') && (@event['client'].include? 'name')
+    client_name ||= 'unknown'
+    check_executed = @event['check']['executed'] if (@event.include? 'check') && (@event['check'].include? 'executed')
+    check_executed ||= 'unknown'
+    dir_stub = settings['logevent']['eventdir'] if (settings.include? 'logevent') && (settings['logevent'].include? 'eventdir')
+    puts settings
+    raise 'logevent eventdir setting is missing' unless dir_stub
+
+    eventdir = "#{settings['logevent']['eventdir']}/#{client_name}/#{check_name}"
     FileUtils.mkdir_p(eventdir)
 
-    File.open("#{eventdir}/#{@event['check']['executed']}.#{@event['action']}", 'w') do |f|
+    File.open("#{eventdir}/#{check_executed}.#{event_action}", 'w') do |f|
       f.write(JSON.pretty_generate(@event))
     end
 
-    events = Dir.glob("#{eventdir}/*.#{@event['action']}")
+    events = Dir.glob("#{eventdir}/*.#{event_action}")
     # #YELLOW
-    if settings['logevent']['keep'] < events.length # rubocop:disable GuardClause
+    if settings['logevent']['keep'] < events.length # rubocop:disable Style/GuardClause
       FileUtils.rm_f(events.sort.reverse.shift(settings['logevent']['keep']))
     end
   end

data/bin/handler-show-event-config.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # This handler just spits out its config and the event it read.
 #

data/lib/sensu-plugins-logs.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sensu-plugins-logs/version'

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module SensuPluginsLogs
   module Version
-    MAJOR = 1
-    MINOR = 3
-    PATCH = 2
+    MAJOR = 4
+    MINOR = 1
+    PATCH = 1
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-logs
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 4.1.1
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: kitchen-docker
   requirement: !ruby/object:Gem::Requirement
@@ -98,22 +98,22 @@ dependencies:
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -176,28 +190,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: serverspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.36.1
+        version: 2.41.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.36.1
+        version: 2.41.3
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
@@ -232,9 +246,9 @@ description: |-
                                 regex matching. Includes various log handlers.
 email: "<sensu-users@googlegroups.com>"
 executables:
-- handler-show-event-config.rb
-- check-journal.rb
 - check-log.rb
+- check-journal.rb
+- handler-show-event-config.rb
 - handler-logevent.rb
 extensions: []
 extra_rdoc_files: []
@@ -266,15 +280,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for logs