weatherman 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+## Weatherman
+
+**Weatherman** is a utility to help report custom metrics from EC2 instances to CloudWatch.
+
+## Usage
+
+*Simple example*
+
+```ruby
+#Set credentials
+Weatherman::AWS.aws_access_key_id = 'key_id'
+Weatherman::AWS.aws_secret_access_key = 'key'
+
+#Report a process count to CloudWatch
+Weatherman::Report.run 'Process count' do
+  `ps -ef | wc -l`
+end
+```
+
+*Report options*
+
+Report takes an optional hash as a second argument. Supported keys with the defaults, unless otherwise specified:
+
+```ruby
+{
+  #Set the metric namespace
+  :namespace => 'Custom/Weatherman',
+
+  #Set the reporting period (in seconds)
+  :period => 12,
+
+  #Metadata for the metric, defaults to just InstanceId
+  #InstanceId is always included, even when this is set
+  :dimensions => {
+    :instance_name => 'super_cool_instance',
+    :deployment_id => 1
+  }
+}
+```
+
+*Daemonizing*
+
+The gem installs a 'weatherman' executable to your path. Pass as many Weatherman scripts to it as you want, each of which will be loaded and run in the background.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 Mike Marion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/weatherman

@@ -0,0 +1,17 @@
+require 'weatherman'
+
+ARGV.each do |script|
+  if File.exists?(script)
+    begin
+      load script
+    rescue => e
+      puts "Error loading #{script}:"
+      puts e.message
+      puts e.backtrace
+    end
+  else
+    puts "Could not find #{script}"
+  end
+end
+
+Process.daemon

data/lib/weatherman/aws.rb

@@ -0,0 +1,57 @@
+module Weatherman
+  module AWS
+
+    def self.aws_access_key_id
+      @aws_access_key_id || ENV['AWS_ACCESS_KEY_ID']
+    end
+
+    def self.aws_access_key_id=(id)
+      @aws_access_key_id = id
+    end
+
+    def self.aws_secret_access_key
+      @aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
+    end
+
+    def self.aws_secret_access_key=(key)
+      @aws_secret_access_key = key
+    end
+
+    def self.region
+      @region || 'us-east-1'
+    end
+
+    def self.region=(region)
+      @region = region
+    end
+
+    def self.instance_id
+      ec2_attributes[:instance_id]
+    end
+
+    def self.ec2_attributes
+      unless @ohai
+        @ohai = Ohai::System.new
+        @ohai.all_plugins
+        @ohai.refresh_plugins
+      end
+      @ohai.ec2 || {}
+    end
+
+    class CloudWatchMock
+      def put_metric_data(*args); end
+    end
+
+    def cloud_watch
+      #TODO: Update Fog with mock support for CloudWatch
+      @cloud_watch ||= CloudWatchMock.new if Fog.mocking?
+
+      @cloud_watch ||= Fog::AWS::CloudWatch.new(
+        :region                => AWS.region,
+        :aws_access_key_id     => AWS.aws_access_key_id,
+        :aws_secret_access_key => AWS.aws_secret_access_key
+      )
+    end
+
+  end
+end

data/lib/weatherman/report.rb

@@ -0,0 +1,55 @@
+module Weatherman
+  class Report
+
+    include AWS
+
+    attr_reader :name, :options
+
+    def self.run(name, options = {}, &collector)
+      report = new(name, options, &collector)
+      report.run
+      report
+    end
+
+    def initialize(name, options = {}, &collector)
+      @name       = name
+      @collector  = collector
+      @namespace  = options[:namespace] || 'Custom/Weatherman'
+      @period     = options[:period] || 12
+      @dimensions = options[:dimensions] || {}
+
+      @dimensions.merge! 'InstanceId' => AWS.instance_id
+    end
+
+    def run
+      @thread ||= Thread.new do
+        while true
+          report
+          sleep @period
+        end
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    def running?
+      !@thread.nil?
+    end
+
+    def report
+      value = @collector.call
+
+      cloud_watch.put_metric_data @namespace, [{
+        'MetricName' => @name,
+        'Value'      => value,
+        'Dimensions' => @dimensions.map { |k, v| { k.to_s => v } }
+      }]
+
+      value
+    end
+
+  end
+end

data/lib/weatherman/version.rb

@@ -0,0 +1,3 @@
+module Weatherman
+  VERSION = '0.0.1'
+end

data/lib/weatherman.rb

@@ -0,0 +1,7 @@
+require 'fog'
+require 'ohai'
+
+require 'weatherman/version'
+
+require 'weatherman/aws'
+require 'weatherman/report'

data/spec/report_spec.rb

