dogapi 1.10.0 → 1.11.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2Y1MzNkOWZlNzJmODkxZmY0OTczYmQxOTI1NGZlZGViODc2OTkyMg==
+  data.tar.gz: !binary |-
+    M2JkNGNhMTI2N2Y4NDczNzU0NDYyZmI3NGQyNjU1MzBkMWQxNjhmMw==
+SHA512:
+  metadata.gz: !binary |-
+    YjYzZTAyY2U2ZDU4ZjcxODZiNTRkY2Y2OGZkZTZlNTI2ZWQxNzZhY2I4ZTZi
+    M2JmN2M2YmJhZDA0ODFkZDE2ZmE1YmMxM2YwZjQzNDUwOGRmNjk3OTRmZWM5
+    MGI5MjU1N2UxZjllMzUyNGM3M2QwZjczNzNhZWUwMjAzN2FlYTU=
+  data.tar.gz: !binary |-
+    OTBkNTA4YTY5OWRjY2M0YmQ3MjMyZjUxYWM5MDcyODk3ZDcxNDhhZTY5ZGQ4
+    Mjg2MzI4MjhiNmU3YTQwNTAxMDY2YzA2NjE2ZDQxMmI1ZGQyZDZhM2FkNGZk
+    NDAzYjEyYWExZjQ3M2M5OWI0YzQ5NDQ1MjRkODFiOTk1YWM4ZDc=

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 Changes
 =======
