librato-metrics 0.2.3 → 0.3.0

data/.gitignore

@@ -17,3 +17,5 @@ doc
 
 # rcov generated
 coverage
+
+test_env.sh

data/README.md

@@ -12,6 +12,12 @@ In your shell:
 Then, in your application or script:
 
     require 'librato/metrics'
+    
+### Optional steps
+
+For best performance we recommend installing [yajl-ruby](https://github.com/brianmario/yajl-ruby):
+
+    gem install yajl-ruby
 
 ## Quick Start
 
@@ -101,6 +107,10 @@ 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) or the [fetch documentation](http://rubydoc.info/github/librato/librato-metrics/master/Librato/Metrics.fetch)  for more details.
 
+## Thread Safety
+
+The `librato-metrics` gem currently does not do internal locking for thread safety. When used in multi-threaded applications, please add your own mutexes for sensitive operations.
+
 ## Known Issues & Coming Improvements
 
 This is an early release and as such is lacking some capabilities slated for future releases.

data/Rakefile

@@ -5,8 +5,27 @@ Bundler::GemHelper.install_tasks
 
 # Testing
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--color'
+
+desc "Run all tests"
+task :spec do
+  Rake::Task['spec:unit'].execute
+  if ENV['TEST_API_USER'] && ENV['TEST_API_KEY']
+    Rake::Task['spec:integration'].execute
+  else
+    puts "TEST_API_USER and TEST_API_KEY not in environment, skipping integration tests..."
+  end
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.rspec_opts = '--color'
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.rspec_opts = '--color'
+    t.pattern = 'spec/integration/**/*_spec.rb'
+  end
 end
 
 task :default => :spec

data/lib/librato/metrics.rb

@@ -3,13 +3,14 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 require 'base64'
 require 'excon'
-require 'json'
+require 'multi_json'
 
 require 'metrics/errors'
 require 'metrics/persistence'
 require 'metrics/queue'
 require 'metrics/simple'
 require 'metrics/version'
+require 'metrics/collect'
 
 module Librato
 
@@ -59,8 +60,6 @@ module Librato
     # @param [Symbol|String] metric Metric name
     # @param [Hash] options Query options
     def self.fetch(metric, options={})
-      # TODO: look up type when not specified.
-      type = options.delete(:type) || 'gauge'
       query = options.dup
       if query[:start_time].respond_to?(:year)
         query[:start_time] = query[:start_time].to_i
@@ -71,9 +70,9 @@ module Librato
       unless query.empty?
         query[:resolution] ||= 1
       end
-      response = connection.get(:path => "v1/#{type}s/#{metric}.json",
+      response = connection.get(:path => "v1/metrics/#{metric}",
                                 :query => query, :expects => 200)
-      parsed = JSON.parse(response.body)
+      parsed = MultiJson.decode(response.body)
       # TODO: pagination support
       query.empty? ? parsed : parsed["measurements"]
     end
@@ -90,10 +89,9 @@ module Librato
     def self.list(options={})
       query = {}
       query[:name] = options[:name] if options[:name]
-      response = connection.get(:path => 'v1/metrics.json',
-                                :query => query, :expects => 200)
-      # TODO: pagination support
-      JSON.parse(response.body)["metrics"]
+      offset = 0
+      path = "v1/metrics"
+      Collect.paginated_metrics connection, path, query
     end
 
   end

data/lib/librato/metrics/collect.rb

@@ -0,0 +1,32 @@
+module Librato
+  module Metrics
+    class Collect
+
+      MAX_RESULTS = 100
+
+      # Aggregates all results of paginated elements, requesting more collections as needed
+      #
+      # @param [Excon] connection Connection to Metrics service
+      # @param [String] path API uri
+      # @param [Hash] query Query options
+      def self.paginated_metrics connection, path, query
+        results = []
+        response = connection.get(:path => path,
+                                  :query => query, :expects => 200)
+        parsed = MultiJson.decode(response.body)
+        results = parsed["metrics"]
+        return results if parsed["query"]["found"] <= MAX_RESULTS
+        query[:offset] = MAX_RESULTS
+        begin
+          response = connection.get(:path => path,
+                                    :query => query, :expects => 200)
+          parsed = MultiJson.decode(response.body)
+          results.push(*parsed["metrics"])
+          query[:offset] += MAX_RESULTS
+        end while query[:offset] < parsed["query"]["found"]
+        results
+      end
+
+    end
+  end
+end

data/lib/librato/metrics/persistence/direct.rb

@@ -10,8 +10,8 @@ module Librato
         # Metrics web API.
         #
         def persist(queued)
-          payload = queued.to_json
-          Simple.connection.post(:path => '/v1/metrics.json',
+          payload = MultiJson.encode(queued)
+          Simple.connection.post(:path => '/v1/metrics',
               :headers => {'Content-Type' => 'application/json'},
               :body => payload, :expects => 200)
         end

data/lib/librato/metrics/queue.rb

@@ -40,11 +40,19 @@ module Librato
         @queued[:counters] || []
       end
 
+      # Are any metrics currently queued?
+      #
+      # @return Boolean
+      def empty?
+        @queued.empty?
+      end
+
       # Remove all queued metrics
       #
       def flush
         @queued = {}
       end
+      alias :clear :flush
       alias :flush_queued :flush
 
       # The object this MetricSet will use to persist
@@ -67,6 +75,14 @@ module Librato
         @queued
       end
 
+      # Count of metrics currently queued
+      #
+      # @return Integer
+      def size
+        self.queued.inject(0) { |result, data| result + data.last.size }
+      end
+      alias :length :size
+
       # Persist currently queued metrics
       #
       # @return Boolean

data/lib/librato/metrics/version.rb

@@ -1,5 +1,5 @@
 module Librato
   module Metrics
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/librato-metrics.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
 
   ## runtime dependencies
   s.add_dependency 'excon', '~>0.7.12'
+  s.add_dependency 'multi_json'
 
   ## development dependencies
   s.add_development_dependency 'rake'

data/spec/integration/metrics_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+module Librato
+  describe Metrics do
+    before(:all) { prep_integration_tests }
+
+    describe "#fetch" do
+      before(:all) do
+        delete_all_metrics
+        Metrics.submit :my_counter => {:type => :counter, :value => 0}
+        1.upto(2).each do |i|
+          sleep 1
+          Metrics.submit :my_counter => {:type => :counter, :value => i}
+          Metrics.submit :my_counter => {:source => 'baz', :type => :counter, :value => i+1}
+        end
+      end
+
+      context "without arguments" do
+        it "should get metric attributes" do
+          metric = Metrics.fetch :my_counter
+          metric['name'].should == 'my_counter'
+          metric['type'].should == 'counter'
+        end
+      end
+
+      context "with a start_time" do
+        it "should return entries since that time" do
+          data = Metrics.fetch :my_counter, :start_time => Time.now-3600 # 1 hr ago
+          data['unassigned'].length.should == 3
+          data['baz'].length.should == 2
+        end
+      end
+
+      context "with a count limit" do
+        it "should return that number of entries per source" do
+          data = Metrics.fetch :my_counter, :count => 2
+          data['unassigned'].length.should == 2
+          data['baz'].length.should == 2
+        end
+      end
+
+      context "with a source limit" do
+        it "should only return that source" do
+          data = Metrics.fetch :my_counter, :source => 'baz', :start_time => Time.now-3600
+          data['baz'].length.should == 2
+          data['unassigned'].should be_nil
+        end
+      end
+
+    end
+
+    describe "#list" do
+      before(:all) do
+        delete_all_metrics
+        Metrics.submit :foo => 123, :bar => 345, :baz => 678, :foo_2 => 901
+      end
+
+      context "without arguments" do
+        it "should list all metrics" do
+          metric_names = Metrics.list.map { |metric| metric['name'] }
+          metric_names.sort.should == %w{foo bar baz foo_2}.sort
+        end
+      end
+
+      context "with a name argument" do
+        it "should list metrics that match" do
+          metric_names = Metrics.list(:name => 'foo').map { |metric| metric['name'] }
+          metric_names.sort.should == %w{foo foo_2}.sort
+        end
+      end
+
+    end
+
+    describe "#submit" do
+
+      context "with a gauge" do
+        before(:all) do
+          delete_all_metrics
+          Metrics.submit :foo => 123
+        end
+
+        it "should create the metrics" do
+          metric = Metrics.list[0]
+          metric['name'].should == 'foo'
+          metric['type'].should == 'gauge'
+        end
+
+        it "should store their data" do
+          data = Metrics.fetch :foo, :count => 1
+          data.should_not be_empty
+          data['unassigned'][0]['value'] == 123.0
+        end
+      end
+
+      context "with a counter" do
+        before(:all) do
+          delete_all_metrics
+          Metrics.submit :bar => {:type => :counter, :source => 'baz', :value => 456}
+        end
+
+        it "should create the metrics" do
+          metric = Metrics.list[0]
+          metric['name'].should == 'bar'
+          metric['type'].should == 'counter'
+        end
+
+        it "should store their data" do
+          data = Metrics.fetch :bar, :count => 1
+          data.should_not be_empty
+          data['baz'][0]['value'] == 456.0
+        end
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -7,4 +7,23 @@ require 'librato/metrics'
 
 RSpec.configure do |config|
 
+  # set up test account credentials for integration tests
+  def prep_integration_tests
+    raise 'no TEST_API_USER specified in environment' unless ENV['TEST_API_USER']
+    raise 'no TEST_API_KEY specified in environment' unless ENV['TEST_API_KEY']
+    if ENV['TEST_API_ENDPOINT']
+      Librato::Metrics.api_endpoint = ENV['TEST_API_ENDPOINT']
+    end
+    Librato::Metrics.authenticate ENV['TEST_API_USER'], ENV['TEST_API_KEY']
+  end
+
+  # purge all metrics from test account
+  def delete_all_metrics
+    connection = Librato::Metrics.connection
+    Librato::Metrics.list.each do |metric|
+      #puts "deleting #{metric['name']}..."
+      connection.delete(:path => "v1/metrics/#{metric['name']}", :expects => 204)
+    end
+  end
+
 end

data/spec/unit/metrics/queue_spec.rb

@@ -74,6 +74,17 @@ module Librato
         end
       end
 
+      describe "#empty?" do
+        it "should return true when nothing queued" do
+          subject.empty?.should be_true
+        end
+
+        it "should return false with queued items" do
+          subject.add :foo => {:type => :gauge, :value => 121212}
+          subject.empty?.should be_false
+        end
+      end
+
       describe "#gauges" do
         it "should return currently queued gauges" do
           subject.add :transactions => {:type => :counter, :value => 12345},
@@ -86,6 +97,19 @@ module Librato
         end
       end
 
+      describe "#size" do
+        it "should return empty if gauges and counters are emtpy" do
+          subject.size.should eq 0
+        end
+        it "should return count of gauges and counters if added" do
+          subject.add :transactions => {:type => :counter, :value => 12345},
+              :register_cents => {:type => :gauge, :value => 211101}
+          subject.add :transactions => {:type => :counter, :value => 12345},
+                      :register_cents => {:type => :gauge, :value => 211101}
+          subject.size.should eql 4
+        end
+      end
+
       describe "#submit" do
         before(:all) do
           Librato::Metrics.authenticate 'me@librato.com', 'foo'

data/spec/unit/metrics_spec.rb

@@ -16,22 +16,6 @@ module Librato
 
    end
 
-   describe "#list" do
-
-     context "without arguments" do
-
-       it "should list all metrics"
-
-     end
-
-     context "with a name argument" do
-
-       it "should list metrics that match"
-
-     end
-
-   end
-
    describe "#persistence" do
 
      it "should allow configuration of persistence method" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-02-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70249860959660 !ruby/object:Gem::Requirement
+  requirement: &70282326461040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 0.7.12
   type: :runtime
   prerelease: false
-  version_requirements: *70249860959660
+  version_requirements: *70282326461040
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70282326460600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70282326460600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70249860958680 !ruby/object:Gem::Requirement
+  requirement: &70282326460120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249860958680
+  version_requirements: *70282326460120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70249860956780 !ruby/object:Gem::Requirement
+  requirement: &70282326459480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70249860956780
+  version_requirements: *70282326459480
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70249860955580 !ruby/object:Gem::Requirement
+  requirement: &70282326458940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249860955580
+  version_requirements: *70282326458940
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70249860954580 !ruby/object:Gem::Requirement
+  requirement: &70282326458280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249860954580
+  version_requirements: *70282326458280
 description: An easy to use ruby wrapper for Librato's Metrics API
 email: matt@librato.com
 executables: []
@@ -81,6 +92,7 @@ files:
 - README.md
 - Rakefile
 - lib/librato/metrics.rb
+- lib/librato/metrics/collect.rb
 - lib/librato/metrics/errors.rb
 - lib/librato/metrics/persistence.rb
 - lib/librato/metrics/persistence/direct.rb
@@ -89,6 +101,7 @@ files:
 - lib/librato/metrics/simple.rb
 - lib/librato/metrics/version.rb
 - librato-metrics.gemspec
+- spec/integration/metrics_spec.rb
 - spec/spec_helper.rb
 - spec/unit/metrics/queue_spec.rb
 - spec/unit/metrics/simple_spec.rb
@@ -119,6 +132,7 @@ signing_key:
 specification_version: 2
 summary: Ruby wrapper for Librato's Metrics API
 test_files:
+- spec/integration/metrics_spec.rb
 - spec/spec_helper.rb
 - spec/unit/metrics/queue_spec.rb
 - spec/unit/metrics/simple_spec.rb