@@ -0,0 +1,158 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Weatherman
+  describe Report do
+
+    before do
+      @initial_thread_count = Thread.list.length
+
+      @instance_id = 'i-test'
+      AWS.should_receive(:instance_id).at_least(:once).and_return(@instance_id)
+
+      @namespace = 'TestNamespace'
+      @metric_name = 'TestMetric'
+      @metric_value = 'some metric value'
+      @report = Report.new @metric_name, :namespace => @namespace do
+        @metric_value
+      end
+    end
+
+    describe 'run' do
+      it 'should create and run a report' do
+        report = Report.run 'test' do; end
+        report.should be_running
+      end
+    end
+
+    describe 'run' do
+      it 'should start a thread' do
+        @report.run
+
+        Thread.list.length.should == @initial_thread_count + 1
+      end
+
+      it 'should periodically call report' do
+        calls = []
+        report = Report.new 'test', :period => 1 do
+          calls << true
+        end
+
+        report.run
+
+        sleep 2
+        calls.length.should >= 2
+      end
+
+      it 'should do nothing if already running' do
+        @report.run
+
+        @report.run
+
+        Thread.list.length.should == @initial_thread_count + 1
+      end
+    end
+
+    describe 'stop' do
+      it 'should stop running report' do
+        @report.run
+
+        @report.stop
+
+        @report.should_not be_running
+        sleep 0.1
+        Thread.list.length.should <= @initial_thread_count
+      end
+
+      it 'should do nothing if not running' do
+        @report.stop
+
+        @report.should_not be_running
+        Thread.list.length.should <= @initial_thread_count
+      end
+    end
+
+    describe 'running?' do
+      it 'should be true if the report is running' do
+        @report.run
+
+        @report.should be_running
+      end
+
+      it 'should be false if the report is not running' do
+        @report.should_not be_running
+      end
+
+      it 'should be false if the report is stopped' do
+        @report.run
+
+        @report.stop
+
+        @report.should_not be_running
+      end
+    end
+
+    describe 'report' do
+      it 'should collect the metric' do
+        @report.report.should == @metric_value
+      end
+
+      it 'should report the metric' do
+        @report.cloud_watch.should_receive(:put_metric_data) do |namespace, metrics|
+          namespace.should == @namespace
+
+          metrics.length.should == 1
+          metric = metrics.first
+
+          metric['MetricName'].should == @metric_name
+        end
+
+        @report.report
+      end
+
+      it 'should include the instance ID as a default dimension' do
+        @report.cloud_watch.should_receive(:put_metric_data) do |namespace, metrics|
+          metrics.length.should == 1
+
+          metric = metrics.first
+          dimensions = metric['Dimensions']
+
+          dimensions.length.should == 1
+          puts dimensions.inspect
+          dimensions.first['InstanceId'].should == @instance_id
+        end
+
+        @report.report
+      end
+
+      it 'should include user-defined dimensions plus the instance ID' do
+        user_dimensions = {
+          :alpha => 'beta',
+          :gamma => 'delta'
+        }
+        report = Report.new @metric_name, :namespace => @namespace, :dimensions => user_dimensions do
+          @metric_value
+        end
+
+        report.cloud_watch.should_receive(:put_metric_data) do |namespace, metrics|
+          metrics.length.should == 1
+
+          metric = metrics.first
+          dimensions = metric['Dimensions']
+
+          dimensions.length.should == 3
+
+          user_dimensions['InstanceId'] = @instance_id
+          user_dimensions.each do |k, v|
+            dimension = dimensions.find { |d| d.keys.first == k.to_s}
+            dimension.should_not be_nil
+            dimension.length.should == 1
+            dimension.values.first.should == v
+          end
+        end
+
+        report.report
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'weatherman'
+
+Fog.mock!
+Weatherman::AWS.aws_access_key_id = 'test'
+Weatherman::AWS.aws_secret_access_key = 'test'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/weatherman.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "weatherman/version"
+
+Gem::Specification.new do |s|
+  s.name        = "weatherman"
+  s.version     = Weatherman::VERSION
+  s.authors     = ["Mike Marion"]
+  s.email       = ["mike.marion@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Helps collect custom CloudWatch metrics}
+  s.description = %q{Weatherman is for periodically collecting metrics and reporting them to CloudWatch}
+
+  s.rubyforge_project = "weatherman"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "fog", "~> 1.7.0"
+  s.add_runtime_dependency "ohai", "~> 6.14.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: weatherman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Marion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12940760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12940760
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: &12940260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *12940260
+- !ruby/object:Gem::Dependency
+  name: ohai
+  requirement: &12939760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 6.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *12939760
+description: Weatherman is for periodically collecting metrics and reporting them
+  to CloudWatch
+email:
+- mike.marion@gmail.com
+executables:
+- weatherman
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- bin/weatherman
+- lib/weatherman.rb
+- lib/weatherman/aws.rb
+- lib/weatherman/report.rb
+- lib/weatherman/version.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- weatherman.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: weatherman
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Helps collect custom CloudWatch metrics
+test_files: []