sensu-plugins-chrony 0.0.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbee417370232667d4b3b9edf97326b3ee60fd5d
-  data.tar.gz: 9e62f3fd51ea37044e82dd75ff6a7a8928743eed
+  metadata.gz: 5c52e1cf5df506dd5cfb30502ba190b8c97426fc
+  data.tar.gz: 2393f9eb54485903e6509feaa3a64ba5dd08501b
 SHA512:
-  metadata.gz: 7fd93d42abd56f7c88f92c588ada85dcc04d068d5b92edf2bd2479eded00391b2aa48b52a0f4e14c2bf9d15d7e46bd96f3a77d6bd11266359ad824dafe8ee194
-  data.tar.gz: c6397e9073a5d2dd832b22c3b7fb8cb726d498de4f8b8781575584a382fb9d400d06a972caf5ed89725e4a2678f8a389534562be492058764b7ceb36feb2b513
+  metadata.gz: b4db8201cbe5ee253c874ba5b7b68a660877d92a9a11f65bfa4980f872365a445128a1e3fd64af1ffb9e912c49db2135b9e72b8802a5efbc11d5b2a7192c2274
+  data.tar.gz: a23e33888e4c5f321f7784911fa161db0e08688aa2e5b4de2786452ab564f104ea7391494b8bda70f872322632016903c6b95a8d3ca5b87d09ca975e414e7746

data/CHANGELOG.md

@@ -1,7 +1,25 @@
 # 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]
+
+## [1.0.0] - 2018-01-04
+### Breaking Change
+- remove ruby < 2.0 support (@majormoses)
+- require `sensu-plugin` 2.0 (@majormoses)
+
+### Added
+- github templates (@majormoses)
+- links to changelog guidelines (@majormoses)
+- badges to README (@majormoses)
+- various misc development dependencies (@majormoses)
+
+### Changed
+- standard gemspec (@majormoses)
+- appease the cops (@majormoses)
+- standard Rakefile (@majormoses)
 
 ## [0.0.9] - 2016-04-05
 ### Added
@@ -38,3 +56,16 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ## [0.0.1] - 2015-12-28
 ### Added
 - Initial release
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/1.0.0...HEAD
+[1.0.2]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.10...1.0.0
+[0.0.10]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.9...0.0.10
+[0.0.9]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.8...0.0.9
+[0.0.8]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.7...0.0.8
+[0.0.7]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.6...0.0.7
+[0.0.6]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.5...0.0.6
+[0.0.5]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.4...0.0.5
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/0.0.1...0.0.2
+[0.0.1]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/00e3dfb1d044946ec5465f7075dce532bbb60cff...0.0.1

data/README.md

