dogapi 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d44d23ffcc6ef539b6d85ae691647b700bba462
-  data.tar.gz: 0ea1557fa601f2c90b751ff9770bb53f15e90096
+  metadata.gz: b8af26835da807d734048331e326f41734ad0d43
+  data.tar.gz: f7adbdd5a2a4afa6ae81d39a8250ad74692656ef
 SHA512:
-  metadata.gz: 3e2240ad05c8be24a809610af6155df3abbd170fe9e6a8c3ce6e69cefbd7f27272a54b68867ccd87f198ff892acbbfb779574b9212b4b94223c5fe368f89b6fc
-  data.tar.gz: 6606add9a66b617449930b3181e9ee6ca5cb467b7e9e701932630c39484006d0ad75c168fdf2b4886f6b96941cba5f6577ef317dce46e984e4ffaff1cdbcb6d2
+  metadata.gz: 9c679456882e5e7babf2cee567f0cdd1f4bf67c477b07a7e3195c0103b704fd9131569564df1c43583832635ffcb794c8ebe91952d2ecee5353f58f28f062f8f
+  data.tar.gz: 54df8543e2c6b0fb4d771b323d01c3190ac1204fb7cf138c83f16b3579dea6003712f46723f7b481399053ea807ada33ef23a6717edfe789afee309af16b7b9b

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 Changes
 =======
 
