sensu-plugins-aws 10.0.3 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4d374e51efee898a5c8a79b78b93b3ced3eb090c8a09e48b8258ecc6e5f4299
-  data.tar.gz: 304c60c4178e8bb39afd8c21da9e2cbeabfb97ab9ee6c75d5ae42d953722a887
+  metadata.gz: 35e5a15486f7584a9ba3511aa6511e5499749785c6eb479b2bf466e387f5453e
+  data.tar.gz: fba519f316d43e12c735671f13c4d83e267fc3deab9c3379408fbc2239968ef3
 SHA512:
-  metadata.gz: ab9b02c01ece25c58a40e3b8a2dfef4df1c2b92b9a659ccfeb407a72e2c2ea87d7ab4a75cf493f06bf6f3902758a1e1ef956f4f6318edad9ad954b89dc1a8b3d
-  data.tar.gz: 4ef3f5844d954b354f8d1bf34c5a44939177829e26ba2657be9bf15235aff975daea91e4c52c76c8d4c97d21a4bbe98eceee118cbaee6ae1c1148d15d85b6bfb
+  metadata.gz: 971426511c04536e2c5915af6e22b1429b54d2699ec24ef04caa0d5c42f04020f37ac8013a1434cbd5bafd368c8324a0bc1e2e1de33975acefb28085fcffb3f6
+  data.tar.gz: 694f183d1e74bc11f8596930d847fa439fe0a08154a9e3e90e17b535c780c9966889130cf8fdae078ff20cd695f42d39a709d82ad2e58223355e0a72977bfc52

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [10.1.0] - 2018-01-06
+- check-cloudwatch-composite-metric.rb: add flags `zero_denominator_data_ok`, `no_denominator_data_ok`, and `numerator_default` to add ability to allow numerator in composite to be 0. While leaving the functionality of `no_data_ok` the same, this change allows us to check to alert if the numerator has no data since 0/X is a valid alert case. (@zbintliff)
+- lib/cloudwatch-common.rb: added tests for majority of functions (@zbintliff)
+
 ## [10.0.3] - 2017-12-03
 ### Fixed
 - metrics-asg.rb: fix dimension name, handle the --scheme flag, make the --statistic flag work, support autoscaling groups containing spaces in their name (@multani)
@@ -406,7 +410,8 @@ WARNING:  This release contains major breaking changes that will impact all user
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/10.0.3...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/10.1.0...HEAD
+[10.1.0]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/10.1.0...10.0.3
 [10.0.3]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/10.0.2...10.0.3
 [10.0.2]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/10.0.1...10.0.2
 [10.0.1]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/10.0.0...10.0.1

data/bin/check-cloudwatch-composite-metric.rb

@@ -85,14 +85,14 @@ class CloudWatchCompositeMetricCheck < Sensu::Plugin::Check::CLI
          description: 'CloudWatch metric unit'
 
   option :critical,
-         description: 'Trigger a critical when value is over VALUE',
+         description: 'Trigger a critical when value is over VALUE as a Percent',
          short: '-c VALUE',
          long: '--critical VALUE',
          proc: proc(&:to_f),
          required: true
 
   option :warning,
-         description: 'Trigger a warning when value is over VALUE',
+         description: 'Trigger a warning when value is over VALUE as a Percent',
          short: '-w VALUE',
          long: '--warning VALUE',
          proc: proc(&:to_f)
@@ -103,20 +103,97 @@ class CloudWatchCompositeMetricCheck < Sensu::Plugin::Check::CLI
          long: '--operator OPERATION',
          default: 'greater'
 
+  option :numerator_default,
+         long: '--numerator-default DEFAULT',
+         description: 'Default for numerator if no data is returned for metric',
+         proc: proc(&:to_f)
+
+  option :no_denominator_data_ok,
+         long: '--allow-no-denominator-data',
+         description: 'Returns ok if no data is returned from denominator metric',
+         boolean: true,
+         default: false
+
+  option :zero_denominator_data_ok,
+         long: '--allow-zero-denominator-data',
+         description: 'Returns ok if denominator metric is zero',
+         boolean: true,
+         default: false
+
   option :no_data_ok,
          short: '-O',
          long: '--allow-no-data',
-         description: 'Returns ok if no data is returned from the metric',
+         description: 'Returns ok if no data is returned from either metric',
          boolean: true,
          default: false
-
   include CloudwatchCommon
 
   def metric_desc
     "#{config[:namespace]}-#{config[:numerator_metric_name]}/#{config[:denominator_metric_name]}(#{dimension_string})"
   end
 
