chef-handler-datadog 0.6.0 → 0.7.0

data/lib/chef/handler/datadog_chef_events.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+require 'rubygems'
+require 'chef/handler'
+require 'chef/mash'
+require 'dogapi'
+
+# helper class for sending events about chef runs
+class DatadogChefEvents
+  def initialize
+    @dog = nil
+    @hostname = nil
+    @run_status = nil
+    @failure_notfications = nil
+
+    @alert_type = ''
+    @event_priority = ''
+    @event_title = ''
+    # TODO: refactor how event_body is constructed in the class methods
+    #       handling of the event_body is a bit clunky and depends on the order of
+    #       method calls
+    @event_body = ''
+  end
+
+  # set the dogapi client handle
+  #
+  # @param dogapi_client [Dogapi::Client] datadog api client handle
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_dogapi_client(dogapi_client)
+    @dog = dogapi_client
+    self
+  end
+
+  # set the target hostname (chef node name)
+  #
+  # @param hostname [String] hostname to use for the handler report
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_hostname(hostname)
+    @hostname = hostname
+    self
+  end
+
+  # set the chef run status used for the report
+  #
+  # @param run_status [Chef::RunStatus] current chef run status
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_run_status(run_status)
+    @run_status = run_status
+    self
+  end
+
+  # set the failure notification list
+  #
+  # @param failure_notifications [Array] set of datadog notification handles
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_failure_notifications(failure_notifications)
+    @failure_notifications = failure_notifications
+    self
+  end
+
+  # set the datadog host tags associated with the event
+  #
+  # @param [Array] the set of host tags
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_tags(tags)
+    @tags = tags
+    self
+  end
+
+  # Emit Chef event to Datadog
+  def emit_to_datadog
+    @event_body = ''
+    build_event_data
+    evt = @dog.emit_event(Dogapi::Event.new(@event_body,
+                                            msg_title: @event_title,
+                                            event_type: 'config_management.run',
+                                            event_object: @hostname,
+                                            alert_type: @alert_type,
+                                            priority: @event_priority,
+                                            source_type_name: 'chef',
+                                            tags: @tags
+                                           ), host: @hostname)
+
+    begin
+      # FIXME: nice-to-have: abstract format of return value away a bit
+      # in dogapi directly. See https://github.com/DataDog/dogapi-rb/issues/18
+      if evt.length < 2
+        Chef::Log.warn("Unexpected response from Datadog Event API: #{evt}")
+      else
+        # [http_response_code, {"event" => {"url" => "...", ...}}]
+        # 2xx means ok
+        if evt[0].to_i / 100 != 2
+          Chef::Log.warn("Could not submit event to Datadog (HTTP call failed): #{evt[0]}")
+        else
+          Chef::Log.debug("Successfully submitted Chef event to Datadog for #{@hostname} at #{evt[1]['event']['url']}")
+        end
+      end
+    rescue
+      Chef::Log.warn("Could not determine whether chef run was successfully submitted to Datadog: #{evt}")
+    end
+  end
+
+  private
+
+  def pluralize(number, noun)
+    case number
+    when 0..1
+      "less than 1 #{noun}"
+    else
+      "#{number.round} #{noun}s"
+    end
+  rescue
+    Chef::Log.warn("Cannot make #{number} more legible")
+    "#{number} #{noun}s"
+  end
+
+  # Compose a list of resources updated during a run.
+  def update_resource_list
+    # No resources updated?
+    return unless @run_status.updated_resources.length.to_i > 0
+
+    if @run_status.failed?
+      # Shorten the list when there is a failure for stacktrace debugging
+      report_resources = @run_status.updated_resources.last(5)
+    else
+      report_resources = @run_status.updated_resources
+    end
+
+    @event_body = "\n$$$\n"
+    report_resources.each do |r|
+      @event_body << "- #{r} (#{r.defined_at})\n"
+    end
+    @event_body << "\n$$$\n"
+  end
+
+  # Marshal the Event data for submission
+  def build_event_data
+    # bail early in case of a compiletime failure
+    # OPTIMIZE: Use better inspectors to handle failure scenarios, refactor needed.
+    if @run_status.elapsed_time.nil?
+      @alert_type = 'error'
+      @event_title = "Chef failed during compile phase on #{@hostname} "
+      @event_priority = 'normal'
+      @event_body = 'Chef was unable to complete a run, an error during compilation may have occurred.'
+    else
+      run_time = pluralize(@run_status.elapsed_time, 'second')
+
+      # This is the first line of the Event body, the rest is appended here.
+      @event_body = "Chef updated #{@run_status.updated_resources.length} resources out of #{@run_status.all_resources.length} resources total."
+
+      # Update resource list, truncated when failed to 5
+      # update will add to the event_body
+      update_resource_list
+
+      if @run_status.success?
+        @alert_type = 'success'
+        @event_priority = 'low'
+        @event_title = "Chef completed in #{run_time} on #{@hostname} "
+      else
+        @alert_type = 'error'
+        @event_priority = 'normal'
+        @event_title = "Chef failed in #{run_time} on #{@hostname} "
+
+        if @failure_notifications
+          handles = @failure_notifications
+          # convert the notification handle array to a string
+          @event_body << "\nAlerting: #{handles.join(' ')}\n"
+        end
+
+        @event_body << "\n$$$\n#{@run_status.formatted_exception}\n$$$\n"
+        @event_body << "\n$$$\n#{@run_status.backtrace.join("\n")}\n$$$\n"
+      end
+    end
+  end
+end # end module DatadogChefEvent

