sensu-plugins-azure-acr-quota-metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b49ab9898831886478e7926e98ba3cff9670c501
+  data.tar.gz: e75d3eb336f904d744e8d18294e2f8a4d2bf41bc
+SHA512:
+  metadata.gz: 63436eae04f92fdd110695d76bf02a4213812642d14beba38c45ac4cb12618ae1c28843c9bbf88aff0f52ffd584e58f77fb9b23b1a6a4a9881ec59397212b148
+  data.tar.gz: 4877afed2d10cda46d9f0df149b2ac342f2b5947b53f6d6688a472d8df4f6c7de51acb8eca76dc17729c520ad763223049d100d5436455d00144276d11334da6

data/README.md

@@ -0,0 +1,29 @@
+Sensu Plugins Azure ACR Quota Metrics
+=====================================
+
+[![Build Status](https://travis-ci.org/ElvenSpellmaker/sensu-plugins-azure-acr-quota-metrics.svg?branch=master)](https://travis-ci.org/ElvenSpellmaker/sensu-plugins-azure-acr-quota-metrics) [![Gem Version](https://badge.fury.io/rb/sensu-plugins-azure-acr-quota-metrics.svg)](https://badge.fury.io/rb/sensu-plugins-azure-acr-quota-metrics)
+
+This is a hacky Sensu plug-in to call out to the `az` to list all ACRs (Azure
+Container Registries) in a subscription and get quota usage metrics.
+
+Note: Quota metrics are only available for 'managed' ACRs, and so the `Classic`
+sku is ignored.
+
+The gem assumes `virualenv`, `python` and `pip` are installed, and will run
+`install.bash` as a pre-gem hook to install a virualenv and the required `az`
+command. Ick.
+
+Tested on Ruby 2.3.
+
+The unit test is a bit dubious, and it's almost impossible to run unit tests on
+Sensu plug-ins as they run as soon as scoped...
+The test must be run from the root directory also.
+
+`bundle exec rspec` should run the test, after bundle installing of course.
+
+Why call out to `az` instead of using the Ruby SDK?
+---------------------------------------------------
+There's very little documentation and this was the path of least resistance.
+
+I'm open to re-writes which use the Ruby Gems instead. You'll need the
+`azure_mgmt_compute` and `azure_mgmt_monitor` gems.

data/bin/sensu-plugins-azure-acr-quota-metrics.rb

@@ -0,0 +1,87 @@
+#! /usr/bin/env ruby
+
+require 'json'
+require 'parallel'
+require 'sensu-plugin/metric/cli'
+require 'time'
+
+class AzureAcrQuotaMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :schema,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: 'sensu'
+
+  option :spn_id,
+         description: 'The SPN ID with read access to the subscription',
+         short: '-i',
+         long: '--spn-id <SPN ID>',
+         default: nil
+
+  option :spn_secret,
+         description: 'The SPN secret for the SPN ID',
+         short: '-p',
+         long: '--spn-secret <SPN Secret>',
+         default: nil
+
+  option :tenant_id,
+         description: 'The Tenant ID for the SPN ID',
+         short: '-t',
+         long: '--tenant-id <Tenant ID>',
+         default: nil
+
+  @@time_format = '%Y-%m-%dT%H:%M:%SZ'
+  @@classic_sku = 'Classic'
+
+  def initialize(argv = ARGV, metrics_client = 'az')
+    super argv
+
+    dir = __FILE__ === '(eval)' ? '.' : "#{__dir__}/../"
+    require "#{dir}/lib/provider/#{metrics_client}.rb"
+    metrics_upper = metrics_client.capitalize
+    @metrics_client = Object.const_get("#{metrics_upper}Client").new
+  end
+
+  def run
+    @metrics_client.set_credentials(
+      config[:spn_id],
+      config[:spn_secret],
+      config[:tenant_id],
+  )
+
+    time = Time.now.utc
+
+    container_registries = @metrics_client.acr_list
+
+    Parallel.map(container_registries, in_threads: 5) { |acr|
+      # Classic ACR doesn't have a quota as it's 'unmanaged' (it's as large as
+      # the storage account is).
+      next if acr['sku']['tier'] == @@classic_sku
+
+      process_acr(acr, time)
+    }
+
+    ok
+  end
+
+private
+
+  def process_acr(acr, time)
+    acr_name = acr['name']
+    acr_resource_group = acr['resourceGroup']
+
+    usage_metrics = @metrics_client.acr_show_usage(acr_name, acr_resource_group)
+
+    usage_metrics['value'].each { |metric_dimension|
+      next if metric_dimension['name'] != @metrics_client.quota_metrics_type
+
+      current_quota = metric_dimension['currentValue']
+      remaining_quota = metric_dimension['limit'] - current_quota
+
+      output [config[:schema], acr_name, 'used'].join('.'), current_quota, time.to_i
+      output [config[:schema], acr_name, 'remaining'].join('.'), remaining_quota, time.to_i
+
+      break
+    }
+  end
+end

data/install.bash

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+if [ "$TRAVIS" = true ]; then
+	echo "This is Travis, don't pre-install \`az\`... Exiting 0..."
+	exit 0
+fi
+
+ENV_DIR="/az-python"
+
+check_error()
+{
+	if [ $1 -ne 0 ]; then
+		echo 'Failed to install!' >&2
+		exit $1
+	fi
+}
+
+AZ_PACKAGE='azure-cli'
+AZ_VERSION='2.0.31'
+
+if [ -f "$ENV_DIR/bin/activate" ]; then
+	. "$ENV_DIR/bin/activate"
+	if [ "$(pip freeze | grep -oP "$AZ_PACKAGE"'==\K.*')" == "$AZ_VERSION" ]; then
+		echo '`az` is already installed in the virtualenv at the correct version!'
+		exit 0
+	fi
+fi
+
+virtualenv $ENV_DIR
+check_error $?
+
+. $ENV_DIR/bin/activate
+check_error $?
+
+pip install --upgrade 'pip==10.0.1'
+check_error $?
+# `azure-cli` will actually replace wheel with this version...
+pip install --upgrade 'wheel==0.30.0'
+check_error $?
+pip install --upgrade 'setuptools==39.0.1'
+check_error $?
+pip install --upgrade "$AZ_PACKAGE==$AZ_VERSION"
+check_error $?

data/lib/provider/az.bash

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+ENV_DIR="/az-python"
+
+while getopts c:i:p:t: option
+do
+	case "${option}"
+	in
+		c) AZ_COMMAND=${OPTARG};;
+		i) SPN_ID=${OPTARG};;
+		p) SPN_SECRET=${OPTARG};;
+		t) TENANT_ID=${OPTARG};;
+	esac
+done
+
+. $ENV_DIR/bin/activate &> /dev/null
+
+az login --service-principal -u "$SPN_ID" -p "$SPN_SECRET" --tenant "$TENANT_ID" &> /dev/null
+
+eval az $AZ_COMMAND

