sensu-plugins-chrony 0.0.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9cac8096899909e07539a3cb15728b38b3825ac9
-  data.tar.gz: 37a753949e0a60708685275b7319b4474d20004d
+SHA256:
+  metadata.gz: 965f2fbf43b9f3c77f30a54bc1290865dd3d5de5cedef3d4575a978840aeffb3
+  data.tar.gz: 3c1aaf84eb403857d96c51d76db2fb0c35fe9fd7ec04b5b97d0281699b25fff7
 SHA512:
-  metadata.gz: b34f1d7f6c39d2bcef2cb16273d4917e58062184829e5c71a2dbc3db123764fbf4d2f08de0b244775b26212feb83aaad6f54b90f22522ddfb0df91d998c7ecb5
-  data.tar.gz: 2f149cf30bbe0c876e139ba363806ec7a4c680e1cf6a8c4ba5bc5b8f285b96b0969a97b828ac93398c1e70b5b2da38a7f6f1b4907876170c841f53797fdf81ec
+  metadata.gz: 54a4b4245e9e8fc549c8229e2f9eb8135cfb8d286d52cef7bb2de7a6a33ba3fdc500a4a0e4309c7984a759781acb9125a8d06111b027aaf3ee64aff31f3bb677
+  data.tar.gz: 19aff54c37cc2db333c0d7f0fdcf356daad184717b35697666a2ddd2e8b7f8eca9bb5e07696ef4fe4e2e6082afd8a6bc921e7564120713587590a9ba23f5eddf

data/CHANGELOG.md

@@ -1,9 +1,45 @@
 # 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
+## [Unreleased]
+
+## [2.0.0] - 2020-08-24
+### Breaking Changes
+- Remove support for old Ruby (< 2.3)
+- Bump sensu-plugin dependency from ~> 2.0 to ~> 4.0
+
+### Changed
+- Updated bundler dependancy to '~> 2.1'
+- Updated rubocop dependency to '~> 0.81.0'
+- Remediated rubocop issues
+- Updated rake dependency to '~> 13.0'
+- Fixed errors where warnings where sent as critical
+
+## [1.0.1] - 2018-05-03
+### Fixed
+- Fixes "undefined method `empty?"` (@jwatroba)
+
+## [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
+- fixed metrics key naming (@vervas)
 
 ## [0.0.8] - 2016-04-04
 ### Added
@@ -36,3 +72,18 @@ 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/2.0.0...HEAD
+[2.0.0]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/1.0.1...2.0.0
+[1.0.1]: https://github.com/sensu-plugins/sensu-plugins-ntp/compare/1.0.0...1.0.1
+[1.0.0]: 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

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: false
+
 #
 # check-chrony.rb
 #
@@ -11,48 +13,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 +63,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 +112,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}"
 
@@ -111,42 +133,42 @@ class CheckChrony < Sensu::Plugin::Check::CLI
         send_critical(check_name, msg)
       elsif stratum >= config[:warn_stratum]
         msg += ", expected < #{config[:warn_stratum]}"
-        send_critical(check_name, msg)
+        send_warning(check_name, msg)
       else
         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]
-        msg += ", expected > -#{config[:crit_offset]} and < #{config[:warn_offset]}"
-        send_critical(check_name, msg)
+      elsif offset >= config[:warn_offset] || offset < -config[:warn_offset]
+        msg += ", expected > -#{config[:warn_offset]} and < #{config[:warn_offset]}"
+        send_warning(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,6 @@
 #! /usr/bin/env ruby
-#  encoding: UTF-8
+# frozen_string_literal: false
+
 #
 #   metrics-chrony
 #
@@ -34,7 +35,7 @@ class ChronyMetrics < Sensu::Plugin::Metric::CLI::Graphite
          description: 'Metric naming scheme, text to prepend to metric',
          short: '-s SCHEME',
          long: '--scheme SCHEME',
-         default: Socket.gethostname
+         default: "#{Socket.gethostname}.chronystats"
 
   def run
     # #YELLOW
@@ -42,39 +43,33 @@ class ChronyMetrics < Sensu::Plugin::Metric::CLI::Graphite
       config[:scheme] = config[:host]
     end
 
-    chronystats = get_chronystats(config[:host])
+    chronystats = read_chronystats
     critical "Failed to get chronycstats from #{config[:host]}" if chronystats.empty?
     metrics = {
-      chronystats: chronystats
+      config[:scheme] => chronystats
     }
     metrics.each do |name, stats|
       stats.each do |key, value|
-        output([config[:scheme], name, key].join('.'), value)
+        output([name, key].join('.'), value)
       end
     end
     ok
   end
 
-  def get_chronystats(host)
-    key_pattern = Regexp.compile(
-      [
-        "Stratum",
-        "Last offset",
-        "RMS offset",
-        "Frequency",
-        "Residual freq",
-        "Skew",
-        "Root delay",
-        "Root dispersion",
-        "Update interval"
-      ].join('|'))
-    num_val_pattern = /[\-\+]?[\d]+(\.[\d]+)?/
-    pattern = /^(#{key_pattern})\s*:\s*(#{num_val_pattern}).*$/
+  def read_chronystats
+    num_val_pattern = /^[-+]?\d+(\.\d+)?\s/
 
-    `chronyc tracking`.scan(pattern).reduce({}) do |hash, parsed|
-      key, val, fraction = parsed
-      hash[key] = fraction ? val.to_f : val.to_i
-      hash
+    `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
     end
   end
+
+  def snakecase(str)
+    str.downcase.tr(' ', '_').gsub(/[()]/, '')
+  end
 end

data/lib/sensu-plugins-chrony.rb

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

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

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

metadata

@@ -1,31 +1,132 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-chrony
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 2.0.0
 platform: ruby
 authors:
 - Matteo Cerutti
+- Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.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: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '4.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
@@ -57,15 +158,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      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.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for monitoring Chrony NTP