sensu-plugins-chef 4.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 921c03d9102e7ba6eb3330438b783613bbb020a1
-  data.tar.gz: 495db0afca92ab3a4fcd2c8b28afc244988f1fcf
+SHA256:
+  metadata.gz: f7954a7930c5a6b28e6db2ad220bae833648c40fc161b8791753d10609c74470
+  data.tar.gz: 9d62de7208d17c6e7ebe36af223e7f47a6ef039e4e72f8c032b0eeb2be8088da
 SHA512:
-  metadata.gz: 9018eb2a96f6f7b6dc76679554ec97583cf6ce76c14f1af5b5e7cc990d22366f0af7e0ebc531b850180327196509458c3d9245a0e4c76a363bc5852c9d604e69
-  data.tar.gz: 40f41e8eb1701604131be65eee08cafe2da795d002a5b3d375b3104579041667b88136fddd8505817b2e8f9ad311e7529938bc3ea6d4e55be158486c38d4a01b
+  metadata.gz: 29a3fa0b14e4a7542263043ba69a6fe8fba60f46a965771513dacb92d7f1e0353354bc9f35da459fed6f030123994f94eb29821d6214fd9c0f3951fbcdd4fb1b
+  data.tar.gz: ee2c1b5207d72d1d36c6501ebee5804a121a3d9d8129448042e5ff6fc90838bdd370a777315763d7de97d98f2e6f789f6d52c247995c4d094dc7101a74f55d0c

data/CHANGELOG.md

@@ -1,9 +1,51 @@
-#Change Log
+# Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
+
+## [7.1.0] - 2021-05-05
+
+### Changed
+- Update development dependancy for github-markdown
+- Update development dependancy for rake
+- Update development dependancy for bundler
+- Update development dependancy for rubocop
+- Update Readme with additional documentation
+
+### Fixed
+- Fixed errors in bonsai asset defitions
+
+## [7.0.0] - 2019-4-19
+### 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)
+
+## [6.0.0] - 2018-12-15
+
+## [5.0.1] - 2018-03-28
+### Security
+- updated yard dependency to `~> 0.9.11` per: https://nvd.nist.gov/vuln/detail/CVE-2017-17042 (@majormoses)
+
+## [5.0.0] - 2018-01-31
+### Security
+- updated `rubocop` dependency to `~> 0.51.0` per: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-8418. (@geewiz)
+
+### Breaking Change
+- in order to bring in new rubocop dependency we need to drop ruby 2.0 support as it is EOL and aligns with our support policy. (@geewiz)
+
+### Fixed
+- made exception handling more specific by catching StandardError (@geewiz)
+- misc formatting in changelog (@majormoses)
+
+### Changed
+- updated changelog guidelines location (@majormoses)
+
+
 ## [4.0.0] - 2017-08-14
 ### Breaking Change
 - check-chef-nodes.rb: added an option for a grace_period which allows exclusion of nodes until they have been online for a specified ammount of time. Defaulting to 300 seconds. (@majormoses)
@@ -84,7 +126,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/4.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/7.1.0...HEAD
+[7.1.0]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/7.0.0...7.1.0
+[7.0.0]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/6.0.0...7.0.0
+[6.0.0]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/5.0.1...6.0.1
+[5.0.1]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/5.0.0...5.0.1
+[5.0.0]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/4.0.0...5.0.0
 [4.0.0]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/3.0.2...4.0.0
 [3.0.2]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/3.0.2...3.0.1
 [3.0.1]: https://github.com/sensu-plugins/sensu-plugins-chef/compare/3.0.1...3.0.0

data/README.md

@@ -1,23 +1,147 @@
-## Sensu-Plugins-chef
-
+[![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-chef)
 [![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-chef.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-chef)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-chef.svg)](http://badge.fury.io/rb/sensu-plugins-chef)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chef/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chef)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chef/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chef)
-[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-chef.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-chef)
 
-## Functionality
+## Sensu Plugins Chef Plugin
 
-## Files
- * bin/check-chef-nodes.rb
+- [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
+
+This plugin provides native instrumentation for monitoring Chef, including service health checks (via chef-server-ctl) and chef node status, and a Sensu handler for removing stale Sensu clients.
+
+### Files
  * bin/check-chef-node.rb
+ * bin/check-chef-nodes.rb
  * bin/check-chef-server.rb
  * bin/handler-chef-node.rb
+ 
+**check-chef-node**
+Checks if a node exists.
+
+**check-chef-nodes**
+Reports nodes from your cluster that were last seen before the specified number of seconds.
+
+**check-chef-server**
+Uses Chef Server's `chef-server-ctl` to check whether any component of the Chef Server is not running. You must run this plugin with elevated privileges (sudo) or it will fail with unknown state.
+
+**handler-chef-node**
+Removes a Sensu client if its Chef node data no longer exists.
+
+## Usage examples
+
+### Help
+
+**check-chef-node.rb**
+```
+Usage: check-chef-node.rb (options)
+    -U, --url CHEF-SERVER-URL        URL of Chef server
+    -C, --client CLIENT-NAME         Client name
+    -i, --ignore-ssl                 Ignore SSL certificate verification
+    -K, --keys CLIENT-KEY            Client's key
+    -n, --node-name NODE-NAME        Check if this node name exists
+```
+
+**handler-chef-node.rb**
+```
+Usage: handler-chef-node.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-chef`
+
+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-chef).
+
+#### Asset definition
+
+```yaml
+---
+type: Asset
+api_version: core/v2
+metadata:
+  name: sensu-plugins-chef
+spec:
+  url: https://assets.bonsai.sensu.io/94e44dc0b89b7cd8318c38db5f64f788642140d8/sensu-plugins-chef_7.0.0_centos_linux_amd64.tar.gz
+  sha512: f468ea0060ab890004a3f5bd09deff5bdd98db9e7a4c9ffc0ad1c8809b0e5a8198737f23ec850e9f5181fd590aafa5b895dd948b264244770c77b5f03fa523ef
+```
+
+#### Check definition
+
+```yaml
+---
+type: CheckConfig
+spec:
+  command: "check-chef-nodes.rb"
+  handlers: []
+  high_flap_threshold: 0
+  interval: 10
+  low_flap_threshold: 0
+  publish: true
+  runtime_assets:
+  - sensu-plugins/sensu-plugins-chef
+  - sensu/sensu-ruby-runtime
+  subscriptions:
+  - linux
+```
+
+### Sensu Core
+
+#### Check definition
+```json
+{
+  "checks": {
+    "check-chef-nodes": {
+      "command": "check-chef-nodes.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.
 
-## Usage
+### Use this plugin with Sensu Go
 
-## Installation
+To use `handler-chef-node.rb` with Sensu Go, you will need to use the event mapping command line option. See `handler-chef-node.rb --help` for details. Read the [sensu-plugin README](https://github.com/sensu-plugins/sensu-plugin#sensu-go-enablement) for more information about the event mapping functionality.
 
-[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+## Contributing
 
-## Notes
+See [CONTRIBUTING.md](https://github.com/sensu-plugins/sensu-plugins-chef/blob/master/CONTRIBUTING.md) for information about contributing to this plugin.

data/bin/check-chef-node.rb

@@ -1,5 +1,6 @@
 #! /usr/bin/env ruby
-#
+# frozen_string_literal: true
+
 #   check-chef-node
 #
 # DESCRIPTION:
@@ -71,7 +72,7 @@ class ChefNodeChecker < Sensu::Plugin::Check::CLI
     else
       warning "Node #{config[:node_name]} does not contain 'ohai_time' attribute"
     end
-  rescue => e
+  rescue StandardError => e
     critical "Node #{config[:node_name]} not found - #{e.message}"
   end
 

data/bin/check-chef-nodes.rb

@@ -1,5 +1,6 @@
 #! /usr/bin/env ruby
-#
+# frozen_string_literal: true
+
 #   check-chef-nodes
 #
 # DESCRIPTION:
@@ -74,9 +75,10 @@ class ChefNodesStatusChecker < Sensu::Plugin::Check::CLI
          default: '^$'
 
   option :grace_period,
-         description: 'The ammount of time before a node should be evaluated for failed convergence',
+         description: 'The amount of time before a node should be evaluated for failed convergence',
          long: '--grace-period SECONDS',
-         default: (60 * 5), # default 5 minutes, which seems like a good but not great default
+         # default 5 minutes, which seems like a good but not great default
+         default: (60 * 5),
          proc: proc(&:to_i)
 
   option :ignore_ssl_verification,

data/bin/check-chef-server.rb

@@ -1,5 +1,6 @@
 #! /usr/bin/env ruby
-#
+# frozen_string_literal: true
+
 #   check-chef-server
 #
 # DESCRIPTION:
@@ -48,7 +49,7 @@ class CheckChefServer < Sensu::Plugin::Check::CLI
           failed_processes << proc.match('^(fail|down|warning):\s+([a-z-]+)')[2]
         end
       end
-      if failed_processes.count > 0
+      if failed_processes.count.positive?
         critical("chef-server service(s): #{failed_processes.join(', ')} #{failed_processes.count == 1 ? 'is' : 'are'} failed, down, or in warning state")
       else
         ok

data/bin/handler-chef-node.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # This handler removes a Sensu client if its Chef node data
 # no longer exists.
@@ -66,17 +68,17 @@ class ChefNode < Sensu::Handler
         r.node.find(@event['client']['name']) ? true : false
       end
     # FIXME: Why is this necessary?  Ridley works fine outside of Sensu
-    rescue Celluloid::Error
+    rescue Celluloid::Error => e
       Celluloid.boot
       retried += 1
       if retried < 2
         retry
       else
-        puts "CHEF-NODE: Ridley is broken: #{error.inspect}"
+        puts "CHEF-NODE: Ridley is broken: #{e.inspect}"
         true
       end
-    rescue => error
-      puts "CHEF-NODE: Unexpected error: #{error.inspect}"
+    rescue StandardError => e
+      puts "CHEF-NODE: Unexpected error: #{e.inspect}"
       true
     end
   end
@@ -84,14 +86,14 @@ class ChefNode < Sensu::Handler
   def delete_sensu_client!
     api_request(:DELETE, '/clients/' + @event['client']['name'])
     puts "CHEF-NODE: Successfully deleted Sensu client #{@event['client']['name']}"
-  rescue => error
-    puts "CHEF-NODE: Unexpected error: #{error.inspect}"
+  rescue StandardError => e
+    puts "CHEF-NODE: Unexpected error: #{e.inspect}"
   end
 
   def filter; end
 
   def handle
-    unless chef_node_exists? # rubocop:disable GuardClause
+    unless chef_node_exists? # rubocop:disable Style/GuardClause
       delete_sensu_client!
     end
   end

data/lib/sensu-plugins-chef.rb

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

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SensuPluginsChef
   module Version
-    MAJOR = 4
-    MINOR = 0
+    MAJOR = 7
+    MINOR = 1
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,77 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-chef
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: chef
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.12.15
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.12.15
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: ridley
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.1.1
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
     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: varia_model
   requirement: !ruby/object:Gem::Requirement
@@ -92,56 +78,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: nio4r
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -185,47 +157,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 description: |-
   This plugin provides native Chef instrumentation
                                 for monitoring, including: report stale nodes,
@@ -235,8 +207,8 @@ email: "<sensu-users@googlegroups.com>"
 executables:
 - check-chef-node.rb
 - check-chef-nodes.rb
-- check-chef-server.rb
 - handler-chef-node.rb
+- check-chef-server.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -267,15 +239,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for chef