cloudwatchtographite 0.0.0.pre1

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,25 @@
+source 'http://rubygems.org'
+
+# Required gems
+gem 'bundler'
+gem 'unf'
+gem "fog", "~> 1.19.0"
+gem 'hashifiable', '>= 0.1.3'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rdoc'
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'jeweler'
+  gem 'cane'
+  gem "factory_girl"
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem "factory_girl"
+  gem 'coveralls', require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 S. Zachariah Sprackett
+
+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/README.md

@@ -0,0 +1,138 @@
+AWS CloudwatchToGraphite Ruby Gem
+=================================
+
+This application will fetch a list of AWS CloudWatch metrics using the Fog
+library to connect to the Amazon APIs.  It can parse a list of metric
+definitions in either JSON or YAML formats.  It will take the results and
+submit them to a Graphite server of your choosing.
+
+- [Fog](https://github.com/fog/fog)
+- [Graphite](http://graphite.wikidot.com/)
+- [AWS CloudWatch](http://aws.amazon.com/cloudwatch/)
+
+[![Build Status](https://travis-ci.org/zsprackett/cloudwatchtographite.png?branch=master)](https://travis-ci.org/zsprackett/cloudwatchtographite)
+[![Code Climate](https://codeclimate.com/github/zsprackett/cloudwatchtographite.png)](https://codeclimate.com/github/zsprackett/cloudwatchtographite)
+[![Coverage Status](https://coveralls.io/repos/zsprackett/cloudwatchtographite/badge.png)](https://coveralls.io/r/zsprackett/cloudwatchtographite)
+[![Dependency Status](https://gemnasium.com/zsprackett/cloudwatchtographite.png)](https://gemnasium.com/zsprackett/cloudwatchtographite)
+
+
+Usage
+-----
+
+    Usage: cloudwatch_to_graphite [OPTIONS]
+    
+      -a, --access-key=KEY             AWS Access Key (Falls back to ENV['AWS_ACCESS_KEY_ID'])
+      -s, --secret-key=KEY             AWS Secret Access Key (Falls back to ENV['AWS_SECRET_ACCESS_KEY'])
+      -j, --json-metrics=FILE          Path to JSON metrics file
+      -y, --yaml-metrics=FILE          Path to YAML metrics file
+      -p, --protocol=udp               TCP or UDP (Default: udp)
+      -r, --region=us-east-1           AWS Region (Default: us-east-1)
+      -g, --graphite-server=host       Graphite Server (Default: localhost)
+      -P, --graphite-port=port         Graphite Port (Default: 2003)
+      -c, --carbon-prefix              Carbon Prefix (Default: cloudwatch)
+      -v, --verbose                    Increase verbosity
+      -V, --version                    Print version and exit
+      -h, --help                       help
+
+JSON Metrics Definition File
+----------------------------
+
+    {
+      "metrics": [
+        {
+          "namespace": "AWS/ELB",
+          "metricname": "RequestCount",
+          "statistics": [ "Average", "Minimum", "Maximum" ],
+          "dimensions": [{
+            "name":"LoadBalancerName",
+            "value":"MyLoadBalancer"
+          }]
+        },
+        {
+          "namespace": "AWS/EC2",
+          "metricname": "CPUUtilization",
+          "statistics": [ "Average", "Minimum", "Maximum" ],
+          "dimensions": [{
+            "name":"InstanceId",
+            "value":"i-abc123456"
+          }]
+        }
+      ]
+    }
+
+YAML Metrics Definition File
+----------------------------
+
+    ---
+    metrics:
+    -
+      namespace: AWS/ELB
+      metricname: RequestCount
+      statistics:
+        - Average
+        - Minimum
+        - Maximum
+      dimensions:
+        -
+          name: LoadBalancerName
+          value: MyLoadBalancer
+    -
+      namespace: AWS/EC2
+      metricname: CPUUtilization
+      statistics:
+        - Average
+        - Minimum
+        - Maximum
+      dimensions:
+        -
+          name: InstanceId
+          value: i-abc123456
+
+Contributing
+------------
+
+* Find something you would like to work on.
+  * Look for anything you can help with in the [issue tracker](https://github.com/zsprackett/cloudwatchtographite/issues).
+  * Look at the [code quality metrics](https://codeclimate.com/github/zsprackett/cloudwatchtographite) for anything you can help clean up.
+  * Look at the [test coverage](https://coveralls.io/r/zsprackett/cloudwatchtographite) for code in need of rspec tests.
+  * Do something else cool!
+* Fork the project and do your work in a topic branch.
+  * Make sure your changes will work on both Ruby 1.9.3 and Ruby 2.0
+* Add tests to prove your code works and run all the tests using `bundle exec rake`.
+* Rebase your branch against `zsprackett/cloudwatchtographite` to make sure everything is up to date.
+* Commit your changes and send a pull request.
+
+Author
+------
+
+[S. Zachariah Sprackett](mailto:zac@sprackett.com)
+
+Copyright
+---------
+
+(The MIT License)
+
+Copyright (c) 2013 [zsprackett (S. Zachariah Sprackett)](http://github.com/zsprackett)
+
+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.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/zsprackett/cloudwatchtographite/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/cloudwatchtographite/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cloudwatchtographite"
+  gem.homepage = "http://github.com/zsprackett/cloudwatchtographite"
+  gem.license = "MIT"
+  gem.summary = %Q{CloudWatch Metrics to Graphite}
+  gem.description = %Q{Pull statistics from Amazon CloudWatch into Graphite}
+  gem.email = "zac@sprackett.com"
+  gem.authors = ["S. Zachariah Sprackett"]
+  gem.version = CloudwatchToGraphite::VERSION::STRING
+  gem.executables = ["cloudwatch_to_graphite"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'cane/rake_task'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 10
+  cane.add_threshold 'coverage/.last_run.json', :>=, 70
+end
+
+task :test => [:spec, :quality]
+task :default => :test
+
+require 'rdoc/task'
+require './lib/cloudwatchtographite/version.rb'
+Rake::RDocTask.new do |rdoc|
+  version =  CloudwatchToGraphite::VERSION::STRING
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "CloudwatchToGraphite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/cloudwatch_to_graphite

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+# _*_ coding: utf-8 _*_
+#
+# == Synopsis
+# CloudwatchToGraphite retrieves metrics from the Amazon CloudWatch APIs
+# and passes them on to a graphite server
+#
+# == Author
+# S. Zachariah Sprackett <zac@sprackett.com>
+#
+# == License
+# The MIT License (MIT)
+#
+# == Copyright
+# Copyright (C) 2013 - S. Zachariah Sprackett <zac@sprackett.com>
+#
+
+require 'optparse'
+require 'pp'
+
+begin
+  require 'cloudwatchtographite'
+rescue LoadError
+  dev_path = File.join(File.dirname(__FILE__), '..', 'lib')
+  $:.unshift(dev_path)
+  require 'cloudwatchtographite'
+end
+
+
+# default options
+options = {
+  :protocol         => 'udp',
+  :region           => ENV.has_key?('AWS_DEFAULT_REGION') ?
+    ENV['AWS_DEFAULT_REGION'] : 'us-east-1',
+  :access_key       => ENV['AWS_ACCESS_KEY_ID'],
+  :secret_key       => ENV['AWS_SECRET_ACCESS_KEY'],
+  :graphite_server  => 'localhost',
+  :graphite_port    => 2003,
+  :carbon_prefix    => 'cloudwatch',
+  :verbose          => false
+}
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: %s [OPTIONS]" % File.basename($0)
+  opt.separator  ""
+  opt.on("-a","--access-key=KEY","AWS Access Key (Falls back to ENV['AWS_ACCESS_KEY_ID'])") do |key|
+    options[:access_key] = key
+  end
+  opt.on("-s","--secret-key=KEY","AWS Secret Access Key (Falls back to ENV['AWS_SECRET_ACCESS_KEY'])") do |key|
+    options[:secret_key] = key
+  end
+  opt.on("-j","--json-metrics=FILE","Path to JSON metrics file") do |file|
+    options[:json_metrics] = file
+  end
+  opt.on("-y","--yaml-metrics=FILE","Path to YAML metrics file") do |file|
+    options[:yaml_metrics] = file
+  end
+  opt.on("-p","--protocol=udp","TCP or UDP (Default: #{options[:protocol]})") do |protocol|
+    options[:protocol] = protocol
+  end
+  opt.on("-r","--region=us-east-1","AWS Region (Default: #{options[:region]})") do |region|
+    options[:region] = region
+  end
+  opt.on("-g","--graphite-server=host","Graphite Server (Default: #{options[:graphite_server]})") do |server|
+    options[:graphite_server] = server
+  end
+  opt.on("-P","--graphite-port=port", Integer, "Graphite Port (Default: #{options[:graphite_port]})") do |port|
+    options[:graphite_port] = port
+  end
+  opt.on("-c","--carbon-prefix=prefix","Carbon Prefix (Default: #{options[:carbon_prefix]})") do |prefix|
+    options[:carbon_prefix] = prefix
+  end
+  opt.on("-v","--verbose","Increase verbosity") do
+    options[:verbose] = true
+  end
+  opt.on("-V","--version","Print version and exit") do
+    puts File.basename($0) + " " + CloudwatchToGraphite::VERSION::STRING
+    exit 0
+  end
+  opt.on("-h","--help","help") do
+    puts opt_parser
+    exit 1
+  end
+end
+begin
+  opt_parser.parse!
+  mandatory = [ :access_key, :secret_key ]
+  missing = mandatory.select{ |param| options[param].nil? }
+  if not missing.empty?
+    puts "Missing options: #{missing.join(', ')}"
+    puts opt_parser
+    exit 1
+  end
+  if options[:json_metrics].nil? and options[:yaml_metrics].nil?
+    puts "No metric file specified."
+    puts opt_parser
+    exit 1
+  elsif not options[:json_metrics].nil? and not options[:yaml_metrics].nil?
+    puts "Only one metric file should be specified."
+    puts opt_parser
+    exit 1
+  end
+rescue OptionParser::InvalidOption => e
+  puts "Error: #{e}"
+  puts
+  puts opt_parser
+  exit 1
+end
+
+metrics = nil
+begin
+  if not options[:json_metrics].nil?
+    metrics = CloudwatchToGraphite::LoadMetrics.from_json_file(options[:json_metrics])
+  else
+    metrics = CloudwatchToGraphite::LoadMetrics.from_yaml_file(options[:yaml_metrics])
+  end
+rescue CloudwatchToGraphite::ParseError
+  warn "Failed to parse option file"
+  exit 1
+end
+
+if metrics.empty?
+  warn "Exiting due to lack of metric definitions"
+  exit 1
+end
+
+cwtg = CloudwatchToGraphite::Base.new(
+  options[:access_key],
+  options[:secret_key],
+  options[:region],
+  options[:verbose]
+)
+
+cwtg.carbon_prefix = options[:carbon_prefix]
+cwtg.protocol = options[:protocol]
+cwtg.graphite_server = options[:graphite_server]
+cwtg.graphite_port = options[:graphite_port]
+
+if cwtg.fetch_and_forward(metrics)
+  exit 0
+else
+  exit 1
+end

data/conf/example-metrics.json

@@ -0,0 +1,23 @@
+{
+  "metrics": [
+    {
+      "namespace": "AWS/ELB",
+      "metricname": "RequestCount",
+      "statistics": [ "Average", "Minimum", "Maximum" ],
+      "unit": "Count/Second",
+      "dimensions": [{
+        "name":"LoadBalancerName",
+        "value":"MyLoadBalancer"
+      }]
+    },
+    {
+      "namespace": "AWS/EC2",
+      "metricname": "CPUUtilization",
+      "statistics": [ "Average", "Minimum", "Maximum" ],
+      "dimensions": [{
+        "name":"InstanceId",
+        "value":"i-abc123456"
+      }]
+    }
+  ]
+}

data/conf/example-metrics.yaml

@@ -0,0 +1,25 @@
+---
+metrics:
+-
+  namespace: AWS/ELB
+  metricname: RequestCount
+  statistics:
+    - Average
+    - Minimum
+    - Maximum
+  unit: Count/Second
+  dimensions:
+    -
+      name: LoadBalancerName
+      value: MyLoadBalancer
+-
+  namespace: AWS/EC2
+  metricname: CPUUtilization
+  statistics:
+    - Average
+    - Minimum
+    - Maximum
+  dimensions:
+    -
+      name: InstanceId
+      value: i-abc123456

data/lib/cloudwatchtographite/exception.rb

@@ -0,0 +1,36 @@
+# _*_ coding: utf-8 _*_
+# == Synopsis
+# CloudwatchToGraphite retrieves metrics from the Amazon CloudWatch APIs
+# and passes them on to a graphite server
+#
+# == Author
+# S. Zachariah Sprackett <zac@sprackett.com>
+#
+# == License
+# The MIT License (MIT)
+#
+# == Copyright
+# Copyright (C) 2013 - S. Zachariah Sprackett <zac@sprackett.com>
+#
+module CloudwatchToGraphite
+  # general exception class.  ancestor to all CloudwatchToGraphite exceptions
+  class Exception < ::RuntimeError; end
+
+  # Raised when the arguments are wrong
+  class ArgumentError < Exception; end
+
+  # Raised when an argument is too long
+  class ArgumentLengthError < ArgumentError; end
+
+  # Raised when an argument is of the wrong type
+  class ArgumentTypeError < ArgumentError; end
+
+  # Raised when too many dimensions are specified
+  class TooManyDimensionError < Exception; end
+
+  # Raised when parsing fails
+  class ParseError < Exception; end
+
+  # Raised when an unknown protocol is used to try to send to graphite
+  class ProtocolError < Exception; end
+end

data/lib/cloudwatchtographite/loadmetrics.rb

@@ -0,0 +1,70 @@
+# _*_ coding: utf-8 _*_
+# == Synopsis
+# CloudwatchToGraphite retrieves metrics from the Amazon CloudWatch APIs
+# and passes them on to a graphite server
+#
+# == Author
+# S. Zachariah Sprackett <zac@sprackett.com>
+#
+# == License
+# The MIT License (MIT)
+#
+# == Copyright
+# Copyright (C) 2013 - S. Zachariah Sprackett <zac@sprackett.com>
+#
+require 'json'
+require 'yaml'
+
+module CloudwatchToGraphite
+  # Load metrics from a file and parse them into a
+  # CloudwatchToGraphite::MetricDefinition object
+  #
+  class LoadMetrics
+    def self.from_json_file(filename)
+      if not File.readable?(filename)
+        warn "Unable to read %s" % filename
+        []
+      else
+        File.open(filename, 'r') do |f|
+          begin
+            contents = JSON.load(f)
+            load_content(contents)
+          rescue Exception
+            warn "Failed to parse %s" % filename
+            []
+          end
+        end
+      end
+    end
+
+    def self.from_yaml_file(filename)
+      if not File.readable?(filename)
+        warn "Unable to read %s" % filename
+        []
+      else
+        begin
+          contents = YAML.load_file(filename)
+          load_content(contents)
+        rescue Exception
+          warn "Failed to parse %s" % filename
+          []
+        end
+      end
+    end
+
+    private
+    def self.load_content(contents, strict=false)
+      metrics = []
+      Validator::hash_with_key_of_type(contents,'metrics',Array)
+      contents['metrics'].each do |m|
+        parsed = MetricDefinition::create_and_fill m
+        if (parsed != false)
+          metrics.push(parsed)
+        else
+          warn "Failed to parse #{m}."
+        end
+      end
+      metrics
+    end
+  end
+end