+  def numerator_data(metric_payload)
+    if resp_has_no_data(metric_payload, config[:statistics])
+      # If the numerator response has no data in it, see if there was a predefined default.
+      # If there is no predefined default it will return nil
+      config[:numerator_default]
+    else
+      read_value(metric_payload, config[:statistics]).to_f
+    end
+  end
+
+  # rubocop:disable Style/GuardClause
+  def composite_check
+    numerator_metric_resp = get_metric(config[:numerator_metric_name])
+    denominator_metric_resp = get_metric(config[:denominator_metric_name])
+
+    ## If the numerator is empty, then we see if there is a default. If there is a default
+    ## then we will pretend the numerator _isnt_ empty. That is
+    ## if empty but there is no default this will be true. If it is empty and there is a default
+    ## this will be false (i.e. there is data, following standard of dealing in the negative here)
+    no_num_data = numerator_data(numerator_metric_resp).nil?
+    no_den_data = resp_has_no_data(denominator_metric_resp, config[:statistics])
+    no_data = no_num_data || no_den_data
+
+    # no data in numerator or denominator this is to keep backwards compatibility
+    if no_data && config[:no_data_ok]
+      return :ok, "#{metric_desc} returned no data but that's ok"
+    elsif no_den_data && config[:no_denominator_data_ok]
+      return :ok, "#{config[:denominator_metric_name]} returned no data but that's ok"
+    elsif no_data ## This is legacy case
+      return :unknown, "#{metric_desc} could not be retrieved"
+    end
+
+    ## Now both the denominator and numerator have data (or a valid default)
+    denominator_value = read_value(denominator_metric_resp, config[:statistics]).to_f
+    if denominator_value.zero? && config[:zero_denominator_data_ok]
+      return :ok, "#{metric_desc}: denominator value is zero but that's ok"
+    elsif denominator_value.zero?
+      return :unknown, "#{metric_desc}: denominator value is zero"
+    end
+
+    ## We already checked if this value is nil so we know its not
+    numerator_value = numerator_data(numerator_metric_resp)
+    value = (numerator_value / denominator_value * 100).to_i
+    base_msg = "#{metric_desc} is #{value}: comparison=#{config[:compare]}"
+
+    if compare(value, config[:critical], config[:compare])
+      return :critical, "#{base_msg} threshold=#{config[:critical]}"
+    elsif config[:warning] && compare(value, config[:warning], config[:compare])
+      return :warning,  "#{base_msg} threshold=#{config[:warning]}"
+    else
+      threshold = config[:warning] || config[:critical]
+      return :ok, "#{base_msg}, will alarm at #{threshold}"
+    end
+  end
+  # rubocop:enable Style/GuardClause
+
   def run
-    composite_check config
+    status, msg = composite_check
+    if respond_to?(status)
+      send(status, msg)
+    else
+      unknown 'unknown exit status called'
+    end
   end
 end

data/lib/sensu-plugins-aws/cloudwatch-common.rb

@@ -3,7 +3,7 @@ module CloudwatchCommon
   include Common
 
   def client
-    Aws::CloudWatch::Client.new
+    @client ||= Aws::CloudWatch::Client.new
   end
 
   def read_value(resp, stats)
@@ -40,47 +40,13 @@ module CloudwatchCommon
     }
   end
 
-  def composite_metrics_request(config, metric, fixed_time_now = Time.now)
-    {
-      namespace: config[:namespace],
-      metric_name: config[metric],
-      dimensions: config[:dimensions],
-      start_time: fixed_time_now - config[:period] * 10,
-      end_time: fixed_time_now,
-      period: config[:period],
-      statistics: [config[:statistics]],
-      unit: config[:unit]
-    }
+  def get_metric(metric)
+    client.get_metric_statistics(composite_metrics_request(metric))
   end
 
-  def composite_check(config)
-    fixed_time_now = Time.now
-    numerator_metric_resp = client.get_metric_statistics(composite_metrics_request(config, :numerator_metric_name, fixed_time_now))
-    denominator_metric_resp = client.get_metric_statistics(composite_metrics_request(config, :denominator_metric_name, fixed_time_now))
-
-    no_data = resp_has_no_data(numerator_metric_resp, config[:statistics]) || \
-              resp_has_no_data(denominator_metric_resp, config[:statistics])
-    if no_data && config[:no_data_ok]
-      ok "#{metric_desc} returned no data but that's ok"
-    elsif no_data && !config[:no_data_ok]
-      unknown "#{metric_desc} could not be retrieved"
-    end
-
-    denominator_value = read_value(denominator_metric_resp, config[:statistics]).to_f
-    if denominator_value.zero?
-      ok "#{metric_desc} denominator value is zero but that's ok"
-    end
-    numerator_value = read_value(numerator_metric_resp, config[:statistics]).to_f
-    value = (numerator_value / denominator_value * 100).to_i
-    base_msg = "#{metric_desc} is #{value}: comparison=#{config[:compare]}"
-
-    if compare(value, config[:critical], config[:compare])
-      critical "#{base_msg} threshold=#{config[:critical]}"
-    elsif config[:warning] && compare(value, config[:warning], config[:compare])
-      warning "#{base_msg} threshold=#{config[:warning]}"
-    else
-      ok "#{base_msg}, will alarm at #{!config[:warning].nil? ? config[:warning] : config[:critical]}"
-    end
+  def composite_metrics_request(metric)
+    ## config is a class variable but don't want to change signature
+    metrics_request(config).merge(metric_name: metric)
   end
 
   def self.parse_dimensions(dimension_string)

data/lib/sensu-plugins-aws/common.rb

@@ -17,8 +17,8 @@
 #
 
 module Common
-  def initialize
-    super()
+  def initialize(argv = ARGV)
+    super(argv)
     aws_config
   end
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-aws
 version: !ruby/object:Gem::Version
-  version: 10.0.3
+  version: 10.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -445,7 +445,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for working with an AWS environment