+# 1.11.0 / 2014-07-03
+* Allow to send several metrics in the same http request
+* Add support for http proxy defined by the environment variables
 
 # 1.10.0 / 2014-05-13
 * Re-enable SSL verification ([#37](https://github.com/DataDog/dogapi-rb/issues/37))

data/examples/custom_metric.rb

@@ -27,3 +27,9 @@ end
 
 # And emit the data in one call
 dog.emit_points('test.api.test_metric', points)
+
+# Emit differents metrics in a single request to be more efficient
+dog.batch_metrics do
+  dog.emit_point('test.api.test_metric',10)
+  dog.emit_point('test.api.this_other_metric', 1, :type => 'counter')
+end

data/lib/dogapi/common.rb

@@ -79,11 +79,20 @@ module Dogapi
 
     # Manages the HTTP connection
     def connect
-      uri = URI.parse(@api_host)
-      session = Net::HTTP.new(uri.host, uri.port)
-      if 'https' == uri.scheme
-        session.use_ssl = true
+      connection = Net::HTTP
+
+      # After ruby 2.0 Net::HTTP looks for the env variable but not ruby 1.9
+      if RUBY_VERSION < "2.0.0"
+        proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"] || ENV["HTTP_PROXY"] || ENV["http_proxy"]
+        if proxy
+          proxy_uri = URI.parse(proxy)
+          connection = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+        end
       end
+
+      uri = URI.parse(@api_host)
+      session = connection.new(uri.host, uri.port)
+      session.use_ssl = uri.scheme == 'https'
       session.start do |conn|
         conn.read_timeout = @timeout
         yield(conn)

data/lib/dogapi/facade.rb

@@ -89,6 +89,16 @@ module Dogapi
       @metric_svc.submit(metric, points, scope, options)
     end
 
+    def batch_metrics()
+      @metric_svc.switch_to_batched
+      begin
+        yield
+        @metric_svc.flush_buffer
+      ensure
+        @metric_svc.switch_to_single
+      end
+    end
+
     #
     # EVENTS
 

data/lib/dogapi/v1/metric.rb

@@ -8,36 +8,74 @@ module Dogapi
 
       API_VERSION = "v1"
 
-      # Records an Event with no duration
-      def submit(metric, points, scope, options = {})
+      def upload(metrics)
         begin
           params = {
             :api_key => @api_key
           }
+          body = {
+            :series => metrics
+          }
+          request(Net::HTTP::Post, '/api/' + API_VERSION + '/series', params, body, true)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
+      end
+
+      def submit_to_api(metric, points, scope, options = {})
+        payload = self.make_metric_payload(metric, points, scope, options)
+        self.upload([payload])
+      end
+
+      def submit_to_buffer(metric, points, scope, options = {})
+        payload = self.make_metric_payload(metric, points, scope, options)
+        @buffer << payload
+      end
+
+      def flush_buffer()
+        self.upload(@buffer)
+        @buffer = nil
+      end
+
+      alias :submit :submit_to_api
+
+      def switch_to_batched()
+        alias :submit :submit_to_buffer
+        @buffer = Array.new
+      end
+
+      def switch_to_single()
+        @buffer = nil
+        alias :submit :submit_to_api
+      end
+
+      def make_metric_payload(metric, points, scope, options)
+        begin
           typ = options[:type] || "gauge"
 
           if typ != "gauge" && typ != "counter"
             raise ArgumentError, "metric type must be gauge or counter"
           end
 
-          body = {
-            :series => [
-              {
-                :metric => metric,
-                :points => points,
-                :type => typ,
-                :host => scope.host,
-                :device => scope.device
-              }
-            ]
+          metric_payload = {
+            :metric => metric,
+            :points => points,
+            :type => typ,
+            :host => scope.host,
+            :device => scope.device
           }
 
           # Add tags if there are any
           if not options[:tags].nil?
-            body[:series][0][:tags] = options[:tags]
+            metric_payload[:tags] = options[:tags]
           end
 
-          request(Net::HTTP::Post, '/api/' + API_VERSION + '/series', params, body, true)
+          return metric_payload
         rescue Exception => e
           if @silent
             warn e

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = "1.10.0"
+  VERSION = "1.11.0"
 end

data/spec/common_spec.rb

@@ -13,4 +13,25 @@ describe "Common" do
 
   end # end Scope
 
+  context "HttpConnection" do
+
+    it "respects the proxy configuration" do
+      service = Dogapi::APIService.new("api_key", "app_key")
+
+      service.connect do |conn|
+        expect(conn.proxy_address).to be(nil)
+        expect(conn.proxy_port).to be(nil)
+      end
+
+      ENV["http_proxy"] = "https://www.proxy.com:443"
+
+      service.connect do |conn|
+        expect(conn.proxy_address).to eq "www.proxy.com"
+        expect(conn.proxy_port).to eq 443
+      end
+
+      ENV["http_proxy"] = nil
+    end
+  end
+
 end # end Common

data/spec/facade_spec.rb

@@ -13,31 +13,73 @@ describe "Facade", :vcr => true do
 
     before(:each) do
       @dogmock = Dogapi::Client.new(@api_key, @app_key)
-      @metric_svc = double
-      @dogmock.instance_variable_set("@metric_svc", @metric_svc)
+      @service = @dogmock.instance_variable_get(:@metric_svc)
+      @service.instance_variable_set(:@uploaded, Array.new)
+      def @service.upload payload
+        @uploaded << payload
+      end
     end
 
     it "emit_point passes data" do
-      expect(@metric_svc).to receive(:submit) do |metric, points, scope, options|
-        expect(metric).to eq "metric.name"
-        expect(points[0][1]).to eq 0
-        expect(scope.host).to eq "myhost"
-      end
       @dogmock.emit_point("metric.name", 0, :host => "myhost")
+
+      uploaded =  @service.instance_variable_get(:@uploaded)
+      expect(uploaded.length).to eq 1
+      series = uploaded.first
+      expect(series.class).to eq Array
+      expect(series[0][:metric]).to eq "metric.name"
+      expect(series[0][:points][0][1]).to eq 0
+      expect(series[0][:host]).to eq "myhost"
     end
 
     it "emit_point uses localhost default" do
-      expect(@metric_svc).to receive(:submit) do |metric, points, scope, options|
-        expect(scope.host).to eq Dogapi.find_localhost
-      end
       @dogmock.emit_point("metric.name", 0)
+
+      uploaded =  @service.instance_variable_get(:@uploaded)
+      series = uploaded.first
+      expect(series[0][:host]).to eq Dogapi.find_localhost
     end
 
     it "emit_point can pass nil host" do
-      expect(@metric_svc).to receive(:submit) do |metric, points, scope, options|
-        expect(scope.host).to be_nil
-      end
       @dogmock.emit_point("metric.name", 0, :host => nil)
+
+      uploaded =  @service.instance_variable_get(:@uploaded)
+      series = uploaded.first
+      expect(series[0][:host]).to be_nil
+    end
+
+    it "emit_points can be batched" do
+      @dogmock.batch_metrics do
+        @dogmock.emit_point("metric.name", 1, :type => 'counter')
+        @dogmock.emit_point("othermetric.name", 2, :type => 'counter')
+      end
+      # Verify that we uploaded what we expected
+      uploaded =  @service.instance_variable_get(:@uploaded)
+      expect(uploaded.length).to eq 1
+      series = uploaded.first
+      expect(series.class).to eq Array
+      expect(series[0][:metric]).to eq 'metric.name'
+      expect(series[0][:points][0][1]).to eq 1
+      expect(series[0][:type]).to eq 'counter'
+      expect(series[1][:metric]).to eq 'othermetric.name'
+      expect(series[1][:points][0][1]).to eq 2
+      expect(series[1][:type]).to eq 'counter'
+
+      # Verify that the buffer was correclty emptied
+      buffer = @service.instance_variable_get(:@buffer)
+      expect(buffer).to be nil
+    end
+
+    it "flushes the buffer even if an exception is raised" do
+      begin
+        @dogmock.batch_metrics do
+          @dogmock.emit_point("metric.name", 1, :type => 'counter')
+          raise "Oh no, something went wrong"
+        end
+      rescue
+      end
+      buffer = @service.instance_variable_get(:@buffer)
+      expect(buffer).to be nil
     end
 
   end

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.10.0
-  prerelease: 
+  version: 1.11.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &21286080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *21286080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &21285400 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *21285400
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21284660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
-  version_requirements: *21284660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21284180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21284180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby bindings for Datadog's API
 email:
 - packages@datadoghq.com
@@ -124,6 +135,7 @@ files:
 homepage: http://datadoghq.com/
 licenses:
 - BSD
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --title
@@ -135,22 +147,20 @@ 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: 
-rubygems_version: 1.8.11
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings for Datadog's API
 test_files:
 - spec/alerts_spec.rb