sidewatch 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1bfbd1570fe2102b145f87c85c38204766ee07e
-  data.tar.gz: 5ebf2ba6b7513a5ed9ca800e5a23eefe303c226f
+  metadata.gz: 53c84c0248846f6f5a57673e78d31223408f9699
+  data.tar.gz: 668241adc7830ef651272445ae8597767f01e80f
 SHA512:
-  metadata.gz: 114f60848612756f2eee7edf48931bb0d1c5021e983114e6d9d8ceaa5d70c2a20158331a305c3a4868a7a35e824194a334e84453463a2ce20a5a81c0b445e883
-  data.tar.gz: 7a65e525f6bbfa6946d2e5ef16cf618ade8caef0f861774a354c25487d775393d261fa1d8045121c00a608d4888f20e0ccce3b569a2df562dd2400dffa738e22
+  metadata.gz: 5d8838dd0d012f9745702dbcac17bcbe6f21b70cedf75a4a85feddad9d595856eed089d45a851da9bb27080e52eae3e3cca019858b147574dbdbd48618c495eb
+  data.tar.gz: 561da07d5a8d69f0b047ffa485f3b941e92d196dc62103e238644d91387b6fd98700d808c5c24f9511146e9376f62e8842bf298c7f1cead8fc2e979edf70eb38

data/.gitignore

@@ -1,6 +1,5 @@
 *.gem
 *.log
-*.yml
 *.rbc
 .bundle
 .env
@@ -14,6 +13,7 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+sidewatch.yml
 spec/reports
 test/tmp
 test/version_tmp

data/.travis.yml

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

data/CHANGES.md

@@ -0,0 +1,5 @@
+# Changelog
+
+0.0.4
+-----------
+- Upload metrics to CloudWatch in batches of max. 20 entries [#1]

data/README.md

@@ -1,5 +1,8 @@
 # Sidewatch
 
+[![Gem Version](https://badge.fury.io/rb/sidewatch.svg)](https://rubygems.org/gems/sidewatch)
+[![Build Status](https://travis-ci.org/travelmob/sidewatch.svg)](https://travis-ci.org/travelmob/sidewatch)
+
 Sidewatch uploads Sidekiq metrics to AWS CloudWatch in regular intervals.
 
 ## Installation
@@ -20,11 +23,40 @@ Or install it yourself as:
 
 To start sidewatch as a daemon process in the background run
 
-    ruby bin/sidewatch start
+    ruby bin/sidewatch start [--config <path to config file>]
 
 To run sidewatch in the foreground, e.g. for testing, run
 
-    ruby bin/sidewatch run
+    ruby bin/sidewatch run [--config <path to config file>]
+
+## Configuration
+
+### Using ENV variables
+
+Sidewatch will use the same environment variables as Sidekiq to determine the Redis server to connect to, i.e. either `REDIS_PROVIDER` or `REDIS_URL`. Please refer to the [Sidekiq wiki](https://github.com/mperham/sidekiq/wiki/Using-Redis#using-an-env-variable) for more information.
+
+Sidewatch uses the AWS SDK v2 to connect to CloudWatch. The SDK expects AWS credentials to be provided in one of these locations:
+
+* `ENV['AWS_ACCESS_KEY_ID']` and `ENV['AWS_SECRET_ACCESS_KEY']`
+* The shared credentials ini file at `~/.aws/credentials`
+* From an instance profile when running on EC2
+
+Please refer to the [SDK's documentation](http://docs.aws.amazon.com/sdkforruby/api/index.html#Configuration) for more information.
+
+### Using the config file
+
+When starting Sidewatch, you can pass a config file using the `--config` parameter. The config file should be in YAML format and supports the following keys:
+
+````yaml
+logfile: "/var/log/sidewatch.log"
+sidekiq:
+  namespace: "Sidekiq"               # namespace used when uploading AWS CloudWatch metrics
+  redis:
+    url: "redis://localhost:6379/0"
+    namespace: "sidekiq"             # Redis key namespace used by Sidekiq
+cloudwatch:
+   region: "us-west-2"
+````
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sidewatch/cloudwatch.rb

@@ -3,6 +3,8 @@ require "aws-sdk"
 module Sidewatch
   class Cloudwatch
 
+    MAX_BATCH_SIZE = 20
+
     attr_accessor :client
 
     def initialize(config = {})
@@ -14,13 +16,19 @@ module Sidewatch
 
     def send(metrics)
       metrics.group_by(&:namespace).each do |ns, ns_metrics|
-        data = metric_data(ns, ns_metrics)
-        client.put_metric_data(data)
+        ns_metrics.each_slice(max_batch_size) do |slice|
+          data = metric_data(ns, slice)
+          client.put_metric_data(data)
+        end
       end
     end
 
     private
 
+    def max_batch_size
+      MAX_BATCH_SIZE
+    end
+
     def metric_data(ns, metrics)
       {
         namespace: ns,
@@ -36,14 +44,5 @@ module Sidewatch
       }
     end
 
-    class MockClient
-      def initialize(config = {})
-        @out = config.fetch(:output){ $stdout }
-      end
-      def put_metric_data(data)
-        @out << data.to_s
-      end
-    end
-
   end
 end

data/lib/sidewatch/version.rb

@@ -1,3 +1,3 @@
 module Sidewatch
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/cloudwatch_spec.rb

@@ -47,6 +47,17 @@ module Sidewatch
         expect(received).to contain_exactly(hash_including(namespace: "Clocks"), hash_including(namespace: "Events"))
       end
 
+      it "sends metrics in batches of max. 20 entries" do
+        metrics = []
+        25.times do |i|
+          metrics << Metric.new(namespace: "Clocks", name: "Ticks", value: i, unit: "Count")
+        end
+
+        subject.send(metrics)
+
+        expect(client).to have_received(:put_metric_data).exactly(2).times
+      end
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidewatch
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jan Hecking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md