sensu-plugins-azurerm 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 031b76d776d3302c32c3b0f6f5f1553e2f3afd153f509506bbd7806b961efdd4
-  data.tar.gz: b112f955b57c08a445d905a5b1c519f2e4078803b45e95ca4d28ec2f0f0d4fe5
+SHA1:
+  metadata.gz: 96fa1b12331ae15cfa86f91e425fc0d0e39620aa
+  data.tar.gz: a273702f89fce82e5da3935733a5846ffb0fcf88
 SHA512:
-  metadata.gz: dc7068537d941dc3826f161fc68c9e432030a8608d233114bc38dd983c00fbdefd8edd95b59d1c86faa501d142817176b0224655f2491555520def259d4d9a70
-  data.tar.gz: 34c084b5bab53e29995c490d6e2bf0a4a1694cfa473d2c925312d5a628733bbe3b90c2a766ce2403127480abcf4bffc523c1e29b0e633c6c1dcb195e44b3adff
+  metadata.gz: f3a3cf2e72024c75fd8b9ea5cc267fb8bfcfa357136d339511db1bded33ac94cd5b7f8e8666547be881ea8383a885a836ebc3a9a070c92d9b37bd1cba61f6b50
+  data.tar.gz: 0c775f58b4d655b1096f7fe8b7bc715722fb6744f74ce83d2596eb28c058de521be243ac44a362c92c4f014a8a87ccf2faa4c4f5c0ebce4e9e28817834c5bbc8

data/CHANGELOG.md