-# 1.23.0 / Unreleased
+# 1.24.0 / 2017-01-12
+
+* [FEATURE] Add the ability to record events per host and to filter events. See [#115][] (thanks [@hnovikov][])
+* [BUGFIX] Encode extra\_params to handle spaces. See [#113][] (thanks [@miknight][])
+* [BUGFIX] Fix CaptureIO delegation and output with Capistrano >= 3.5. See [#114][] (thanks [@casperisfine][])
+
+# 1.23.0 / 2016-08-24
 
 * [FEATURE] Add Datadog endpoint to configuration. See [#108][]
 * [FEATURE] Add delete method for events. See [#99][], [#109][]
@@ -159,12 +165,18 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#106]: https://github.com/DataDog/dogapi-rb/issues/106
 [#108]: https://github.com/DataDog/dogapi-rb/issues/108
 [#109]: https://github.com/DataDog/dogapi-rb/issues/109
+[#113]: https://github.com/DataDog/dogapi-rb/issues/113
+[#114]: https://github.com/DataDog/dogapi-rb/issues/114
+[#115]: https://github.com/DataDog/dogapi-rb/issues/115
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@ansel1]: https://github.com/ansel1
 [@arielo]: https://github.com/arielo
 [@blakehilscher]: https://github.com/blakehilscher
 [@byroot]: https://github.com/byroot
+[@casperisfine]: https://github.com/casperisfine
+[@hnovikov]: https://github.com/hnovikov
+[@miknight]: https://github.com/miknight
 [@nots]: https://github.com/nots
 [@rmoriz]: https://github.com/rmoriz
 [@treeder]: https://github.com/treeder

data/Gemfile

@@ -7,9 +7,18 @@ group :test do
   gem 'rspec'
   gem 'rubocop', '~> 0.41.2'
   gem 'simplecov'
-  gem 'webmock'
   if RbConfig::CONFIG['ruby_version'].start_with?("1.9")
-  	gem 'json', '< 2'
+    gem 'json', '< 2'
+    gem 'public_suffix', '< 1.5'
+    gem 'rdoc', '< 5'
+    gem 'term-ansicolor', '< 1.4'
+    gem 'webmock', '< 2.3'
+    gem 'nokogiri', '< 1.7'
+  elsif RbConfig::CONFIG['ruby_version'].start_with?("2.0")
+    gem 'nokogiri', '< 1.7'
+    gem 'webmock'
+  else
+    gem 'webmock'
   end
 end
 

data/lib/capistrano/README.md

@@ -7,6 +7,17 @@ To set up your Capfile:
     require "capistrano/datadog"
     set :datadog_api_key, "my_api_key"
 
+    # (optional) create an event for every host
+    # default: create a global event
+    # Warning: as this feature can create a lot of events,
+    # please use it in conjonction with datadog_event_filter
+    # set :datadog_record_hosts, false
+
+    # (optional) filter the events sent to Datadog
+    # default: no filter
+    # for instance, only push the production event
+    # set :datadog_event_filter, proc { |event, hosts| event.msg_title.include?('ran production') ? [event, hosts] : nil }
+
 You can find your Datadog API key [here](https://app.datadoghq.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

@@ -26,8 +26,14 @@ module Capistrano
       begin
         if api_key
           dog = Dogapi::Client.new(api_key)
-          reporter.report.each do |event|
-            dog.emit_event event
+          reporter.report.each do |event, hosts|
+            if hosts.size > 0
+              hosts.each do |host|
+                dog.emit_event event, host: host
+              end
+            else
+              dog.emit_event event
+            end
           end
         else
           puts 'No api key set, not submitting to Datadog'
@@ -41,29 +47,44 @@ module Capistrano
 
     # Collects info about the tasks that ran in order to submit to Datadog
     class Reporter
-      attr_accessor :current_task
+      attr_accessor :event_filter
 
       def initialize()
         @tasks = []
-        @current_task = nil
-        @logging_output = {}
+        @task_stack = []
       end
 
-      def record_task(task_name, timing, roles, stage=nil, application_name=nil)
-        @tasks << {
+      def record_task(task_name, roles, stage=nil, application_name=nil)
+        task = {
           :name   => task_name,
-          :timing => timing,
           :roles  => roles,
           :stage  => stage,
-          :application => application_name
+          :application => application_name,
+          :logs => [],
+          :hosts => []
         }
+        @tasks << task
+        @task_stack << task
+        result = nil
+        timing = Benchmark.measure(task_name) do
+          result = yield
+        end
+        task[:timing] = timing.real
+        @task_stack.pop
+        result
       end
 
       def record_log(message)
-        if not @logging_output[@current_task]
-          @logging_output[@current_task] = []
+        current_task = @task_stack.last
+        if current_task
+          current_task[:logs] << message
+        end
+      end
+
+      def record_hostname(hostname)
+        @task_stack.each do |task|
+          task[:hosts] << hostname
         end
-        @logging_output[@current_task] << message
       end
 
       def report()
@@ -73,6 +94,8 @@ module Capistrano
         # Lazy randomness
         aggregation_key = Digest::MD5.hexdigest "#{Time.new}|#{rand}"
 
+        filter = event_filter || proc { |x| x }
+
         # Convert the tasks into Datadog events
         @tasks.map do |task|
           name  = task[:name]
@@ -89,21 +112,21 @@ module Capistrano
           type  = 'deploy'
           alert_type = 'success'
           source_type = 'capistrano'
-          message_content = (@logging_output[name] || []).join('')
+          message_content = task[:logs].join('')
           message = if !message_content.empty? then
             # Strip out color control characters
             message_content = sanitize_encoding(message_content).gsub(/\e\[(\d+)m/, '')
             "@@@\n#{message_content}@@@" else '' end
 
-          Dogapi::Event.new(message,
+          [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
+          ), task[:hosts]]
+        end.map(&event_filter).reject(&:nil?)
       end
 
       def sanitize_encoding(string)

data/lib/capistrano/datadog/v2.rb

@@ -14,28 +14,20 @@ module Capistrano
       # 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
         task_name = task.fully_qualified_name
-        timing = Benchmark.measure(task_name) do
-          # Set the current task so that the logger knows which task to
-          # associate the logs with
-          reporter.current_task = task_name
-          trigger(hooks[:before], task) if hooks[:before]
-          result = execute_task(task)
-          trigger(hooks[:after], task) if hooks[:after]
-          reporter.current_task = nil
-        end
 
-        # Record the task name, its timing and roles
         roles = task.options[:roles]
         if roles.is_a? Proc
           roles = roles.call
         end
-        reporter.record_task(task_name, timing.real, roles, task.namespace.variables[:stage], fetch(:application))
 
-        # Return the original result
-        result
+        reporter.record_task(task_name, roles, task.namespace.variables[:stage], fetch(:application)) do
+          trigger(hooks[:before], task) if hooks[:before]
+          result = execute_task(task)
+          trigger(hooks[:after], task) if hooks[:after]
+          result
+        end
       end
     end
   end

data/lib/capistrano/datadog/v3.rb

@@ -1,4 +1,5 @@
 require 'benchmark'
+require 'delegate'
 require 'sshkit/formatters/pretty'
 require 'sshkit/formatters/simple_text'
 
@@ -8,41 +9,51 @@ module Rake
   class Task
     alias old_invoke invoke
     def invoke(*args)
-      result = nil
       reporter = Capistrano::Datadog.reporter
+      event_filter = Capistrano::Configuration.env.fetch(:datadog_event_filter)
+      if event_filter
+        reporter.event_filter = event_filter
+      end
       task_name = name
-      reporter.current_task = task_name
-      timing = Benchmark.measure(task_name) do
-        result = old_invoke(*args)
+      stage = Capistrano::Configuration.env.fetch(:stage)
+      application = Capistrano::Configuration.env.fetch(:application)
+      reporter.record_task(task_name, roles, stage, application) do
+        old_invoke(*args)
       end
-      reporter.record_task(task_name, timing.real, roles,
-        Capistrano::Configuration.env.fetch(:stage), Capistrano::Configuration.env.fetch(:application))
-      result
     end
   end
 end
 
 module Capistrano
+  module DSL
+    alias old_on on
+    def on(hosts, *args, &block)
+      old_on(hosts, *args) do |host|
+        if Capistrano::Configuration.env.fetch(:datadog_record_hosts)
+          Capistrano::Datadog.reporter.record_hostname(host)
+        end
+        self.instance_exec(host, &block)
+      end
+    end
+  end
+
   module Datadog
-    class CaptureIO
+    class CaptureIO < SimpleDelegator
       def initialize(wrapped)
+        super
         @wrapped = wrapped
       end
 
       def write(*args)
         # Check if Capistrano version >= 3.5.0
         if Gem::Version.new(VERSION) >= Gem::Version.new('3.5.0')
-          @wrapped << args
+          @wrapped << args.join
         else
           @wrapped.write(*args)
         end
         args.each { |arg| Capistrano::Datadog.reporter.record_log(arg) }
       end
       alias :<< :write
-
-      def close
-        @wrapped.close
-      end
     end
   end
 end

data/lib/dogapi/common.rb

@@ -136,7 +136,7 @@ module Dogapi
       params = { api_key: @api_key }
       params[:application_key] = @application_key if with_app_key
       params = extra_params.merge params unless extra_params.nil?
-      qs_params = params.map { |k, v| k.to_s + '=' + v.to_s }
+      qs_params = params.map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }
       qs = '?' + qs_params.join('&')
       qs
     end

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = '1.23.0'
+  VERSION = '1.24.0'
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby bindings for Datadog's API
@@ -74,11 +74,11 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".tailor"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .tailor
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -135,27 +135,27 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--title"
+- --title
 - DogAPI -- Datadog Client
-- "--main"
+- --main
 - README.rdoc
-- "--line-numbers"
-- "--inline-source"
+- --line-numbers
+- --inline-source
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Datadog's API
@@ -177,4 +177,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/common_spec.rb
 - spec/unit/facade_spec.rb
-has_rdoc: true