sensu-plugins-aws 12.0.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31017c7ec95b3c63fff718e67a620586aff45b234b9d498f14e48862e3362df3
-  data.tar.gz: 8b87f31b8be52d80bbb42a7159feeefe7cd69fd43588d3a993c825c08ee7bcab
+  metadata.gz: dc08d77c4f4e2d59086492322c080d5796b3ecafcd26965763f441de8b191300
+  data.tar.gz: 3c6d7077935ea918ca4db9bc9844e4ea42e2e62ecf1580e048c5497cc6b51e94
 SHA512:
-  metadata.gz: 4472bf2cee558b964d29815e80f37ea436a15439fb8e7c9ae45bc9376cf798324efe541b82deba3c5dbcf9f11d4ba565695b22398b7223976d4836f1df623051
-  data.tar.gz: 90de7452049ff5025663ba86e71a78ddcab07acbe9a592576b4d0d6a4b30181c6f5afc054fe94c6c72e2d2972691907892f81ec8de3d8156d29b2da10cbd4ca6
+  metadata.gz: 963970d678c9ee70c61184041388f0ccf7ed143c5d67dff4a90dfb71869cd248f248d1057da7119f267bcac6cefd365393bba200f380097c1275e0a23269b88d
+  data.tar.gz: 2053a94ae790488fb04067ec9a59d4b99a1f14e626bd316c00964469cfb38ba30a8be97ea2125e94f212d110c07dcdf3a0f66da88acab7335fc25ac73a4da243

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [12.1.0] - 2018-08-28
+### Added
+- new `check-efs.rb: checks cloudwatch metrics with the efs namespace for an arbitrary metric (@ivanfetch)
+
 ## [12.0.0] - 2018-06-21
 ### Breaking Changes
 - `check-ebs-burst-limit.rb`: Fixed period to pass to config from 60 to 120 so as to not have empty values returned sometimes (@wari)
@@ -490,7 +494,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/12.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/12.1.0...HEAD
+[12.1.0]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/12.0.0...12.1.0
 [12.0.0]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/11.6.0...12.0.0
 [11.6.0]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/11.5.1...11.6.0
 [11.5.1]: https://github.com/sensu-plugins/sensu-plugins-aws/compare/11.5.0...11.5.1

data/README.md

@@ -48,6 +48,8 @@
 
 **check-ecs-service-health.rb**
 
+**check-efs-metric.rb**
+
 **check-eip-allocation.rb**
 
 **check-elasticache-failover.rb**
@@ -173,6 +175,7 @@
 * /bin/check-ec2-filter.rb
 * /bin/check-ec2-network.rb
 * /bin/check-ecs-service-health.rb
+* /bin/check-efs-metric.rb
 * /bin/check-elasticache-failover.rb
 * /bin/check-elb-certs.rb
 * /bin/check-elb-health-fog.rb

data/bin/check-efs-metric.rb

@@ -0,0 +1,145 @@
+#!/usr/bin/env ruby
+#
+# check-efs-metric
+#
+# DESCRIPTION:
+#   This plugin checks a CloudWatch metric from the AWS/EFS namespace
+#   For more details, see https://docs.aws.amazon.com/efs/latest/ug/monitoring-cloudwatch.html#efs-metrics
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: aws-sdk
+#   gem: sensu-plugin
+#
+# USAGE:
+#   ./check-efs-metric -w 25.0 -c 75.0 \
+#   -m PercentIOLimit -o greater -n my-efs-filesystem-name
+#
+# NOTES:
+#
+# LICENSE:
+#   Ivan Fetch
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-aws'
+require 'sensu-plugin/check/cli'
+require 'aws-sdk'
+
+# A Sensu plugin which uses cloudwatch-common to  check EFS CloudWatch metrics
+class EFSMetric < Sensu::Plugin::Check::CLI
+  include Common
+  include CloudwatchCommon
+
+  option :efs_name,
+         description: 'Name of the EFS file system, matching the Name tag',
+         short: '-n VALUE',
+         long: '--name VALUE',
+         proc: proc(&:to_s),
+         required: true
+
+  option :metric_name,
+         description: 'CloudWatch metric in the AWS/EFS namespace: E.G. PercentIOLimit',
+         short: '-m VALUE',
+         long: '--metric VALUE',
+         proc: proc(&:to_s),
+         required: true
+
+  option :statistics,
+         description: 'Statistic to retrieve from CloudWatch: E.G. Minimum or Maximum',
+         short: '-s statistic',
+         long: '--statistic statistic',
+         default: 'Average',
+         proc: proc(&:to_s)
+
+  option :critical,
+         description: 'Return critical when the metric is at this VALUE, also see the --operator option',
+         short: '-c VALUE',
+         long: '--critical VALUE',
+         proc: proc(&:to_f),
+         required: true
+
+  option :warning,
+         description: 'Return warning when the metric is at this VALUE, also see the --operator option',
+         short: '-w VALUE',
+         long: '--warning VALUE',
+         proc: proc(&:to_f)
+
+  option :period,
+         description: 'CloudWatch metric statistics period, in seconds. Must be a multiple   of 60',
+         short: '-p VALUE',
+         long: '--period VALUE',
+         default: 60,
+         proc: proc(&:to_i)
+
+  option :compare,
+         description: 'Comparison operator for critical and warning thresholds: equal, not, greater, less',
+         short: '-o OPERATOR',
+         long: '--operator OPERATOR',
+         default: 'less'
+
+  option :unit,
+         description: 'CloudWatch metric unit, to be passed to the metrics request',
+         short: '-u UNIT',
+         long: '--unit UNIT'
+
+  option :no_data_ok,
+         description: 'Returns ok if no data is returned from the metric',
+         short: '-O',
+         long: '--allow-no-data',
+         boolean: true,
+         default: false
+
+  option :no_efs_ok,
+         description: 'Returns ok if the EFS file system specified by the -n option can not be found: This is useful if using a check in multiple environments where a file system may not always exist',
+         short: '-N',
+         long: '--allow-no-efs',
+         boolean: true,
+         default: false
+
+  option :aws_region,
+         description: 'AWS region',
+         short: '-r Region',
+         long: '--region REGION',
+         default: 'us-east-1'
+
+  # This is used by CloudwatchCommon to display the description for what is being checked.
+  def metric_desc
+    "#{config[:metric_name]} for #{config[:efs_name]}"
+  end
+
+  def run
+    config[:namespace] = 'AWS/EFS'
+    found_efs = false
+
+    efs = Aws::EFS::Client.new
+    filesystems = efs.describe_file_systems
+    filesystems.file_systems.each do |filesystem|
+      # Once Ruby < ver 2.4 is not supported, change this to:
+      # if filesystem.name.casecmp?(config[:efs_name])
+      # See : https://ruby-doc.org/core-2.4.0/String.html#method-i-casecmp
+      if filesystem.name.casecmp(config[:efs_name]).zero?
+        found_efs = true
+        config[:dimensions] = []
+        config[:dimensions] << { name: 'FileSystemId', value: filesystem.file_system_id }
+        check config
+      end
+    end
+
+    # rubocop:disable Style/GuardClause
+    unless found_efs
+      if config[:no_efs_ok]
+        ok "EFS file system #{config[:efs_name]} was not found in region #{config[:aws_region]} but that's ok"
+      else
+        critical "EFS file system #{config[:efs_name]} was not found in region #{config[:aws_region]}"
+      end
+    end
+    # rubocop:enable Style/GuardClause
+  end
+end

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

@@ -1,7 +1,7 @@
 module SensuPluginsAWS
   module Version
     MAJOR = 12
-    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-aws
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -277,6 +277,7 @@ executables:
 - check-ec2-filter.rb
 - check-ec2-network.rb
 - check-ecs-service-health.rb
+- check-efs-metric.rb
 - check-eip-allocation.rb
 - check-elasticache-failover.rb
 - check-elb-certs.rb
@@ -361,6 +362,7 @@ files:
 - bin/check-ec2-filter.rb
 - bin/check-ec2-network.rb
 - bin/check-ecs-service-health.rb
+- bin/check-efs-metric.rb
 - bin/check-eip-allocation.rb
 - bin/check-elasticache-failover.rb
 - bin/check-elb-certs.rb