@@ -5,6 +5,13 @@ This CHANGELOG follows the format located [here](https://github.com/sensu-plugin
 
 ## [Unreleased]
 
+## [2.1.0] - 2018-09-10
+### Added
+- check-azurerm-monitor-metric.rb: allows you to check against azure metric thresholds for a particular resource id or name (@thomaslitton)
+
+### Changed
+- updated `.gemspec` to reflect new url after transfer (@majormoses)
+
 ## [2.0.0] - 2017-12-11
 ### Security
 - updated rubocop dependency to `~> 0.51.0` per: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-8418. (@majormoses)
@@ -77,7 +84,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/2.0.0..HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/2.1.0..HEAD
+[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
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/0.0.5...1.0.0
 [0.0.5]: https://github.com/sensu-plugins/sensu-plugins-azurerm/compare/0.0.4...0.0.5

data/README.md

@@ -26,6 +26,7 @@
  - check-azurerm-virtual-network-gateway-connected.rb
  - check-azurerm-virtual-network-gateway-failover-connected.rb
  - check-azurerm-virtual-networks-usage.rb
+ - check-azurerm-monitor-metric.rb
  - metric-azurerm-service-bus-subscription-message-count.rb
  - metric-azurerm-virtual-network-gateway-usage.rb
 
@@ -51,6 +52,7 @@
 * /bin/check-azurerm-virtual-networks-usage.rb
 * /bin/metric-azurerm-service-bus-subscription-message-count.rb
 * /bin/metric-azurerm-virtual-network-gateway-usage.rb
+* /bin/check-azurerm-monitor-metric.rb
 
 
 ## Usage
@@ -428,6 +430,24 @@
                                           -critical_percentage 90
 ```
 
+**check-azurerm-monitor-metric.rb**
+```
+./check-azurerm-monitor-metric.rb --use-assigned-identity 
+                                  --resource-id "id"
+                                  --metric "metricname"
+                                  --warning 80
+                                  --critical 90
+
+./check-azurerm-monitor-metric.rb --tenant "00000000-0000-0000-0000-000000000000" 
+                                  --client "00000000-0000-0000-0000-000000000000"
+                                  --clientSecret "00000000-0000-0000-0000-000000000000"
+                                  --resource-id "id"
+                                  --metric "metricname"
+                                  --warning-under 80
+                                  --critical-under 50
+
+```
+
 **metric-azurerm-service-bus-subscription-message-count.rb**
 ```
 ./metric-azurerm-service-bus-subscription-message-count.rb

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

@@ -0,0 +1,356 @@
+#! /usr/bin/env ruby
+#
+# check-azurerm-core-usage
+#
+# DESCRIPTION:
+#   Checks an azure monitor metric against thresholds
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   Linux
+#   Windows
+#
+# DEPENDENCIES:
+#   gem: ms_rest_azure
+#   gem: sensu-plugin
+#
+#
+
+require 'ms_rest_azure'
+require 'erb'
+
+require 'sensu-plugin/check/cli'
+require 'sensu-plugins-azurerm'
+
+require 'time'
+require 'net/http'
+
+class CheckAzurermMonitorMetric < Sensu::Plugin::Check::CLI
+  include SensuPluginsAzureRM
+
+  AZURE_API_VER = '2017-05-01-preview'.freeze
+  DATE_FORMAT = '%Y-%m-%dT%H:%M:%S'.freeze
+
+  option :tenant_id,
+         description: 'ARM Tenant ID. Either set ENV[\'ARM_TENANT_ID\'] or provide it as an option',
+         short: '-t ID',
+         long: '--tenant ID',
+         default: ENV['ARM_TENANT_ID']
+
+  option :client_id,
+         description: 'ARM Client ID. Either set ENV[\'ARM_CLIENT_ID\'] or provide it as an option',
+         short: '-i ID',
+         long: '--client ID',
+         default: ENV['ARM_CLIENT_ID']
+
+  option :client_secret,
+         description: 'ARM Client Secret. Either set ENV[\'ARM_CLIENT_SECRET\'] or provide it as an option',
+         short: '-s SECRET',
+         long: '--clientSecret SECRET',
+         default: ENV['ARM_CLIENT_SECRET']
+
+  option :use_assigned_identity,
+         description: 'Use Managed Service Identity (MSI) for authentication.',
+         short: '-l',
+         long: '--use-assigned-identity',
+         boolean: true,
+         default: false
+
+  option :local_auth_port,
+         description: 'Port used to authenticate when using the local identity via Managed Service Identity (MSI)',
+         short: '-o PORT',
+         long: '--local-auth-port PORT',
+         proc: proc(&:to_i),
+         default: 50_342
+
+  option :assigned_identity_resource,
+         description: 'The resource to use when retrieving credentials.  Only used if the --use-assigned-identity option is used.',
+         short: '-u RESOURCE_URL',
+         long: '--assigned-identity-resource',
+         default: 'https://management.azure.com/'
+
+  option :subscription_id,
+         description: 'ARM Subscription ID',
+         short: '-S ID',
+         long: '--subscription ID',
+         default: ENV['ARM_SUBSCRIPTION_ID']
+
+  option :resource_name,
+         description:  'The name of the resource.  If given, the resource namespace/type/group along with subscription id are also required.',
+         short: '-e NAME',
+         long: '--resource-name NAME',
+         default: ''
+
+  option :resource_type,
+         description: 'Resource Type.  If specified, the resource should contain the name and not the full id, and the ' \
+                      'resource namespace/group and subscriptions are also required. Note:  This should not contain the ' \
+                      'namespace.  Use --resource-namespace instead.',
+         short: '-y NAME',
+         long: '--resource-type NAME',
+         default: ''
+
+  option :resource_namespace,
+         description: 'Resource Namespace.  If specified, the resource should contain the name and not the full id, and the resource namespace/group and subscriptions are also required.',
+         short: '-n NAME',
+         long: '--resource-namespace NAME',
+         default: ''
+
+  option :resource_group,
+         description: 'Resource Group.  If specified, the resource should contain the name and not the full id, and the resource namespace/group and subscriptions are also required.',
+         short: '-g NAME',
+         long: '--resource-group NAME',
+         default: ''
+
+  option :resource_parent,
+         description: 'Resource Parent.',
+         short: '-p NAME',
+         long: '--resource-parent NAME',
+         default: ''
+
+  # example id: /subscriptions/576b7196-d42b-4b63-b696-af3ff33269a7/resourceGroups/test-group-1/providers/Microsoft.Network/virtualNetworkGateways/test-gateway
+  option :resource_id,
+         description:  'The full id of the resource.  If given, the resource namespace/type/group along with subscription id are ignored.',
+         short: '-r ID',
+         long: '--resource-id ID',
+         default: ''
+
+  option :metric,
+         description:  'The name of the metric',
+         short: '-m ID',
+         long: '--metric ID',
+         required: true
+
+  option :filter,
+         description:  "The filter applied to the metric.  See Azure docs for the syntax.  Note: This can be used to segment the return by dimensions, so that the script checks each dimension separately. eg APIName eq '*'",
+         short: '-f FILTER',
+         long: '--filter FILTER'
+
+  option :aggregation,
+         description:  'Aggregation.  This can be Average, Count, Maximum, Minimum, Total',
+         short: '-a aggregation',
+         long: '--aggregation aggregation',
+         default: 'average'
+
+  option :warning_over,
+         description: 'The warning threshold to check if the metric is forecasted to go over.',
+         short: '-w N',
+         long: '--warning WARN',
+         proc: proc { |val| val.to_i }
+
+  option :critical_over,
+         description: 'The critical threshold to check if the metric is forecasted to go over.',
+         short: '-c N',
+         long: '--critical CRIT',
+         proc: proc { |val| val.to_i }
+
+  option :warning_under,
+         description: 'The warning threshold to check if the metric is forecasted to go under.',
+         short: '-W N',
+         long: '--warning-under WARN',
+         proc: proc { |val| val.to_i }
+
+  option :critical_under,
+         description: 'The critical threshold to check if the metric is forecasted to go under.',
+         short: '-C N',
+         long: '--critical-under CRIT',
+         proc: proc { |val| val.to_i }
+
+  option :base_url,
+         description: 'The Azure resource API URL.',
+         short: '-b URL',
+         long: '--base-url URL',
+         default: 'https://management.azure.com',
+         proc: proc { |val| val.chomp('/') }
+
+  option :lookback_period,
+         description:  'The amount of time (in seconds) from the current time to look back when retrieving the metric.  This should be long enough to capture the last value submitted.',
+         short: '-k PERIOD',
+         long: '--look-back-period PERIOD',
+         default: 600, # 10 min.  This should generally be enough time to capture the last value, without wasting API credits
+         proc: proc { |val| val.to_i }
+
+  def run
+    check_missing_resource_info
+
+    if !config[:critical_over] && !config[:warning_over] && !config[:critical_under] && !config[:warning_under]
+      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]}"
+        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'
+      end
+    end
+  end
+
+  def check_missing_resource_info
+    return_missing_resource if missing_resource_id? && missing_resource_name_info?
+  end
+
+  def missing_resource_id?
+    config[:resource_id].to_s.empty?
+  end
+
+  def missing_resource_name_info?
+    config[:resource_name].to_s.empty? ||
+      config[:resource_type].to_s.empty? ||
+      config[:resource_namespace].to_s.empty? ||
+      config[:resource_group].to_s.empty? ||
+      config[:subscription_id].to_s.empty?
+  end
+
+  def return_missing_resource
+    unknown(
+      "Either the resource id is required OR the resource name, resource group, resource namepsace, resource type and subscription id are required.\n"\
+      "Resource id: #{config[:resource_id]}\n"\
+      "Resource Info:\n"\
+      "Name: #{config[:resource_name]}\n"\
+      "Group: #{config[:resource_group]}\n"\
+      "Namespace: #{config[:resource_namespace]}\n"\
+      "Type: #{config[:resource_type]}\n"\
+      "Subscription ID: #{config[:subscription_id]}"
+    )
+  end
+
+  def last_metric_values
+    @last_metric_values ||= find_last_metric_values
+  end
+
+  def find_last_metric_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].reverse_each do |metric_value|
+          if metric_value[metric_value_key]
+            values << {
+              value: metric_value[metric_value_key].to_f,
+              metric_name: name
+            }
+
+            break
+          end
+        end
+      end
+    end
+
+    values
+  end
+
+  def metric_value_key
+    config[:aggregation].to_sym
+  end
+
+  def metric_response
+    auth_header = if config[:use_assigned_identity]
+                    uri = URI.parse("http://localhost:#{config[:local_auth_port]}/oauth2/token?resource=#{config[:assigned_identity_resource]}")
+
+                    res = Net::HTTP.start(uri.host, uri.port, use_ssl: false) do |http|
+                      req = Net::HTTP::Get.new(uri)
+                      req['Metadata'] = 'true'
+                      http.request(req)
+                    end
+
+                    handle_response(res)
+
+                    auth_resp = JSON.parse(res.body, symbolize_names: true)
+
+                    "#{auth_resp[:token_type]} #{auth_resp[:access_token]}"
+                  else
+                    provider = MsRestAzure::ApplicationTokenProvider.new(
+                      config[:tenant_id],
+                      config[:client_id],
+                      config[:client_secret]
+                    )
+
+                    provider.get_authentication_header
+                  end
+
+    begin
+      url = "#{config[:base_url]}#{resource}/providers/microsoft.insights/metrics?" \
+        "api-version=#{AZURE_API_VER}&" \
+        "metric=#{config[:metric]}&" \
+        "timespan=#{CGI.escape(timespan)}&" \
+        "aggregation=#{config[:aggregation]}"
+
+      url += "&$filter=#{CGI.escape(config[:filter])}" if config[:filter]
+
+      uri = URI.parse(url)
+
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        req = Net::HTTP::Get.new(uri)
+        req['Authorization'] = auth_header
+        req['Content-Type'] = 'application/json'
+        http.request(req)
+      end
+    rescue Timeout::Error,
+           Errno::EINVAL, Errno::ECONNRESET,
+           EOFError, Net::HTTPBadResponse,
+           Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+           Errno::ECONNREFUSED => e
+
+      critical e
+    end
+
+    handle_response(res)
+
+    JSON.parse(res.body, symbolize_names: true)
+  end
+
+  def resource
+    @resource ||= build_resource
+  end
+
+  def build_resource
+    if !config[:resource_id].to_s.empty?
+      config[:resource_id].start_with?('/') ? config[:resource_id] : '/' + config[:resource_id]
+    else
+      "/subscriptions/#{config[:subscription_id]}/resourceGroups/#{config[:resource_group]}/" \
+        "providers/#{resource_type}/#{config[:resource_name]}"
+    end
+  end
+
+  def resource_type
+    if config[:resource_parent].to_s.empty?
+      "#{config[:resource_namespace]}/#{config[:resource_type]}"
+    else
+      "#{config[:resource_namespace]}/#{config[:resource_parent]}/#{config[:resource_type]}"
+    end
+  end
+
+  def timespan
+    start_date = Time.now.utc - config[:lookback_period]
+    end_date = Time.now.utc
+    "#{start_date.strftime(DATE_FORMAT)}/#{end_date.strftime(DATE_FORMAT)}"
+  end
+
+  def handle_response(res)
+    critical "Failed to get metric:\n#{res.body}" if res.code.to_i >= 300
+  end
+end

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