@@ -1,5 +1,13 @@
 # Sensu plugin for monitoring Chrony NTP
 
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-chrony.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-chrony)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-chrony.svg)](https://badge.fury.io/rb/sensu-plugins-chrony)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chrony/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chrony)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chrony/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-chrony)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-chrony.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-chrony)
+[![Community Slack](https://slack.sensu.io/badge.svg)](https://slack.sensu.io/badge)
+
 A sensu plugin to monitor Chrony NTP. There is also a metrics plugin for collecting things like offset, delay etc.
 
 The plugin generates multiple OK/WARN/CRIT/UNKNOWN check events via the sensu client socket (https://sensuapp.org/docs/latest/clients#client-socket-input) so that you do not miss state changes when monitoring offset, stratum and status.

data/bin/check-chrony.rb

@@ -11,48 +11,48 @@ require 'json'
 
 class CheckChrony < Sensu::Plugin::Check::CLI
   option :chronyc_cmd,
-         :description => "Path to chronyc executable (default: /usr/bin/chronyc)",
-         :short => "-c <PATH>",
-         :long => "--chronyc-cmd <PATH>",
-         :default => "/usr/bin/chronyc"
+         description: 'Path to chronyc executable (default: /usr/bin/chronyc)',
+         short: '-c <PATH>',
+         long: '--chronyc-cmd <PATH>',
+         default: '/usr/bin/chronyc'
 
   option :warn_offset,
-         :description => "Warn if OFFSET exceeds current offset (ms)",
-         :long => "--warn-offset <OFFSET>",
-         :proc => proc(&:to_f),
-         :default => 50
+         description: 'Warn if OFFSET exceeds current offset (ms)',
+         long: '--warn-offset <OFFSET>',
+         proc: proc(&:to_f),
+         default: 50
 
   option :crit_offset,
-         :description => "Critical if OFFSET exceeds current offset (ms)",
-         :long => "--crit-offset <OFFSET>",
-         :proc => proc(&:to_f),
-         :default => 100
+         description: 'Critical if OFFSET exceeds current offset (ms)',
+         long: '--crit-offset <OFFSET>',
+         proc: proc(&:to_f),
+         default: 100
 
   option :warn_stratum,
-         :description => "Warn if STRATUM exceeds current stratum",
-         :long => "--warn-stratum <STRATUM>",
-         :proc => proc(&:to_i),
-         :default => 10
+         description: 'Warn if STRATUM exceeds current stratum',
+         long: '--warn-stratum <STRATUM>',
+         proc: proc(&:to_i),
+         default: 10
 
   option :crit_stratum,
-         :description => "Critical if STRATUM exceeds current stratum",
-         :long => "--crit-stratum <STRATUM>",
-         :proc => proc(&:to_i),
-         :default => 16
+         description: 'Critical if STRATUM exceeds current stratum',
+         long: '--crit-stratum <STRATUM>',
+         proc: proc(&:to_i),
+         default: 16
 
   option :handlers,
-         :description => "Comma separated list of handlers",
-         :long => "--handlers <HANDLER>",
-         :proc => proc { |s| s.split(',') },
-         :default => []
+         description: 'Comma separated list of handlers',
+         long: '--handlers <HANDLER>',
+         proc: proc { |s| s.split(',') },
+         default: []
 
   option :dryrun,
-         :description => "Do not send events to sensu client socket",
-         :long => "--dryrun",
-         :boolean => true,
-         :default => false
+         description: 'Do not send events to sensu client socket',
+         long: '--dryrun',
+         boolean: true,
+         default: false
 
-  def initialize()
+  def initialize
     super
   end
 
@@ -61,27 +61,47 @@ class CheckChrony < Sensu::Plugin::Check::CLI
       puts data.inspect
     else
       sock = UDPSocket.new
-      sock.send(data + "\n", 0, "127.0.0.1", 3030)
+      sock.send(data + "\n", 0, '127.0.0.1', 3030)
     end
   end
 
   def send_ok(check_name, msg)
-    event = {"name" => check_name, "status" => 0, "output" => "#{self.class.name} OK: #{msg}", "handlers" => config[:handlers]}
+    event = {
+      'name' => check_name,
+      'status' => 0,
+      'output' => "#{self.class.name} OK: #{msg}",
+      'handlers' => config[:handlers]
+    }
     send_client_socket(event.to_json)
   end
 
   def send_warning(check_name, msg)
-    event = {"name" => check_name, "status" => 1, "output" => "#{self.class.name} WARNING: #{msg}", "handlers" => config[:handlers]}
+    event = {
+      'name' => check_name,
+      'status' => 1,
+      'output' => "#{self.class.name} WARNING: #{msg}",
+      'handlers' => config[:handlers]
+    }
     send_client_socket(event.to_json)
   end
 
   def send_critical(check_name, msg)
-    event = {"name" => check_name, "status" => 2, "output" => "#{self.class.name} CRITICAL: #{msg}", "handlers" => config[:handlers]}
+    event = {
+      'name' => check_name,
+      'status' => 2,
+      'output' => "#{self.class.name} CRITICAL: #{msg}",
+      'handlers' => config[:handlers]
+    }
     send_client_socket(event.to_json)
   end
 
   def send_unknown(check_name, msg)
-    event = {"name" => check_name, "status" => 3, "output" => "#{self.class.name} UNKNOWN: #{msg}", "handlers" => config[:handlers]}
+    event = {
+      'name' => check_name,
+      'status' => 3,
+      'output' => "#{self.class.name} UNKNOWN: #{msg}",
+      'handlers' => config[:handlers]
+    }
     send_client_socket(event.to_json)
   end
 
@@ -90,19 +110,19 @@ class CheckChrony < Sensu::Plugin::Check::CLI
     offset = nil
     status = nil
 
-    %x[#{config[:chronyc_cmd]} tracking].each_line do |line|
+    `#{config[:chronyc_cmd]} tracking`.each_line do |line|
       case line.downcase
-        when /^stratum\s*:\s*(\d+)$/
-          stratum = $1.to_i
-        when /^last offset\s*:\s*([\-\+]?[.\d]+)\s*seconds$/
-          # convert from seconds to milliseconds
-          offset = $1.to_f * 1000
-        when /^leap status\s*:\s*(.*?)$/
-          status = $1
+      when /^stratum\s*:\s*(\d+)$/
+        stratum = Regexp.last_match(1).to_i
+      when /^last offset\s*:\s*([\-\+]?[.\d]+)\s*seconds$/
+        # convert from seconds to milliseconds
+        offset = Regexp.last_match(1).to_f * 1000
+      when /^leap status\s*:\s*(.*?)$/
+        status = Regexp.last_match(1)
       end
     end
 
-    check_name = "chrony-stratum"
+    check_name = 'chrony-stratum'
     if stratum
       msg = "NTP stratum is #{stratum}"
 
@@ -116,37 +136,37 @@ class CheckChrony < Sensu::Plugin::Check::CLI
         send_ok(check_name, msg)
       end
     else
-      send_unknown(check_name, "Failed to look up NTP stratum")
+      send_unknown(check_name, 'Failed to look up NTP stratum')
     end
 
-    check_name = "chrony-offset"
+    check_name = 'chrony-offset'
     if offset
       msg = "NTP offset is #{offset.round(4)}ms"
 
-      if offset >= config[:crit_offset] or offset <= -config[:crit_offset]
+      if offset >= config[:crit_offset] || offset <= -config[:crit_offset]
         msg += ", expected > -#{config[:crit_offset]} and < #{config[:crit_offset]}"
         send_critical(check_name, msg)
-      elsif offset >= config[:warn_offset] or offset < -config[:warn_offset]
+      elsif offset >= config[:warn_offset] || offset < -config[:warn_offset]
         msg += ", expected > -#{config[:crit_offset]} and < #{config[:warn_offset]}"
         send_critical(check_name, msg)
       else
         send_ok(check_name, msg)
       end
     else
-      send_unknown(check_name, "Failed to look up NTP offset")
+      send_unknown(check_name, 'Failed to look up NTP offset')
     end
 
     if status
       msg = "NTP status is '#{status}'"
 
-      if status != "normal"
-        msg += ", expected 'Normal'"
+      if status != 'normal'
+        msg += ', expected \'Normal\''
         critical(msg)
       else
         ok(msg)
       end
     else
-      unknown("Failed to look up NTP status")
+      unknown('Failed to look up NTP status')
     end
   end
 end

data/bin/metrics-chrony.rb

@@ -1,5 +1,4 @@
 #! /usr/bin/env ruby
-#  encoding: UTF-8
 #
 #   metrics-chrony
 #
@@ -42,7 +41,7 @@ class ChronyMetrics < Sensu::Plugin::Metric::CLI::Graphite
       config[:scheme] = config[:host]
     end
 
-    chronystats = get_chronystats
+    chronystats = chronystats
     critical "Failed to get chronycstats from #{config[:host]}" if chronystats.empty?
     metrics = {
       config[:scheme] => chronystats
@@ -55,17 +54,16 @@ class ChronyMetrics < Sensu::Plugin::Metric::CLI::Graphite
     ok
   end
 
-  def get_chronystats
+  def chronystats
     num_val_pattern = /^[-+]?\d+(\.\d+)?\s/
 
-    `chronyc tracking`.each_line.reduce({}) do |hash, line|
+    `chronyc tracking`.each_line.each_with_object({}) do |line, hash|
       key, val = line.split(/\s*:\s*/)
       matched = val.match(num_val_pattern) || (next hash)
       number, fraction = matched.to_a
       number = fraction ? number.to_f : number.to_i
       number = - number if /slow/ =~ val # for system time
       hash[snakecase(key)] = number
-      hash
     end
   end
 

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

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

metadata

@@ -1,34 +1,135 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-chrony
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 1.0.0
 platform: ruby
 authors:
 - Matteo Cerutti
+- Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.0'
 description: This plugin provides facilities for monitoring Chrony NTP
-email: "<matteo.cerutti@hotmail.co.uk>"
+email:
+- "<matteo.cerutti@hotmail.co.uk>"
+- "<sensu-users@googlegroups.com>"
 executables:
-- check-chrony.rb
 - metrics-chrony.rb
+- check-chrony.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -57,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -65,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for monitoring Chrony NTP