dogapi 1.3.2 → 1.3.3

data/README.rdoc

@@ -1,9 +1,18 @@
-= Ruby client for Datadog API v1.3.0
+= Ruby client for Datadog API v1.3.2
 
 The Ruby client is a library suitable for inclusion in existing Ruby projects or for development of standalone scripts. It provides an abstraction on top of Datadog's raw HTTP interface for reporting events and metrics.
 
 = What's new?
 
+== v1.3.2
+
+* Support an aggregation key to aggregate events together
+
+== v1.3.1
+
+* Metrics can be counters, rather than just gauges (thanks to @treeder)
+* Metrics can be tagged.
+
 == v1.3.0
 
 * Capistrano integration. See https://github.com/DataDog/dogapi-rb/tree/master/lib/capistrano
@@ -35,6 +44,15 @@ Gem page: https://rubygems.org/gems/dogapi
 
     $ gem install dogapi
 
+If you get a permission error, you might need to run the install process with sudo:
+
+    $ sudo gem install dogapi
+
+If you get a LoadError, missing mkmf, you need to install the development packages for ruby.
+
+    $ # on ubuntu e.g.
+    $ sudo apt-get install ruby-dev
+
 = Usage
 
 == How to find your API and application keys

data/lib/dogapi/common.rb

@@ -73,10 +73,11 @@ module Dogapi
 
   # Superclass that deals with the details of communicating with the DataDog API
   class APIService
-    def initialize(api_key, application_key)
+    def initialize(api_key, application_key, silent=true)
       @api_key = api_key
       @application_key = application_key
       @api_host = Dogapi.find_datadog_host()
+      @silent = silent
     end
 
     # Manages the HTTP connection

data/lib/dogapi/event.rb

@@ -52,9 +52,9 @@ module Dogapi
     # Copy and pasted from the internets 
     # http://stackoverflow.com/a/5031637/25276
     def to_hash
-      Hash[instance_variables.map { |var| 
-        [var[1..-1].to_sym, instance_variable_get(var)] 
-      }]
+        hash = {}
+        instance_variables.each {|var| hash[var[1..-1].to_sym] = instance_variable_get(var) }
+        hash
     end
   end
 

data/lib/dogapi/facade.rb

@@ -11,7 +11,7 @@ module Dogapi
   class Client
 
     # Create a new Client optionally specifying a default host and device
-    def initialize(api_key, application_key=nil, host=nil, device=nil)
+    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true)
 
       if api_key
         @api_key = api_key
@@ -26,9 +26,9 @@ module Dogapi
       @host = host
       @device = device
 
-      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key)
-      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key)
-      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key)
+      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent)
+      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent)
+      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent)
 
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
     end

data/lib/dogapi/v1/event.rb

@@ -10,59 +10,86 @@ module Dogapi
 
       # Records an Event with no duration
       def post(event, scope=nil)
-        scope = scope || Dogapi::Scope.new()
-        params = {
-          :api_key => @api_key
-        }
-        
-        body = event.to_hash.merge({
-          :title => event.msg_title,
-          :text => event.msg_text,
-          :date_happened => event.date_happened.to_i,
-          :host => scope.host,
-          :device => scope.device,
-          :aggregation_key => event.aggregation_key.to_s
-        })
+        begin
+          scope = scope || Dogapi::Scope.new()
+          params = {
+            :api_key => @api_key
+          }
 
-        request(Net::HTTP::Post, '/api/v1/events', params, body, true)
+          body = event.to_hash.merge({
+            :title => event.msg_title,
+            :text => event.msg_text,
+            :date_happened => event.date_happened.to_i,
+            :host => scope.host,
+            :device => scope.device,
+            :aggregation_key => event.aggregation_key.to_s
+          })
+
+          request(Net::HTTP::Post, '/api/v1/events', params, body, true)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
       def get(id)
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key
-        }
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
 
-        request(Net::HTTP::Get, '/api/' + API_VERSION + '/events/' + id.to_s, params, nil, false)
+          request(Net::HTTP::Get, '/api/' + API_VERSION + '/events/' + id.to_s, params, nil, false)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
       def stream(start, stop, options={})