data/lib/chef/handler/datadog_chef_metrics.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'dogapi'
+
+# helper class for sending datadog metrics from a chef run
+class DatadogChefMetrics
+  def initialize
+    @dog = nil
+    @hostname = ''
+    @run_status = nil
+  end
+
+  # set the dogapi client handle
+  #
+  # @param dogapi_client [Dogapi::Client] datadog api client
+  # @return [DatadogChefMetrics] instance reference to self enabling method chaining
+  def with_dogapi_client(dogapi_client)
+    @dog = dogapi_client
+    self
+  end
+
+  # set the target hostname (chef node name)
+  #
+  # @param hostname [String] hostname used for reporting metrics
+  # @return [DatadogChefMetrics] instance reference to self enabling method chaining
+  def with_hostname(hostname)
+    @hostname = hostname
+    self
+  end
+
+  # set the chef run status used for the report
+  #
+  # @param run_status [Chef::RunStatus] current run status
+  # @return [DatadogChefMetrics] instance reference to self enabling method chaining
+  def with_run_status(run_status)
+    @run_status = run_status
+    self
+  end
+
+  # Emit Chef metrics to Datadog
+  def emit_to_datadog
+    # If there is a failure during compile phase, a large portion of
+    # run_status may be unavailable. Bail out here
+    warn_msg = 'Error during compile phase, no Datadog metrics available.'
+    return Chef::Log.warn(warn_msg) if @run_status.elapsed_time.nil?
+
+    @dog.emit_point('chef.resources.total', @run_status.all_resources.length, host: @hostname)
+    @dog.emit_point('chef.resources.updated', @run_status.updated_resources.length, host: @hostname)
+    @dog.emit_point('chef.resources.elapsed_time', @run_status.elapsed_time, host: @hostname)
+    Chef::Log.debug('Submitted Chef metrics back to Datadog')
+  rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT => e
+    Chef::Log.error("Could not send metrics to Datadog. Connection error:\n" + e)
+  end
+end # end class DatadogChefMetrics

data/lib/chef/handler/datadog_chef_tags.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+require 'rubygems'
+require 'chef/handler'
+require 'chef/mash'
+require 'dogapi'
+
+# helper class for sending datadog tags from chef runs
+class DatadogChefTags
+  def initialize
+    @node = nil
+    @run_status = nil
+    @application_key = nil
+    @combined_host_tags = nil
+  end
+
+  # set the dogapi client handle
+  #
+  # @param dogapi_client [Dogapi::Client] datadog api client handle
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_dogapi_client(dogapi_client)
+    @dog = dogapi_client
+    self
+  end
+
+  # attribute accessor for combined array of tags
+  #
+  # @return [Array] the set of host tags based off the chef run
+  attr_reader :combined_host_tags
+
+  # set the chef run status used for the report
+  #
+  # @param run_status [Chef::RunStatus] current chef run status
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_run_status(run_status)
+    @run_status = run_status
+    # Build up an array of Chef tags that will be sent back
+    # Selects all [env, roles, tags] from the Node's object and reformats
+    # them to `key:value` e.g. `role:database-master`.
+    @node = run_status.node
+    # generate the combined tags
+    chef_env = node_env.split # converts a string into an array
+    chef_roles = node_roles
+    chef_tags = node_tags
+
+    # Combine (union) all arrays. Removes duplicates if found.
+    @combined_host_tags = chef_env | chef_roles | chef_tags
+    self
+  end
+
+  # set the target hostname (chef node name)
+  #
+  # @param hostname [String] hostname to use for the handler report
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_hostname(hostname)
+    @hostname = hostname
+    self
+  end
+
+  # set the datadog application key
+  #
+  # TODO: the application key is only needed for error checking, e.g. an app key exists
+  #   would be cleaner to push this check up to the data prep method in the
+  #   calling handler class
+  #
+  # @param application_key [String] datadog application key used for chef reports
+  # @return [DatadogChefTags] instance reference to self enabling method chaining
+  def with_application_key(application_key)
+    @application_key = application_key
+    if @application_key.nil?
+      Chef::Log.warn('You need an application key to let Chef tag your nodes ' \
+              'in Datadog. Visit https://app.datadoghq.com/account/settings#api to ' \
+                'create one and update your datadog attributes in the datadog cookbook.'
+                    )
+      fail ArgumentError, 'Missing Datadog Application Key'
+    end
+    self
+  end
+
+  # send updated chef run generated tags to Datadog
+  def send_update_to_datadog
+    rc = @dog.update_tags(@hostname, combined_host_tags, 'chef')
+    begin
+      # See FIXME above about why I feel dirty repeating this code here
+      if rc.length < 2
+        Chef::Log.warn("Unexpected response from Datadog Event API: #{rc}")
+      else
+        if rc[0].to_i / 100 != 2
+          Chef::Log.warn("Could not submit #{combined_host_tags} tags for #{@hostname} to Datadog: #{rc}")
+        else
+          Chef::Log.debug("Successfully updated #{@hostname}'s tags to #{combined_host_tags.join(', ')}")
+        end
+      end
+    rescue
+      Chef::Log.warn("Could not determine whether #{@hostname}'s tags were successfully submitted to Datadog: #{rc}")
+    end
+  end
+
+  private
+
+  def node_roles
+    @node.run_list.roles.map! { |role| 'role:' + role }
+  end
+
+  def node_env
+    'env:' + @node.chef_environment if @node.respond_to?('chef_environment')
+  end
+
+  def node_tags
+    @node.tags.map! { |tag| 'tag:' + tag } if @node.tags
+  end
+end # end class DatadogChefTags

data/lib/chef_handler_datadog.rb

@@ -2,5 +2,5 @@
 # Helper module for version number only.
 # Real deal in 'chef/handler/datadog.rb'
 module ChefHandlerDatadog
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/spec/datadog_spec.rb

@@ -182,13 +182,12 @@ describe Chef::Handler::Datadog, :vcr => :new_episodes do
     end
   end
 
-  describe 'handles tags correctly' do
+  context 'tags' do
     before(:each) do
       @node = Chef::Node.build('chef.handler.datadog.test-tags')
 
       @node.send(:chef_environment, 'hostile')
       @node.send(:run_list, 'role[highlander]')
-      @node.normal.tags = ['the_one_and_only']
 
       @events = Chef::EventDispatch::Dispatcher.new
       @run_context = Chef::RunContext.new(@node, {}, @events)
@@ -200,20 +199,37 @@ describe Chef::Handler::Datadog, :vcr => :new_episodes do
       @run_status.stop_clock
 
       @run_status.run_context = @run_context
+    end
 
-      # Run the report
-      @handler.run_report_unsafe(@run_status)
+    describe 'when specified' do
+      it 'sets the role and env and tags' do
+        @node.normal.tags = ['the_one_and_only']
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'tag:the_one_and_only'
+            ]),
+        )).to have_been_made.times(1)
+      end
     end
 
-    it 'sets the role and env and tags' do
-      expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
-        :query => { 'api_key' => @handler.config[:api_key],
-                    'application_key' => @handler.config[:application_key],
-                    'source' => 'chef' },
-        :body => hash_including(:tags => [
-          'env:hostile', 'role:highlander', 'tag:the_one_and_only'
-          ]),
-      )).to have_been_made.times(1)
+    describe 'when unspecified' do
+      it 'sets role, env and nothing else' do
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander'
+            ]),
+        )).to have_been_made.times(1)
+      end
     end
   end
 

data/spec/support/cassettes/Chef_Handler_Datadog/{handles_tags_correctly → tags/when_specified}/sets_the_role_and_env_and_tags.yml

@@ -5,10 +5,12 @@ http_interactions:
     uri: https://app.datadoghq.com/api/v1/series?api_key=<API_KEY>
     body:
       encoding: UTF-8
-      string: ! '{"series":[{"metric":"chef.resources.total","points":[[1410264919,0.0]],"type":"gauge","host":"chef.handler.datadog.test-tags","device":null}]}'
+      string: '{"series":[{"metric":"chef.resources.total","points":[[1428248966,0.0]],"type":"gauge","host":"chef.handler.datadog.test-tags","device":null}]}'
     headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
       User-Agent:
       - Ruby
       Content-Type:
@@ -21,27 +23,31 @@ http_interactions:
       Content-Type:
       - text/json; charset=UTF-8
       Date:
-      - Tue, 09 Sep 2014 12:15:14 GMT
+      - Sun, 05 Apr 2015 15:49:21 GMT
       Server:
-      - dogdispatcher/5.2.0
+      - dogdispatcher/6.1.23
+      Strict-Transport-Security:
+      - max-age=15724800;
       Content-Length:
       - '15'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"status":"ok"}'
+      encoding: UTF-8
+      string: '{"status":"ok"}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 12:15:19 GMT
+  recorded_at: Sun, 05 Apr 2015 15:49:26 GMT
 - request:
     method: post
     uri: https://app.datadoghq.com/api/v1/series?api_key=<API_KEY>
     body:
       encoding: UTF-8
-      string: ! '{"series":[{"metric":"chef.resources.updated","points":[[1410264919,0.0]],"type":"gauge","host":"chef.handler.datadog.test-tags","device":null}]}'
+      string: '{"series":[{"metric":"chef.resources.updated","points":[[1428248966,0.0]],"type":"gauge","host":"chef.handler.datadog.test-tags","device":null}]}'
     headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
       User-Agent:
       - Ruby
       Content-Type:
@@ -54,27 +60,31 @@ http_interactions:
       Content-Type:
       - text/json; charset=UTF-8
       Date:
-      - Tue, 09 Sep 2014 12:15:15 GMT
+      - Sun, 05 Apr 2015 15:49:22 GMT
       Server:
-      - dogdispatcher/5.1.1
+      - dogdispatcher/6.1.23
+      Strict-Transport-Security:
+      - max-age=15724800;
       Content-Length:
       - '15'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"status":"ok"}'
+      encoding: UTF-8
+      string: '{"status":"ok"}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 12:15:19 GMT
+  recorded_at: Sun, 05 Apr 2015 15:49:26 GMT
 - request:
     method: post
     uri: https://app.datadoghq.com/api/v1/series?api_key=<API_KEY>
     body:
       encoding: UTF-8
-      string: ! '{"series":[{"metric":"chef.resources.elapsed_time","points":[[1410264919,5.0]],"type":"gauge","host":"chef.handler.datadog.test-tags","device":null}]}'
+      string: '{"series":[{"metric":"chef.resources.elapsed_time","points":[[1428248966,5.0]],"type":"gauge","host":"chef.handler.datadog.test-tags","device":null}]}'
     headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
       User-Agent:
       - Ruby
       Content-Type:
@@ -87,30 +97,34 @@ http_interactions:
       Content-Type:
       - text/json; charset=UTF-8
       Date:
-      - Tue, 09 Sep 2014 12:15:15 GMT
+      - Sun, 05 Apr 2015 15:49:23 GMT
       Server:
-      - dogdispatcher/5.1.1
+      - dogdispatcher/6.1.23
+      Strict-Transport-Security:
+      - max-age=15724800;
       Content-Length:
       - '15'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"status":"ok"}'
+      encoding: UTF-8
+      string: '{"status":"ok"}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 12:15:19 GMT
+  recorded_at: Sun, 05 Apr 2015 15:49:26 GMT
 - request:
     method: post
     uri: https://app.datadoghq.com/api/v1/events?api_key=<API_KEY>
     body:
       encoding: UTF-8
-      string: ! '{"msg_text":"Chef updated 0 resources out of 0 resources total.","date_happened":1410264919,"msg_title":"Chef
+      string: '{"msg_text":"Chef updated 0 resources out of 0 resources total.","date_happened":1428248966,"msg_title":"Chef
         completed in 5 seconds on chef.handler.datadog.test-tags ","priority":"low","parent":null,"tags":["env:hostile","role:highlander","tag:the_one_and_only"],"aggregation_key":"chef.handler.datadog.test-tags","alert_type":"success","event_type":"config_management.run","source_type_name":"chef","title":"Chef
         completed in 5 seconds on chef.handler.datadog.test-tags ","text":"Chef updated
         0 resources out of 0 resources total.","host":"chef.handler.datadog.test-tags","device":null}'
     headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
       User-Agent:
       - Ruby
       Content-Type:
@@ -123,32 +137,36 @@ http_interactions:
       Content-Type:
       - text/json; charset=UTF-8
       Date:
-      - Tue, 09 Sep 2014 12:15:16 GMT
+      - Sun, 05 Apr 2015 15:49:23 GMT
       Server:
-      - dogdispatcher/5.1.1
+      - dogdispatcher/6.1.23
+      Strict-Transport-Security:
+      - max-age=15724800;
       Content-Length:
-      - '428'
+      - '420'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"status": "ok", "event": {"priority": "low", "date_happened": 1410264919,
+      encoding: UTF-8
+      string: '{"status": "ok", "event": {"priority": "low", "date_happened": 1428248966,
         "handle": null, "title": "Chef completed in 5 seconds on chef.handler.datadog.test-tags
-        ", "url": "https://app.datadoghq.com/event/jump_to?event_id=2449507933236142332",
+        ", "url": "https://app.datadoghq.com/event/event?id=2751230185062799345",
         "text": "Chef updated 0 resources out of 0 resources total.", "tags": ["env:hostile",
         "role:highlander", "tag:the_one_and_only"], "related_event_id": null, "id":
-        2449507933236142332}}'
+        2751230185062799345}}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 12:15:19 GMT
+  recorded_at: Sun, 05 Apr 2015 15:49:26 GMT
 - request:
     method: put
     uri: https://app.datadoghq.com/api/v1/tags/hosts/chef.handler.datadog.test-tags?api_key=<API_KEY>&application_key=<APPLICATION_KEY>&source=chef
     body:
       encoding: UTF-8
-      string: ! '{"tags":["env:hostile","role:highlander","tag:the_one_and_only"]}'
+      string: '{"tags":["env:hostile","role:highlander","tag:the_one_and_only"]}'
     headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
       User-Agent:
       - Ruby
       Content-Type:
@@ -163,19 +181,25 @@ http_interactions:
       Content-Type:
       - application/json
       Date:
-      - Tue, 09 Sep 2014 12:15:16 GMT
+      - Sun, 05 Apr 2015 15:49:24 GMT
       Pragma:
       - no-cache
       Server:
       - gunicorn/19.1.0
+      Strict-Transport-Security:
+      - max-age=15724800;
+      X-Dd-Debug:
+      - mPU4gm+hKkKT8ia9ZdY5CzVKb87xvoCEvNtumo6b6Z8=
+      X-Frame-Options:
+      - SAMEORIGIN
       Content-Length:
       - '110'
       Connection:
       - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"host": "chef.handler.datadog.test-tags", "tags": ["env:hostile",
+      encoding: UTF-8
+      string: '{"host": "chef.handler.datadog.test-tags", "tags": ["env:hostile",
         "role:highlander", "tag:the_one_and_only"]}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 12:15:19 GMT
-recorded_with: VCR 2.9.2
+  recorded_at: Sun, 05 Apr 2015 15:49:26 GMT
+recorded_with: VCR 2.9.3