data/lib/provider/az.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+require 'json'
+
+class AzClient < BaseClient
+  def acr_list
+    az('acr list')
+  end
+
+  def acr_show_usage(acr_name, acr_resource_group)
+    az("acr show-usage -g #{acr_resource_group} -n #{acr_name}")
+  end
+
+private
+
+  def az(command)
+    az_output = %x(#{__dir__}/az.bash -c "#{command}" -i "#{@spn_id}" -p "#{@spn_secret}" -t "#{@tenant_id}")
+    JSON.parse(az_output)
+  end
+end

data/lib/provider/base.rb

@@ -0,0 +1,18 @@
+class BaseClient
+  @@quota_metrics_type = 'Size'.freeze
+
+  def set_credentials(spn_id = nil, spn_secret = nil, tenant_id = nil)
+    @spn_id = spn_id
+    @spn_secret = spn_secret
+    @tenant_id = tenant_id
+  end
+
+  def quota_metrics_type
+    @@quota_metrics_type
+  end
+
+  def quota_metrics_felds
+    @@quota_metrics_fields
+  end
+
+end

data/lib/provider/file.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+require 'json'
+
+class FileClient < BaseClient
+  def acr_list
+    file_get_contents('spec/acr_list.json')
+  end
+
+  def acr_show_usage(acr_name, acr_resource_group)
+    file_get_contents('spec/acr_show_usage.json')
+  end
+
+  private
+
+  def file_get_contents(file_name)
+    JSON.parse(File.open(file_name, 'r') { |file| file.read })
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,5 @@
+Gem.pre_install do
+  %x(#{File.dirname(__FILE__) + '/../install.bash'})
+
+  $?.success?
+end

data/lib/sensu-plugins-azure-acr-quota-metrics/version.rb

@@ -0,0 +1,9 @@
+module SensuPluginsAzureAcrQuotaMetrics
+  class Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-azure-acr-quota-metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A hacky Sensu plug-in to provide ACR Quota metrics by calling out to
+  `az`
+email: 
+executables:
+- sensu-plugins-azure-acr-quota-metrics.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/sensu-plugins-azure-acr-quota-metrics.rb
+- install.bash
+- lib/provider/az.bash
+- lib/provider/az.rb
+- lib/provider/base.rb
+- lib/provider/file.rb
+- lib/rubygems_plugin.rb
+- lib/sensu-plugins-azure-acr-quota-metrics/version.rb
+homepage: https://github.com/ElvenSpellmaker/sensu-plugins-azure-acr-quota-metrics
+licenses:
+- MIT
+metadata:
+  maintainer: "@ElvenSpellmaker"
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Sensu metrics plugin for Azure Container Registry Quota Metrics
+test_files: []