-        defaults = {
-          :priority => nil,
-          :sources => nil,
-          :tags => nil
-        }
-        options = defaults.merge(options)
+        begin
+          defaults = {
+            :priority => nil,
+            :sources => nil,
+            :tags => nil
+          }
+          options = defaults.merge(options)
 
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key,
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key,
 
-          :start => start.to_i,
-          :end => stop.to_i
-        }
+            :start => start.to_i,
+            :end => stop.to_i
+          }
 
-        if options[:priority]
-          params[:priority] = options[:priority]
-        end
-        if options[:sources]
-          params[:sources] = options[:sources]
-        end
-        if options[:tags]
-          params[:tags] = options[:tags]
-        end
+          if options[:priority]
+            params[:priority] = options[:priority]
+          end
+          if options[:sources]
+            params[:sources] = options[:sources]
+          end
+          if options[:tags]
+            params[:tags] = options[:tags]
+          end
 
-        request(Net::HTTP::Get, '/api/' + API_VERSION + '/events', params, nil, false)
+          request(Net::HTTP::Get, '/api/' + API_VERSION + '/events', params, nil, false)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
     end

data/lib/dogapi/v1/metric.rb

@@ -10,33 +10,42 @@ module Dogapi
 
       # Records an Event with no duration
       def submit(metric, points, scope, options={})
-        params = {
-          :api_key => @api_key
-        }
-        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
-            }
-          ]
-        }
-
-
-        # Add tags if there are any
-        if not options[:tags].nil?
-          body[:series][0][:tags] = options[:tags]
+        begin
+          params = {
+            :api_key => @api_key
+          }
+          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
+              }
+            ]
+          }
+
+
+          # Add tags if there are any
+          if not options[:tags].nil?
+            body[:series][0][:tags] = options[:tags]
+          end
+
+          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
-
-        request(Net::HTTP::Post, '/api/' + API_VERSION + '/series', params, body, true)
       end
     end
 

data/lib/dogapi/v1/tag.rb

@@ -10,50 +10,86 @@ module Dogapi
 
       # Gets all tags in your org and the hosts tagged with them
       def get_all()
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key
-        }
-
-        request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts', params, nil, false)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts', params, nil, false)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
       # Gets all tags for a given host
       def get(host_id)
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key
-        }
-
-        request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, nil, false)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, nil, false)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
       # Adds a list of tags to a host
       def add(host_id, tags)
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key
-        }
-
-        body = {
-          :tags => tags
-        }
-
-        request(Net::HTTP::Post, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, body, true)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+            :tags => tags
+          }
+
+          request(Net::HTTP::Post, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, body, true)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
       # Remove all tags from a host and replace them with a new list
       def update(host_id, tags)
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key
-        }
-
-        body = {
-          :tags => tags
-        }
-
-        request(Net::HTTP::Put, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, body, true)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+            :tags => tags
+          }
+
+          request(Net::HTTP::Put, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, body, true)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
       # <b>DEPRECATED:</b> Spelling mistake temporarily preserved as an alias.
@@ -64,12 +100,21 @@ module Dogapi
 
       # Remove all tags from a host
       def detach(host_id)
-        params = {
-          :api_key => @api_key,
-          :application_key => @application_key
-        }
-
-        request(Net::HTTP::Delete, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, nil, false)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Delete, '/api/' + API_VERSION + '/tags/hosts/' + host_id.to_s, params, nil, false)
+        rescue Exception => e
+          if @silent
+            warn e
+            return -1, {}
+          else
+            raise e
+          end
+        end
       end
 
     end

data/tests/test_client.rb

@@ -97,9 +97,11 @@ class TestClient < Test::Unit::TestCase
     # Testing priorities
     code, resp = dog_r.emit_event(Dogapi::Event.new(now_message, :msg_title =>now_title, :date_happened => now_ts, :priority => "low"))
     low_event_id = resp["event"]["id"]
+
+    sleep 3
+
     code, resp = dog.get_event(low_event_id)
     low_event = resp['event']
-    puts low_event
     assert low_event['priority'] == "low"
 
     # Testing aggregates

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 2
-  version: 1.3.2
+  - 3
+  version: 1.3.3
 platform: ruby
 authors: 
 - Datadog, Inc.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-04 00:00:00 -04:00
+date: 2012-07-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency