sensu-plugins-azurerm 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0fa250c2293cad95e559c4863b4daf23ed897bea75b90c20cca883a2023230
-  data.tar.gz: 79177b35b8700c4a1f9fcb9cc0990e960cc39f8b9c38cb9edf1af20447d95b04
+  metadata.gz: 1c0d821b364b1f014fc8bd22be6ab36099ebf97d153d1285b47f29b09babd7c5
+  data.tar.gz: 3749b5a3f31d8d81097c4544d76428f5fbdf44daf681b4dc35f22b37ef023bfe
 SHA512:
-  metadata.gz: 2d42c8551191ea1eb705533f900042552a091ecee67f7af807f99fb9f9c5a461c3e702493d28af9fe59d26f0449ed9fd613bcd4c9aaaf56bb03dff86b05e5bc6
-  data.tar.gz: 68de20eed748026c0946b831c88e1205a38ca3239b2f2d5aaa8de8f46a5891ca5e13db3068a943afee2801a8046a5afb5af31cd42b952269a8ac1460ca10e956
+  metadata.gz: 7bb2b51fc3cbb14ba2b667414ce71582c28e70a6ce7d5c7af1919345e1624e87e0fed9f6c5ce6a4c4cdc5028b74ab3f91d9f5dfbc9656e49cbbb01858ac0450b
+  data.tar.gz: c4570fabb5ee1cd9e8003e6245a18dcc9f2adfb4466907cd5231d7bad560c6e012df63d7cbf391e43598ea5966ea43b4e6168a71b965cbef5cc0906ca5a4ecae

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format located [here](https://github.com/sensu-plugin
 
 ## [Unreleased]
 
+## [3.1.0] - 2019-03-04
+### Added
+- check-azurerm-monitor-metric.rb: added `--aggregate_results aggregation_type TYPE` option that allows users to aggregate results returned from Azure DB query @MrMisa93
+
 ## [3.0.0] - 2018-09-15
 ### Security
 - updated `yard` dependency to `~> 0.9.11` per: https://nvd.nist.gov/vuln/detail/CVE-2017-17042 which closes attacks against a yard server loading arbitrary files (@majormoses)
@@ -94,7 +98,8 @@ This CHANGELOG follows the format located [here](https://github.com/sensu-plugin
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/3.0.0..HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/3.1.0..HEAD
+[3.1.0]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/3.0.0..3.1.0
 [3.0.0]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/2.1.0..3.0.0
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/1.0.0..2.0.0

data/bin/check-azurerm-monitor-metric.rb

@@ -127,11 +127,18 @@ class CheckAzurermMonitorMetric < Sensu::Plugin::Check::CLI
          short: '-f FILTER',
          long: '--filter FILTER'
 
-  option :aggregation,
-         description:  'Aggregation.  This can be Average, Count, Maximum, Minimum, Total',
+  option :request_aggregation,
+         description:  'Used as a parameter to the HTTP request sent to Azure.   This can be average, count, maximum, minimum, total',
          short: '-a aggregation',
          long: '--aggregation aggregation',
-         default: 'average'
+         default: 'average',
+         in: %w[average count maximum minimum total]
+
+  option :aggregate_results,
+         description: 'Aggregate the result data points to compare against alert conditions.   This can be average, count, maximum, minimum, total',
+         long: '--aggregate_results aggregation_type',
+         default: 'none',
+         in: %w[average count maximum minimum total none]
 
   option :warning_over,
          description: 'The warning threshold to check if the metric is forecasted to go over.',
@@ -178,31 +185,35 @@ class CheckAzurermMonitorMetric < Sensu::Plugin::Check::CLI
       unknown 'At least one threshold must be provided.'
     end
 
-    if last_metric_values.empty?
-      unknown "There are no metric values for #{config[:metric]} on resource #{config[:resource_id] || config[:resource_name]} with aggregation #{config[:aggregation]}"
-    else
-      critical_messages = []
-      warning_messages = []
-
-      last_metric_values.each do |metric_val|
-        if config[:critical_over] && metric_val[:value] > config[:critical_over].to_f
-          critical_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
-        elsif config[:warning_over] && metric_val[:value] > config[:warning_over].to_f
-          warning_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
-        elsif config[:critical_under] && metric_val[:value] < config[:critical_under].to_f
-          critical_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
-        elsif config[:warning_under] && metric_val[:value] < config[:warning_under].to_f
-          warning_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
+    if config[:aggregate_results] == 'none'
+      if last_metric_values.empty?
+        unknown "There are no metric values for #{config[:metric]} on resource #{config[:resource_id] || config[:resource_name]} with aggregation #{config[:aggregation]}"
+      else
+        critical_messages = []
+        warning_messages = []
+
+        last_metric_values.each do |metric_val|
+          if config[:critical_over] && metric_val[:value] > config[:critical_over].to_f
+            critical_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
+          elsif config[:warning_over] && metric_val[:value] > config[:warning_over].to_f
+            warning_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
+          elsif config[:critical_under] && metric_val[:value] < config[:critical_under].to_f
+            critical_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
+          elsif config[:warning_under] && metric_val[:value] < config[:warning_under].to_f
+            warning_messages << "Metric #{metric_val[:metric_name]} is #{metric_val[:value]}"
+          end
         end
-      end
 
-      if !critical_messages.empty?
-        critical critical_messages.join("\n")
-      elsif !warning_messages.empty?
-        warning warning_messages.join("\n")
-      else
-        ok 'Metric(s) are within thresholds'
+        if !critical_messages.empty?
+          critical critical_messages.join("\n")
+        elsif !warning_messages.empty?
+          warning warning_messages.join("\n")
+        else
+          ok 'Metric(s) are within thresholds'
+        end
       end
+    else
+      verify_results_with_aggregation
     end
   end
 
@@ -264,7 +275,7 @@ class CheckAzurermMonitorMetric < Sensu::Plugin::Check::CLI
   end
 
   def metric_value_key
-    config[:aggregation].to_sym
+    config[:request_aggregation].to_sym
   end
 
   def metric_response
@@ -297,7 +308,7 @@ class CheckAzurermMonitorMetric < Sensu::Plugin::Check::CLI
         "api-version=#{AZURE_API_VER}&" \
         "metric=#{config[:metric]}&" \
         "timespan=#{CGI.escape(timespan)}&" \
-        "aggregation=#{config[:aggregation]}"
+        "aggregation=#{config[:request_aggregation]}"
 
       url += "&$filter=#{CGI.escape(config[:filter])}" if config[:filter]
 
@@ -353,4 +364,83 @@ class CheckAzurermMonitorMetric < Sensu::Plugin::Check::CLI
   def handle_response(res)
     critical "Failed to get metric:\n#{res.body}" if res.code.to_i >= 300
   end
+
+  def verify_results_with_aggregation
+    request_values = extract_request_values
+
+    aggregated_value = aggregate_request_values(request_values, config[:aggregate_results])
+
+    results_type = verify_result(aggregated_value)
+
+    exits_with_message(results_type, request_values[0][:name], aggregated_value)
+  end
+
+  def extract_request_values
+    values = []
+    metric_response[:value].each do |metric_resp_value|
+      name = metric_resp_value[:name] ? metric_resp_value[:name][:value] : ''
+
+      next if metric_resp_value[:timeseries].empty?
+
+      metric_resp_value[:timeseries].each do |ts|
+        ts[:data].each do |metric_value|
+          if metric_value[metric_value_key]
+            values << {
+              value: metric_value[metric_value_key].to_f,
+              name: name
+            }
+          end
+        end
+      end
+    end
+    values
+  end
+
+  def aggregate_request_values(request_values, aggregation_type)
+    result_values = []
+
+    request_values.each do |metric_val|
+      result_values.push(metric_val[:value])
+    end
+
+    case aggregation_type
+    when 'average'
+      result_value = result_values.inject { |sum, el| sum + el }.to_f / result_values.size
+    when 'maximum'
+      result_value = result_values.max
+    when 'minimum'
+      result_value = result_values.min
+    when 'total'
+      result_value = result_values.inject(0) { |sum, x| sum + x }
+    when 'count'
+      result_value = result_values.size
+    end
+    result_value
+  end
+
+  def verify_result(aggregated_value)
+    results_type = 'none'
+    if config[:critical_over] && aggregated_value > config[:critical_over].to_f
+      results_type = 'critical'
+    elsif config[:warning_over] && aggregated_value > config[:warning_over].to_f
+      results_type = 'warning'
+    elsif config[:critical_under] && aggregated_value < config[:critical_under].to_f
+      results_type = 'critical'
+    elsif config[:warning_under] && aggregated_value < config[:warning_under].to_f
+      results_type = 'warning'
+    end
+    results_type
+  end
+
+  def exits_with_message(type, metric_name, aggregated_value)
+    message = "Metric #{metric_name} is #{aggregated_value}"
+    case type
+    when 'none'
+      ok 'Metric(s) are within thresholds'
+    when 'warning'
+      warning message
+    when 'critical'
+      critical message
+    end
+  end
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-azurerm
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Tom Harvey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_compute
@@ -114,14 +114,14 @@ dependencies:
     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
@@ -154,22 +154,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.3.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.3.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -394,8 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for working with an Azure Resource Manager environment