tombuildsstuff/sensu-plugins-azurerm

View on GitHub
bin/check-azurerm-cores-d-usage.rb

Summary

Maintainability
B
5 hrs
Test Coverage
#! /usr/bin/env ruby
# frozen_string_literal: true

#
# check-azurerm-cores-d-usage
#
# DESCRIPTION:
#   This plugin checks the number of D Family CPU Cores allocated and available in a Region in Azure.
#   Warning and Critical Percentage thresholds may be set as needed.
#
# OUTPUT:
#   plain-text
#
# PLATFORMS:
#   Linux
#
# DEPENDENCIES:
#   gem: azure_mgmt_compute
#   gem: sensu-plugin
#
# USAGE:
#   ./check-azurerm-cores-d-usage.rb -l "westeurope" -w 80 -c 90
#
#   ./check-azurerm-cores-d-usage.rb -t "00000000-0000-0000-0000-000000000000"
#                                    -c "00000000-0000-0000-0000-000000000000"
#                                    -S "00000000-0000-0000-0000-000000000000"
#                                    -s "1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678901234"
#                                    -l "eastus2" -w 80 -c 90
#
#   ./check-azurerm-cores-d-usage.rb -tenant "00000000-0000-0000-0000-000000000000"
#                                    -client_id "00000000-0000-0000-0000-000000000000"
#                                    -client_secret "00000000-0000-0000-0000-000000000000"
#                                    -subscription "1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678901234"
#                                    -location "westeurope"
#                                    -warning_percentage 80
#                                    -critical_percentage 90
#
# NOTES:
#
# LICENSE:
#   Tom Harvey
#   Released under the same terms as Sensu (the MIT license); see LICENSE
#   for details.
#

require 'azure_mgmt_compute'
require 'sensu-plugin/check/cli'
require 'sensu-plugins-azurerm'

class CheckAzureRMCoresDUsage < Sensu::Plugin::Check::CLI
  include SensuPluginsAzureRM

  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'] # TODO: can we pull these out from the Check too?

  option :client_id,
         description: 'ARM Client ID. Either set ENV[\'ARM_CLIENT_ID\'] or provide it as an option',
         short: '-c 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 :subscription_id,
         description: 'ARM Subscription ID',
         short: '-S ID',
         long: '--subscription ID',
         default: ENV['ARM_SUBSCRIPTION_ID']

  option :location,
         description: 'Azure Location (e.g. westeurope/eastus2)',
         short: '-l LOCATION',
         long: '--location LOCATION'

  option :warning_percentage,
         description: 'Warning Percentage threshold for filter',
         short: '-w PERCENTAGE',
         long: '--warning PERCENTAGE'

  option :critical_percentage,
         description: 'Critical Percentage threshold for filter',
         short: '-c PERCENTAGE',
         long: '--critical PERCENTAGE'

  def run
    tenant_id = config[:tenant_id]
    client_id = config[:client_id]
    client_secret = config[:client_secret]
    subscription_id = config[:subscription_id]
    location = config[:location]

    usage_client = ComputeUsage.new.build_usage_operation_client(tenant_id, client_id, client_secret, subscription_id)
    result = Common.new.retrieve_usage_stats(usage_client, location, 'standardDFamily')

    current_usage = result.current_value
    allowance = result.limit
    critical_percentage = config[:critical_percentage].to_f
    warning_percentage = config[:warning_percentage].to_f

    message = "Current usage: #{current_usage} of #{allowance} D Family Cores"

    percentage_used = (current_usage.to_f / allowance) * 100

    if percentage_used >= critical_percentage
      critical message
    elsif percentage_used >= warning_percentage
      warning message
    else
      ok message
    end
  rescue StandardError => e
    puts "Error: exception: #{e}"
    critical
  end
end