@@ -1,7 +1,7 @@
 module SensuPluginsAzureRM
   module Version
     MAJOR = 2
-    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: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tom Harvey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_compute
@@ -198,6 +198,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +282,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -285,27 +313,28 @@ dependencies:
 description: This plugin provides checks for Microsoft Azure's Resource Manager service.
 email: "<github@ibuildstuff.co.uk>"
 executables:
-- check-azurerm-static-public-ip-addresses-usage.rb
+- check-azurerm-network-security-groups-usage.rb
 - check-azurerm-cores-ds-usage.rb
-- check-azurerm-service-bus-subscription.rb
-- check-azurerm-load-balancers-usage.rb
-- check-azurerm-network-interfaces-usage.rb
+- check-azurerm-virtual-network-gateway-connected.rb
 - check-azurerm-route-tables-usage.rb
-- check-azurerm-cores-d-usage.rb
+- check-azurerm-cores-dsv2-usage.rb
+- metric-azurerm-service-bus-subscription-message-count.rb
+- check-azurerm-monitor-metric.rb
+- check-azurerm-virtual-networks-usage.rb
 - check-azurerm-service-bus-topic-size.rb
 - check-azurerm-core-usage.rb
-- check-azurerm-cores-dsv2-usage.rb
 - check-azurerm-virtual-network-gateway-failure-connected.rb
 - check-azurerm-virtual-machines-usage.rb
