zabbix-cloudwatch 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA1: 
-  metadata.gz: df87bd47ab6fdee6de4d821369699e3f6d07aea0
-  data.tar.gz: 6dfa76015b98cd65c7bd09b4e1fc388fc0b295bc
 SHA512: 
-  metadata.gz: 1cabb7234ad5dd2c225cfa376f40a821c4ca5b01b77b09db811fcf65dbe135f606b2102f737c4fdaa946352ded5e34364a94c390b844ffcd12aa8ebeb95af624
-  data.tar.gz: ed410290939f9081a8ea2a978941303d96b8c03dd1d4e5e99d887e9387ff5fb971a693af894f0954a885eeb2e649880760134d3426cb9698d0d07b9f0014cd06
+  metadata.gz: 668006ca05ddcdb72c2be727e55fd9ca3f02436b55ad05d79188bceb689d8c6abd612ab8eed200a40d1485ae191ac505be1293ff3747b494f17573d4aeba9738
+  data.tar.gz: 50b14743250d4aa4fa48a9b217039225e29157daa2024da499f6ef29a13f80c8ed1ae68b78757bace3977e22d4d3c1bb9e53246f585c377e4b38591c7a98f724
+SHA1: 
+  metadata.gz: 53a2da88f161acb42a0b710ba66e2fc2ecadb86c
+  data.tar.gz: 7d8cc21d6177256adf7e29f002f1c73f7a88b3ed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zabbix-cloudwatch (0.0.4)
+    zabbix-cloudwatch (0.0.5)
       aws-sdk (~> 1.21.0)
       getopt (~> 1.4.1)
 
@@ -12,13 +12,23 @@ GEM
       json (~> 1.4)
       nokogiri (>= 1.4.4, < 1.6.0)
       uuidtools (~> 2.1)
