dogapi 1.2.8 → 1.3.0

data/README.rdoc

@@ -1,9 +1,13 @@
-= Ruby client for Datadog API v1.2.8
+= Ruby client for Datadog API v1.3.0
 
 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.0
+
+* Capistrano integration. See https://github.com/DataDog/dogapi-rb/tree/master/lib/capistrano
+
 == v1.2.x
 
 * You can now manage host tags

data/lib/capistrano/README.md

@@ -0,0 +1,13 @@
+# capistrano/datadog
+
+Instrument your [Capistrano](https://github.com/capistrano/capistrano) deploys, generating events in Datadog which you can correlate with metrics in order to figure out what caused production issues.
+
+To set up your Capfile:
+
+    require "capistrano/datadog"
+    set :datadog_api_key, "my_api_key"
+
+You can find your Datadog API key [here](https://app.datad0g.com/account/settings#api). If you don't have a Datadog account, you can sign up for one [here](http://www.datadoghq.com/).
+
+`capistrano/datadog` will capture each Capistrano task that that Capfile runs, including the roles that the task applies to and any logging output that it emits and submits them as events to Datadog at the end of the execution of all the tasks. If sending to Datadog fails for any reason, your scripts will still succeed.
+

data/lib/capistrano/datadog.rb

@@ -0,0 +1,153 @@
+require "benchmark"
+require "etc"
+require "md5"
+require "socket"
+require "time"
+require "timeout"
+
+require "dogapi"
+
+# Monkeypatch capistrano to collect data about the tasks that it's running
+module Capistrano
+  class Configuration
+    module Execution
+      # Attempts to locate the task at the given fully-qualified path, and
+      # execute it. If no such task exists, a Capistrano::NoSuchTaskError 
+      # will be raised.
+      # Also, capture the time the task took to execute, and the logs it 
+      # outputted for submission to Datadog
+      def find_and_execute_task(path, hooks={})
+        task = find_task(path) or raise NoSuchTaskError, "the task `#{path}' does not exist"
+        result = nil
+        reporter = Capistrano::Datadog.reporter
+        timing = Benchmark.measure(task.fully_qualified_name) do
+          # Set the current task so that the logger knows which task to 
+          # associate the logs with
+          reporter.current_task = task.fully_qualified_name
+          trigger(hooks[:before], task) if hooks[:before]
+          result = execute_task(task)
+          trigger(hooks[:after], task) if hooks[:after]
+          reporter.current_task = nil
+        end
+        # Collect the timing in a list for later reporting
+        reporter.record_task task, timing
+        result
+      end
+    end
+  end
+
+  class Logger
+    # Make the device attribute writeable so we can swap it out
+    # with something that captures logging out by task
+    attr_accessor   :device
+  end
+end
+
+
+module Capistrano
+  module Datadog
+    # Singleton method for Reporter
+    def self.reporter()
+      @reporter || @reporter = Reporter.new
+    end
+
+    # Collects info about the tasks that ran in order to submit to Datadog
+    class Reporter
+      attr_accessor :current_task
+
+      def initialize()
+        @tasks = []
+        @current_task = nil
+        @logging_output = {}
+      end
+
+      def record_task(task, timing)
+        @tasks << {
+          :name   => task.fully_qualified_name,
+          :timing => timing.real,
+          :roles  => task.options[:roles]
+        }
+      end
+
+      def record_log(message)
+        if not @logging_output[@current_task] 
+          @logging_output[@current_task] = []
+        end
+        @logging_output[@current_task] << message
+      end
+
+      def report()
+        hostname = Socket.gethostname
+        user = Etc.getlogin
+
+        # Lazy randomness
+        aggregation_key = Digest::MD5.hexdigest "#{Time.new}|#{rand}"
+
+        # Convert the tasks into Datadog events
+        @tasks.map do |task|
+          name  = task[:name]
+          roles = (task[:roles] || []).sort
+          tags  = ["#capistrano"] + (roles.map { |t| '#role:' + t })
+          title = "%s@%s ran %s on %s with capistrano in %.2f secs" % [user, hostname, name, roles.join(', '), task[:timing]]
+          type  = "deploy"
+          alert_type = "success"
+          source_type = "capistrano"
+          message = "@@@" + "\n" + @logging_output[name].join('') + "@@@"
+
+          Dogapi::Event.new(message,
+            :msg_title        => title,
+            :event_type       => type,
+            :event_object     => aggregation_key,
+            :alert_type       => alert_type,
+            :source_type_name => source_type,
+            :tags             => tags
+          )
+        end
+      end
+    end
+
+    class LogCapture
+      def initialize(device)
+        @device = device
+      end
+
+      def puts(message)
+        Capistrano::Datadog::reporter.record_log message
+        @device.puts message
+      end
+    end
+  end
+
+  Configuration.instance(:must_exist).load do
+    # Wrap the existing logging target with the Datadog capture class
+    logger.device = Datadog::LogCapture.new logger.device
+
+    # Trigger the Datadog submission once all the tasks have run
+    on :exit, "datadog:submit"
+    namespace :datadog do
+      desc "Submit the tasks that have run to Datadog as events"
+      task :submit do |ns|
+        begin 
+          api_key = variables[:datadog_api_key]
+          if api_key
+            dog = Dogapi::Client.new(api_key)
+            Datadog::reporter.report.each do |event|
+              dog.emit_event event
+            end
+          else
+            puts "No api key set, not submitting to Datadog"
+          end
+        rescue Timeout::Error => e
+          puts "Could not submit to Datadog, request timed out."
+        rescue => e
+          puts "Could not submit to Datadog: #{e.inspect}\n#{e.backtrace.join("\n")}"
+        end
+      end
+    end
+  end
+
+
+end
+
+
+

data/tests/{tc_client.rb → test_client.rb}

@@ -24,7 +24,8 @@ class TestClient < Test::Unit::TestCase
     # post a metric to make sure the test host context exists
     dog.emit_point('test.tag.metric', 1, :host => hostname)
 
-    dog.all_tags()
+    # Disable this call until we fix the timeouts
+    # dog.all_tags()
 
     dog.detach_tags(hostname)
     code, resp = dog.host_tags(hostname)
@@ -72,9 +73,9 @@ class TestClient < Test::Unit::TestCase
 
     code, resp = dog_r.emit_event(Dogapi::Event.new(now_message, :msg_title =>now_title, :date_happened => now_ts))
     now_event_id = resp["event"]["id"]
-    sleep 1
     code, resp = dog_r.emit_event(Dogapi::Event.new(before_message, :msg_title =>before_title, :date_happened => before_ts))
     before_event_id = resp["event"]["id"]
+    sleep 3
 
     code, resp = dog.stream(before_ts, now_ts + 1)
     stream = resp["events"]

metadata

@@ -1,76 +1,97 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: dogapi
-version: !ruby/object:Gem::Version
-  version: 1.2.8
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
-authors:
+authors: 
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-04-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &9566260 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
         version: 1.5.1
   type: :runtime
-  prerelease: false
-  version_requirements: *9566260
+  version_requirements: *id001
 description: 
 email: packages@datadoghq.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.rdoc
-files:
-- lib/dogapi/v1.rb
-- lib/dogapi/event.rb
-- lib/dogapi/metric.rb
+files: 
+- lib/capistrano/datadog.rb
+- lib/capistrano/README.md
 - lib/dogapi/common.rb
+- lib/dogapi/event.rb
 - lib/dogapi/facade.rb
+- lib/dogapi/metric.rb
 - lib/dogapi/v1/event.rb
-- lib/dogapi/v1/tag.rb
 - lib/dogapi/v1/metric.rb
+- lib/dogapi/v1/tag.rb
+- lib/dogapi/v1.rb
 - lib/dogapi.rb
-- tests/tc_client.rb
-- tests/ts_dogapi.rb
+- tests/test_client.rb
 - README.rdoc
 homepage: http://datadoghq.com/
-licenses:
+licenses: 
 - BSD
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --title
 - DogAPI -- DataDog Client
 - --main
 - README.rdoc
 - --line-numbers
 - --inline-source
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for Datadog's API
-test_files:
-- tests/ts_dogapi.rb
+test_files: 
+- tests/test_client.rb

data/tests/ts_dogapi.rb

@@ -1,3 +0,0 @@
-require 'test/unit'
-
-require 'tc_client'