-- metric-azurerm-service-bus-subscription-message-count.rb
+- check-azurerm-public-ip-addresses-usage.rb
+- check-azurerm-service-bus-subscription.rb
 - metric-azurerm-virtual-network-gateway-usage.rb
-- check-azurerm-virtual-networks-usage.rb
 - check-azurerm-cores-fs-usage.rb
-- check-azurerm-network-security-groups-usage.rb
+- check-azurerm-static-public-ip-addresses-usage.rb
+- check-azurerm-cores-d-usage.rb
 - check-azurerm-cores-f-usage.rb
-- check-azurerm-public-ip-addresses-usage.rb
 - check-azurerm-cores-dv2-usage.rb
-- check-azurerm-virtual-network-gateway-connected.rb
+- check-azurerm-load-balancers-usage.rb
+- check-azurerm-network-interfaces-usage.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -320,6 +349,7 @@ files:
 - bin/check-azurerm-cores-f-usage.rb
 - bin/check-azurerm-cores-fs-usage.rb
 - bin/check-azurerm-load-balancers-usage.rb
+- bin/check-azurerm-monitor-metric.rb
 - bin/check-azurerm-network-interfaces-usage.rb
 - bin/check-azurerm-network-security-groups-usage.rb
 - bin/check-azurerm-public-ip-addresses-usage.rb
@@ -339,7 +369,7 @@ files:
 - lib/sensu-plugins-azurerm/network_usage.rb
 - lib/sensu-plugins-azurerm/servicebus_usage.rb
 - lib/sensu-plugins-azurerm/version.rb
-homepage: https://github.com/tombuildsstuff/sensu-plugins-azurerm
+homepage: https://github.com/sensu-plugins/sensu-plugins-azurerm
 licenses:
 - MIT
 metadata:
@@ -365,7 +395,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for working with an Azure Resource Manager environment