librato-metrics 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.6
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Changelog
+
+### Version 0.2.0
+* Fix bug with stale excon connections not reconnecting
+* Add custom User-Agent
+* Items added to Queue objects have their measure_time set automatically
+* Metric 'type' key can be string or symbol, thanks neilmock
+
+### Version 0.1.0
+* Initial release

data/LICENSE

@@ -1,11 +1,24 @@
-Librato Software Confidential and Proprietary
+Copyright (c) 2011. Librato, Inc.
+All rights reserved.
 
-Copyright (C) 2011, Librato Inc.  ALL RIGHTS RESERVED.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
 
-Except as specifically permitted herein, no portion of the
-information, including but not limited to object code and source
-code, may be reproduced, modified, distributed, republished or
-otherwise utilized in any form or by any means for any purpose
-without the prior written permission of Librato Inc.
-
-Visit http://librato.com for more information.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -101,6 +101,14 @@ Get the 20 most recent 15 minute data point rollups for `temperature`:
 
 There are many more options supported for querying, take a look at the [REST API docs](http://dev.librato.com/v1/get/gauges/:name) for more details.
 
+## Known Issues & Coming Improvements
+
+This is an early release and as such is lacking some capabilities slated for future releases.
+
+* Query actions currently do not auto-paginate with large result sets
+* Very large metric POSTs are not automatically chunked for performance
+* Some error conditions currently lack gem-specific exceptions
+
 ## Contribution
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/librato/metrics/queue.rb

@@ -2,8 +2,11 @@ module Librato
   module Metrics
     class Queue
 
-      def initialize
+      attr_accessor :skip_measurement_times
+
+      def initialize(options={})
         @queued ||= {}
+        @skip_measurement_times = options.delete(:skip_measurement_times)
       end
 
       # Add a metric entry to the metric set:
@@ -13,15 +16,19 @@ module Librato
       def add(args)
         args.each do |key, value|
           if value.respond_to?(:each)
-            type = (value.delete(:type) || 'gauge')
-            type = ("#{type}s").to_sym
-            value[:name] = key.to_s
-            @queued[type] ||= []
-            @queued[type] << value
+            metric = value
+            metric[:name] = key.to_s
+            type = metric.delete(:type) || metric.delete('type') || 'gauge'
           else
-            @queued[:gauges] ||= []
-            @queued[:gauges] << {:name => key.to_s, :value => value}
+            metric = {:name => key.to_s, :value => value}
+            type = :gauge
+          end
+          type = ("#{type}s").to_sym
+          unless skip_measurement_times
+            metric[:measure_time] ||= epoch_time
           end
+          @queued[type] ||= []
+          @queued[type] << metric
         end
         queued
       end
@@ -105,6 +112,10 @@ module Librato
         Librato::Metrics::Persistence.const_get(type).new
       end
 
+      def epoch_time
+        Time.now.to_i
+      end
+
     end
   end
-end
+end

data/lib/librato/metrics/simple.rb

@@ -44,7 +44,9 @@ module Librato
         end
 
         def connection
-          @connection ||= Excon.new(self.api_endpoint, :headers => {'Authorization' => auth_header})
+          # TODO: upate when excon connection recovery is improved.
+          # @connection ||= Excon.new(self.api_endpoint, :headers => common_headers)
+          Excon.new(self.api_endpoint, :headers => common_headers)
         end
 
         # Purge current credentials and connection
@@ -76,11 +78,16 @@ module Librato
         # Submit all queued metrics
         #
         def submit(args)
-          @queue ||= Queue.new
+          @queue ||= Queue.new(:skip_measurement_times => true)
           @queue.add args
           @queue.submit
         end
 
+        def user_agent
+          ruby_ver = "#{RUBY_ENGINE}; #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM}"
+          "librato-metrics/#{Metrics::VERSION} (#{ruby_ver}) direct-excon/#{Excon::VERSION}"
+        end
+
       private
 
         def auth_header
@@ -89,6 +96,10 @@ module Librato
           "Basic #{encoded}"
         end
 
+        def common_headers
+          {'Authorization' => auth_header, 'User-Agent' => user_agent}
+        end
+
         def flush_persistence
           @persistence = nil
         end

data/lib/librato/metrics/version.rb

@@ -1,5 +1,5 @@
 module Librato
   module Metrics
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/librato-metrics.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.authors  = ["Matt Sanders"]
   s.email    = 'matt@librato.com'
-  s.homepage = 'http://metrics.librato.com'
+  s.homepage = 'https://github.com/librato/librato-metrics'
 
   s.require_paths = %w[lib]
 
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'excon', '~>0.7.12'
 
   ## development dependencies
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~>2.6.0'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rdiscount' # for yard

data/spec/unit/metrics/queue_spec.rb

@@ -5,25 +5,35 @@ module Librato
 
     describe Queue do
 
-      describe "#add" do
+      before(:all) do
+        @time = Time.now.to_i
+        Librato::Metrics::Queue.stub(:epoch_time).and_return(@time)
+      end
 
+      describe "#add" do
         context "with single hash argument" do
           it "should record a key-value gauge" do
             subject.add :foo => 3000
-            subject.queued.should eql({:gauges => [{:name => 'foo', :value => 3000}]})
+            subject.queued.should eql({:gauges => [{:name => 'foo', :value => 3000, :measure_time => @time}]})
           end
         end
 
         context "with specified metric type" do
           it "should record counters" do
             subject.add :total_visits => {:type => :counter, :value => 4000}
-            expected = {:counters => [{:name => 'total_visits', :value => 4000}]}
+            expected = {:counters => [{:name => 'total_visits', :value => 4000, :measure_time => @time}]}
             subject.queued.should eql expected
           end
 
           it "should record gauges" do
             subject.add :temperature => {:type => :gauge, :value => 34}
-            expected = {:gauges => [{:name => 'temperature', :value => 34}]}
+            expected = {:gauges => [{:name => 'temperature', :value => 34, :measure_time => @time}]}
+            subject.queued.should eql expected
+          end
+
+          it "should accept type key as string or a symbol" do
+            subject.add :total_visits => {"type" => "counter", :value => 4000}
+            expected = {:counters => [{:name => 'total_visits', :value => 4000}]}
             subject.queued.should eql expected
           end
         end
@@ -44,43 +54,39 @@ module Librato
         context "with multiple metrics" do
           it "should record" do
             subject.add :foo => 123, :bar => 345, :baz => 567
-            expected = {:gauges=>[{:name=>"foo", :value=>123}, {:name=>"bar", :value=>345}, {:name=>"baz", :value=>567}]}
+            expected = {:gauges=>[{:name=>"foo", :value=>123, :measure_time => @time},
+                                  {:name=>"bar", :value=>345, :measure_time => @time},
+                                  {:name=>"baz", :value=>567, :measure_time => @time}]}
             subject.queued.should eql expected
           end
         end
-
       end
 
       describe "#counters" do
-
         it "should return currently queued counters" do
           subject.add :transactions => {:type => :counter, :value => 12345},
-                        :register_cents => {:type => :gauge, :value => 211101}
-          subject.counters.should eql [{:name => 'transactions', :value => 12345}]
+                      :register_cents => {:type => :gauge, :value => 211101}
+          subject.counters.should eql [{:name => 'transactions', :value => 12345, :measure_time => @time}]
         end
 
         it "should return [] when no queued counters" do
           subject.counters.should eql []
         end
-
       end
 
       describe "#gauges" do
-
         it "should return currently queued gauges" do
           subject.add :transactions => {:type => :counter, :value => 12345},
                         :register_cents => {:type => :gauge, :value => 211101}
-          subject.gauges.should eql [{:name => 'register_cents', :value => 211101}]
+          subject.gauges.should eql [{:name => 'register_cents', :value => 211101, :measure_time => @time}]
         end
 
         it "should return [] when no queued gauges" do
           subject.gauges.should eql []
         end
-
       end
 
       describe "#submit" do
-
         before(:all) do
           Librato::Metrics.authenticate 'me@librato.com', 'foo'
           Librato::Metrics.persistence = :test
@@ -103,13 +109,10 @@ module Librato
             subject.queued.should_not be_empty
           end
         end
-
       end
 
       describe "#time" do
-
         context "with metric name only" do
-
           it "should queue metric with timed value" do
             subject.time :sleeping do
               sleep 0.1
@@ -119,11 +122,9 @@ module Librato
             queued[:value].should be > 100
             queued[:value].should be_within(30).of(100)
           end
-
         end
 
         context "with metric and options" do
-
           it "should queue metric with value and options" do
             subject.time :sleep_two, :source => 'app1', :period => 2 do
               sleep 0.05
@@ -135,12 +136,10 @@ module Librato
             queued[:value].should be > 50
             queued[:value].should be_within(30).of(50)
           end
-
         end
-
       end
 
     end # MetricSet
 
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000Z
+date: 2011-12-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70180001393620 !ruby/object:Gem::Requirement
+  requirement: &70208460547940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 0.7.12
   type: :runtime
   prerelease: false
-  version_requirements: *70180001393620
+  version_requirements: *70208460547940
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70208460547480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70208460547480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70180001393140 !ruby/object:Gem::Requirement
+  requirement: &70208460546880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70180001393140
+  version_requirements: *70208460546880
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70180001392760 !ruby/object:Gem::Requirement
+  requirement: &70208460546440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70180001392760
+  version_requirements: *70208460546440
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70180001392300 !ruby/object:Gem::Requirement
+  requirement: &70208460545960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70180001392300
+  version_requirements: *70208460545960
 description: An easy to use ruby wrapper for Librato's Metrics API
 email: matt@librato.com
 executables: []
@@ -63,6 +74,8 @@ extra_rdoc_files:
 - LICENSE
 files:
 - .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -80,7 +93,7 @@ files:
 - spec/unit/metrics/queue_spec.rb
 - spec/unit/metrics/simple_spec.rb
 - spec/unit/metrics_spec.rb
-homepage: http://metrics.librato.com
+homepage: https://github.com/librato/librato-metrics
 licenses: []
 post_install_message: 
 rdoc_options:
@@ -101,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 2
 summary: Ruby wrapper for Librato's Metrics API