+    diff-lcs (1.2.4)
     getopt (1.4.1)
     json (1.8.0)
     nokogiri (1.5.10)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
     uuidtools (2.1.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rspec
   zabbix-cloudwatch!

data/README.md

@@ -1,5 +1,6 @@
 # zabbix-cloudwatch
 
+[![Gem Version](https://badge.fury.io/rb/zabbix-cloudwatch.png)](http://badge.fury.io/rb/zabbix-cloudwatch)
 
 An external script for getting cloudwatch metrics into Zabbix
 
@@ -15,7 +16,7 @@ Usage: zabbix-cloudwatch
   -s, --statistic         Minimum|Maximum|Average|Sum|SampleCount   Default: Average
   --aws-access-key        AWS Access Key
   --aws-secret-key        AWS Secret Key
-  --aws-region            AWS Region (us-east-1)                    Default: us-east-1
+  --aws-region            AWS Region                                Default: us-east-1
 ```
 
 ## Getting it running
@@ -24,15 +25,15 @@ Usage: zabbix-cloudwatch
 * for some of the gem dependencies, you will need the ruby development packages, gcc, libxml2, and libxslt
 
 Modify these steps to taste (examples given running on the Amazon AMI 2013.03):
-```
-# yum install ruby ruby-devel rubygems gcc libxml2-devel libxslt-devel
-# gem install bundler zabbix-cloudwatch
-# ln -s $(which zabbix-cloudwatch) /var/lib/zabbixsrv/externalscripts/zabbix-cloudwatch
+```bash
+yum install ruby ruby-devel rubygems gcc libxml2-devel libxslt-devel
+gem install bundler zabbix-cloudwatch
+ln -s $(which zabbix-cloudwatch) /var/lib/zabbixsrv/externalscripts/zabbix-cloudwatch
 ```
 
 ## Examples
 
-```
+```bash
 zabbix-cloudwatch -n AWS/EC2 \
                   -m CPUUtilization \
                   -d AutoScalingGroupName \
@@ -58,7 +59,7 @@ There are (3) ways to get your AWS Credentials into `zabbix-cloudwatch`.
 permissions.**
 
 ### 1. Environment Variables (which is difficult with Zabbix):
-```
+```bash
 export AWS_ACCESS_KEY_ID="YOUR ACCESS KEY" 
 export AWS_SECRET_ACCESS_KEY="YOUR SECRET ACCESS KEY"
 export AWS_REGION="YOUR AWS REGION"
@@ -66,13 +67,38 @@ export AWS_REGION="YOUR AWS REGION"
 
 ### 2. Within the binary in the gem.  
 
-Find it with `which zabbix-cloudwatch`.  If you intend to do it this way, I suggest you make a copy of the binary
+If you intend to do it this way, I suggest you make a copy of the binary
 and place it in your zabbix externalscript path (instead of the suggested symlink in the installation example).
 
+Find the binary like this:
+
+```bash
+ls $(gem env gemdir)/gems/zabbix-cloudwatch-$(zabbix-cloudwatch --version)/bin/zabbix-cloudwatch
+```
+
+And place it in your externalscripts path like this (your zabbix path/user/group may be different):
+
+```bash
+cp $(gem env gemdir)/gems/zabbix-cloudwatch-$(zabbix-cloudwatch --version)/bin/zabbix-cloudwatch \
+      /var/lib/zabbixsrv/externalscripts/
+chown zabbix:zabbix /var/lib/zabbixsrv/externalscripts/zabbix-cloudwatch
+```
+
 The class variables for this are at the very top of the file for your convenience.
 
 ### 3. Passing in your AWS Keys when you run zabbix-cloudwatch using the command line flags.
 
+```bash
+zabbix-cloudwatch -n AWS/AutoScaling \
+                  -m GroupInServiceInstances \
+                  -d AutoScalingGroupName \
+                  -v your-auto-scaling-group \
+                  --aws-access-key 'YOUR ACCESS KEY' \
+                  --aws-secret-key 'YOUR SECRET KEY' \
+                  --aws-region 'YOUR AWS REGION'
+```
+## Order of preference
+
 The order of preference that this gem uses for the region and keys (individually) are:
 
 * Commandline flag

data/bin/zabbix-cloudwatch

@@ -46,7 +46,7 @@ Usage: #{$0}
   -s, --statistic         Minimum|Maximum|Average|Sum|SampleCount   Default: Average
   --aws-access-key        AWS Access Key
   --aws-secret-key        AWS Secret Key
-  --aws-region            AWS Region (us-east-1)                    Default: us-east-1
+  --aws-region            AWS Region                                Default: us-east-1
 
 EOF
   exit 1
@@ -69,7 +69,7 @@ unless opts.key?"aws-secret-key"
   opts["aws-secret-key"] = (@@aws_secret_key == '' && ENV["AWS_SECRET_ACCESS_KEY"]) || @@aws_secret_key
 end
 unless opts.key?"aws-region"
-  opts["aws-region"] = (@@aws_region     == '' && ENV["AWS_REGION"])            || @@aws_region
+  opts["aws-region"] =     (@@aws_region     == '' && ENV["AWS_REGION"])            || @@aws_region
 end
 
 inst = ZabbixCloudwatch::GetCloudwatchMetric.new(opts)

data/lib/zabbix-cloudwatch/version.rb

@@ -1,4 +1,4 @@
 
 module ZabbixCloudwatch
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/zabbix-cloudwatch.rb

@@ -14,7 +14,7 @@ module ZabbixCloudwatch
   
     attr_accessor :options, :aws, :start_time, :end_time, :period, :statistic
   
-    def initialize options
+    def initialize options = {}
       self.options = options
       usage if options.key?"help"
       raise NamespaceArgumentMissingException unless options.key?"namespace"
@@ -22,9 +22,6 @@ module ZabbixCloudwatch
       raise DimensionArgumentMissingException unless options.key?"dimension-name"
       raise DimensionArgumentMissingException unless options.key?"dimension-value"
       self.aws = AWS::CloudWatch.new(get_aws_options).client
-      test_aws_connectivity
-      set_time_range
-      set_statistic
     end
 
     def get_aws_options
@@ -35,7 +32,6 @@ module ZabbixCloudwatch
       else
         region = 'us-east-1'
       end
-      puts options.inspect
       {:access_key_id => options["aws-access-key"], :secret_access_key => options["aws-secret-key"], :region => region}
     end
   
@@ -87,6 +83,9 @@ module ZabbixCloudwatch
     end
   
     def run!
+      test_aws_connectivity
+      set_time_range
+      set_statistic
       ret = aws.get_metric_statistics({
               :namespace => options["namespace"],
               :metric_name => options["metricname"],

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'zabbix-cloudwatch'
+

data/spec/zabbix-cloudwatch/zabbix-cloudwatch_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+require 'date'
+
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  fake.string
+end
+
+module ZabbixCloudwatch
+  describe GetCloudwatchMetric do
+    describe "#new" do
+      it "Raises NamespaceArgumentMissingException when options are empty" do
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new}.should raise_error GetCloudwatchMetric::NamespaceArgumentMissingException
+      end
+      it "Raises NamespaceArgumentMissingException when there is no namespace key in the options" do
+        options = {}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::NamespaceArgumentMissingException
+      end
+      it "Raises MetricnameArgumentMissingException when there is no metricname key in the options" do
+        options = {"namespace" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::MetricnameArgumentMissingException
+      end
+      it "Raises DimensionArgumentMissingException when both dimension keys are not in the options" do
+        options = {"namespace" => '', "metricname" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::DimensionArgumentMissingException
+        options = {"namespace" => '', "metricname" => '', "dimension-name" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::DimensionArgumentMissingException
+        options = {"namespace" => '', "metricname" => '', "dimension-value" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::DimensionArgumentMissingException
+      end
+      it "Raises Exception when aws keys are not in options" do
+        options = {"namespace" => '', "metricname" => '', "dimension-value" => '', "dimension-name" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::AwsAccessKeyMissingException
+        options = {"namespace" => '', "metricname" => '', "dimension-value" => '', "dimension-name" => '', "aws-access-key" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options)}.should raise_error GetCloudwatchMetric::AwsSecretKeyMissingException
+      end
+    end
+    describe "#time_now" do
+      it "Should return an ISO8601 date in UTC" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test'}
+        ZabbixCloudwatch::GetCloudwatchMetric.new(options).time_now.should =~ /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/
+      end
+    end
+    describe "#time_one_minute_ago" do
+      it "Should return an ISO8601 date in UTC" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test'}
+        ZabbixCloudwatch::GetCloudwatchMetric.new(options).time_one_minute_ago.should =~ /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/
+      end
+    end
+    describe "#time_five_minutes_ago" do
+      it "Should return an ISO8601 date in UTC" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test'}
+        ZabbixCloudwatch::GetCloudwatchMetric.new(options).time_five_minutes_ago.should =~ /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/
+      end
+    end
+    describe "#set_time_range" do
+      it "Should set a start_time and end_time that is 450 seconds apart when the monitoring-type is not set" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test'}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        @inst.set_time_range
+        (Time.iso8601(@inst.end_time).to_i - Time.iso8601(@inst.start_time).to_i).should eq(450)
+      end
+      it "Should set a start_time and end_time that is 450 seconds apart when the monitoring-type is set to basic" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test', "monitoring-type" => 'basic'}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        @inst.set_time_range
+        (Time.iso8601(@inst.end_time).to_i - Time.iso8601(@inst.start_time).to_i).should eq(450)
+      end
+      it "Should set a start_time and end_time that is 90 seconds apart when the monitoring-type is set to detailed" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test', "monitoring-type" => 'detailed'}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        @inst.set_time_range
+        (Time.iso8601(@inst.end_time).to_i - Time.iso8601(@inst.start_time).to_i).should eq(90)
+      end
+      it "Should raise a MonitoringTypeArgumentException when the monitoring-type is not set to either basic or detailed" do 
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test', "monitoring-type" => 'junk'}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        lambda {@inst.set_time_range}.should raise_error GetCloudwatchMetric::MonitoringTypeArgumentException
+      end
+    end
+    describe "#set_statistic" do
+      it "Should set the statistic type to Average when statistic option is not set" do
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test'}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        @inst.set_statistic
+        @inst.statistic.should eq("Average")
+      end
+      it "Should set the statistic type to Sum when statistic option is set to Sum" do
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test', "statistic" => "Sum"}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        @inst.set_statistic
+        @inst.statistic.should eq("Sum")
+      end
+      it "Should raise a StatisticTypeArgumentException when the statistic option is not set to one of 'Minimum, Maximum, Average, Sum, SampleCount" do
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test', "statistic" => "Test"}
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        lambda {@inst.set_statistic}.should raise_error GetCloudwatchMetric::StatisticTypeArgumentException
+      end
+    end
+    describe "#run! (real)" do
+      it "Raises BadAWSAccessKeysException when the AWS Keys and/or Region are incorrect in the options" do
+        options = {"namespace" => '', "metricname" => '', "dimension-value" => '', "dimension-name" => '', "aws-access-key" => '', "aws-secret-key" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options).run!}.should raise_error GetCloudwatchMetric::BadAWSAccessKeysException
+      end
+    end
+    describe "#test_aws_connectivity (real)" do
+      it "Raises BadAWSAccessKeysException when the AWS Keys and/or Region are incorrect in the options" do
+        options = {"namespace" => '', "metricname" => '', "dimension-value" => '', "dimension-name" => '', "aws-access-key" => '', "aws-secret-key" => ''}
+        lambda {ZabbixCloudwatch::GetCloudwatchMetric.new(options).test_aws_connectivity}.should raise_error GetCloudwatchMetric::BadAWSAccessKeysException
+      end
+    end
+    describe "#test_aws_connectivity (mock)" do
+      it "Tests connectivity to AWS" do
+        options = {"namespace" => '', "metricname" => '', "dimension-value" => '', "dimension-name" => '', "aws-access-key" => '', "aws-secret-key" => ''}
+        AWS.stub!
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        lambda {@inst.test_aws_connectivity}.should_not raise_error
+      end
+    end
+    describe "#run! (mock)" do
+      before(:each) do
+        options = {"namespace" => 'AWS/EC2', "metricname" => 'CPU', "dimension-value" => 'EC2Instance', "dimension-name" => 'test', "aws-access-key" => 'test', "aws-secret-key" => 'test'}
+        AWS.stub!
+        @inst = ZabbixCloudwatch::GetCloudwatchMetric.new(options)
+        @stb = @inst.aws.stub_for(:get_metric_statistics)
+      end
+      it "exits 1 when there are no datapoints" do
+        @stb.data = Hash.new
+        lambda {@inst.run!}.should raise_error SystemExit
+      end
+      it "puts a string when there is one datapoint" do
+        @stb.data = {:datapoints => [ { :average => '10.0' } ] }
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.0\n")
+      end
+      it "puts the first datapoint when there is more than one datapoint returned by AWS" do
+        @stb.data = {:datapoints => [ { :average => '10.0' }, {:average => '10.1'}, {:average => '10.2'}] }
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.0\n")
+      end
+      it "puts the metric that matches the statistic" do
+        @stb.data = {:datapoints => [ { :average => '10.0', :minimum => '10.1', :maximum => '10.2', :sample_count => '10.3', :sum => '10.4' } ] }
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.0\n")
+        @inst.options["statistic"] = "Minimum"
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.1\n")
+        @inst.options["statistic"] = "Maximum"
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.2\n")
+        @inst.options["statistic"] = "SampleCount"
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.3\n")
+        @inst.options["statistic"] = "Sum"
+        output = capture_stdout {@inst.run!}
+        output.should eq("10.4\n")
+      end
+    end
+  end
+end

data/zabbix-cloudwatch.gemspec

@@ -19,6 +19,7 @@ EOF
 
   s.add_runtime_dependency "aws-sdk", "~> 1.21.0"
   s.add_runtime_dependency "getopt", "~> 1.4.1"
+  s.add_development_dependency "rspec"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zabbix-cloudwatch
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Randy D. Wallace Jr.
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-26 00:00:00 Z
+date: 2013-10-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-sdk
@@ -31,6 +31,17 @@ dependencies:
         version: 1.4.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id004 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: |
   A library for getting cloudwatch metrics into Zabbix
   
@@ -53,6 +64,8 @@ files:
 - bin/zabbix-cloudwatch
 - lib/zabbix-cloudwatch.rb
 - lib/zabbix-cloudwatch/version.rb
+- spec/spec_helper.rb
+- spec/zabbix-cloudwatch/zabbix-cloudwatch_spec.rb
 - zabbix-cloudwatch.gemspec
 homepage: http://github.com/randywallace/zabbix-cloudwatch
 licenses: 
@@ -66,13 +79,10 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - &id003 
-    - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  - *id004
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - *id003
+  - *id004
 requirements: []
 
 rubyforge_project: