chef-handler-splunkstorm 1.0.0 → 1.1.0

data/lib/chef/handler/splunkstorm.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+# Chef Exception & Reporting Handler for Splunk Storm.
+#
+# Author:: Greg Albrecht <mailto:gba@splunk.com>
+# Copyright:: Copyright 2012 Splunk, Inc.
+# License:: Apache License 2.0.
+#
+
+
+require 'rubygems'
+require 'chef/handler'
+require 'json'
+require 'rest-client'
+
+
+class Chef
+  class Handler
+
+    # Chef Exception & Reporting Handler for Splunk Storm.
+    #
+    # Extracts several keys from the run_status Hash, converts them to JSON, and
+    # POSTs them to Splunk Storm as an event for later searching & reporting.
+    #
+    # = Usage
+    # 1. Create a Splunk Storm account: https://www.splunkstorm.com
+    # 2. Retrieve your Access Token & Project ID: http://docs.splunk.com/Documentation/Storm/latest/User/UseStormsRESTAPI
+    # 3. Add the chef_handler Cookbook to your Run List.
+    # 4. Add a chef_handler Resource to one of your existing Recipes.
+    #
+    # = Example
+    # Here's an example +chef_handler+ Resource given you've retrieved your
+    # Access Token as *ACCESS_TOKEN* and Project ID as *PROJECT_ID*:
+    #
+    #  include_recipe 'chef_handler'
+    #
+    #  gem_package('chef-handler-splunkstorm'){action :nothing}.run_action(:install)
+    #
+    #  chef_handler 'Chef::Handler::SplunkStorm' do
+    #    action :enable
+    #    arguments ['ACCESS_TOKEN', 'PROJECT_ID']
+    #    source File.join(Gem.all_load_paths.grep(/chef-handler-splunkstorm/).first,
+    #                     'chef', 'handler', 'splunkstorm.rb')
+    #  end
+    #
+    # = Requirements
+    # * +json+ Gem: http://flori.github.com/json/
+    # * +rest-client+ Gem: https://github.com/archiloque/rest-client
+    # 
+    # = Links
+    # * Internal Splunk JIRA: http://jira.splunk.com/browse/STORM-3796
+    # * Opscode JIRA: http://tickets.opscode.com/browse/COOK-1208
+    #
+    class SplunkStorm < Chef::Handler
+      SPLUNKSTORM_URL = 'https://api.splunkstorm.com'
+      API_ENDPOINT = '/1/inputs/http'
+
+      # * *Args*:
+      #   - +access_token+ -> A Splunk Storm Access Token.
+      #   - +project_id+ -> A Splunk Storm Project ID.
+      #
+      def initialize(access_token, project_id)
+        @access_token = access_token
+        @project_id = project_id
+      end
+
+      # Reports Chef's +run_status+ metrics and results to Splunk Storm.
+      def report_metrics
+        event_metadata = {
+          :sourcetype => 'generic_single_line',
+          :host => node.hostname,
+          :project => @project_id}
+
+        # We're creating a new Hash b/c 'node' and 'all_resources' in run_status
+        # are just TOO large.
+        status_event = {
+          :failed => run_status.failed?,
+          :start_time => run_status.start_time,
+          :end_time => run_status.end_time,
+          :elapsed_time => run_status.elapsed_time,
+          :exception => run_status.formatted_exception}
+
+        api_params = event_metadata.collect{ |k,v| [k, v].join('=') }.join('&')
+        url_params = URI.escape(api_params)
+        endpoint_path = [API_ENDPOINT, url_params].join('?')
+
+        request = RestClient::Resource.new(
+          SPLUNKSTORM_URL, :user => @access_token, :password => 'x')
+
+        request[endpoint_path].post(status_event.to_json)
+      end
+
+      # Reports Chef's +run_status+ exception and backtrace to Splunk Storm.
+      def report_exception
+        event_metadata = {
+          :sourcetype => 'storm_multi_line',
+          :host => node.hostname,
+          :project => @project_id}
+
+        api_params = event_metadata.collect{ |k,v| [k, v].join('=') }.join('&')
+        url_params = URI.escape(api_params)
+        endpoint_path = [API_ENDPOINT, url_params].join('?')
+
+        request = RestClient::Resource.new(
+          SPLUNKSTORM_URL, :user => @access_token, :password => 'x')
+
+        request[endpoint_path].post(Array(run_status.backtrace).join("\n"))
+      end
+
+      # Proxies calls for +report_metrics+ and, on failure, +report_exception+.
+      def report
+        report_metrics
+        if run_status.failed?
+          report_exception
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chef-handler-splunkstorm
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Greg Albrecht
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-09 00:00:00 Z
+date: 2012-05-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -56,8 +56,8 @@ extra_rdoc_files: []
 files: 
 - LICENSE
 - README.md
-- lib/chef/handler/splunkstorm_handler.rb
-homepage: http://github.com/ampledata/chef-handler-splunkstorm
+- lib/chef/handler/splunkstorm.rb
+homepage: http://ampledata.org/splunk_storm_chef_handler.html
 licenses: []
 
 post_install_message: 

data/lib/chef/handler/splunkstorm_handler.rb

@@ -1,111 +0,0 @@
-#!/usr/bin/env ruby
-# Chef Exception & Reporting Handler for Splunk Storm.
-#
-# Author:: Greg Albrecht <mailto:gba@splunk.com>
-# Copyright:: Copyright 2012 Splunk, Inc.
-# License:: Apache License 2.0.
-#
-
-
-require 'rubygems'
-require 'json'
-require 'rest-client'
-
-
-# Chef Exception & Reporting Handler for Splunk Storm.
-#
-# Extracts several keys from the run_status Hash, converts them to JSON, and
-# POSTs them to Splunk Storm as an event for later searching & reporting.
-#
-# = Usage
-# 1. Create a Splunk Storm account: https://www.splunkstorm.com
-# 2. Retrieve your Access Token & Project ID: http://docs.splunk.com/Documentation/Storm/latest/User/UseStormsRESTAPI
-# 3. Add the chef_handler Cookbook to your Run List.
-# 4. Add a chef_handler Resource to one of your existing Recipes.
-#
-# = Example
-# Here's an example +chef_handler+ Resource given you've retrieved your
-# Access Token as *ACCESS_TOKEN* and Project ID as *PROJECT_ID*:
-#
-#  include_recipe 'chef_handler'
-#
-#  gem_package 'chef-handler-splunkstorm'
-#
-#  chef_handler 'SplunkStormHandler' do
-#    action :enable
-#    arguments ['ACCESS_TOKEN', 'PROJECT_ID']
-#    source 'chef/handler/splunkstorm_handler'
-#  end
-#
-# = Requirements
-# * +json+ Gem: http://flori.github.com/json/
-# * +rest-client+ Gem: https://github.com/archiloque/rest-client
-# 
-# = Links
-# * Internal Splunk JIRA: http://jira.splunk.com/browse/STORM-3796
-# * Opscode JIRA: http://tickets.opscode.com/browse/COOK-1208
-#
-class SplunkStormHandler < Chef::Handler
-  SPLUNKSTORM_URL = 'https://api.splunkstorm.com'
-  API_ENDPOINT = '/1/inputs/http'
-
-  # * *Args*:
-  #   - +access_token+ -> A Splunk Storm Access Token.
-  #   - +project_id+ -> A Splunk Storm Project ID.
-  #
-  def initialize(access_token, project_id)
-    @access_token = access_token
-    @project_id = project_id
-  end
-
-  # Reports Chef's +run_status+ metrics and results to Splunk Storm.
-  def report_metrics
-    event_metadata = {
-      :sourcetype => 'generic_single_line',
-      :host => node.hostname,
-      :project => @project_id}
-
-    # We're creating a new Hash b/c 'node' and 'all_resources' in run_status
-    # are just TOO large.
-    status_event = {
-      :failed => run_status.failed?,
-      :start_time => run_status.start_time,
-      :end_time => run_status.end_time,
-      :elapsed_time => run_status.elapsed_time,
-      :exception => run_status.formatted_exception}
-
-    api_params = event_metadata.collect{ |k,v| [k, v].join('=') }.join('&')
-    url_params = URI.escape(api_params)
-    endpoint_path = [API_ENDPOINT, url_params].join('?')
-
-    request = RestClient::Resource.new(
-      SPLUNKSTORM_URL, :user => @access_token, :password => 'x')
-
-    request[endpoint_path].post(status_event.to_json)
-  end
-
-  # Reports Chef's +run_status+ exception and backtrace to Splunk Storm.
-  def report_exception
-    event_metadata = {
-      :sourcetype => 'storm_multi_line',
-      :host => node.hostname,
-      :project => @project_id}
-
-    api_params = event_metadata.collect{ |k,v| [k, v].join('=') }.join('&')
-    url_params = URI.escape(api_params)
-    endpoint_path = [API_ENDPOINT, url_params].join('?')
-
-    request = RestClient::Resource.new(
-      SPLUNKSTORM_URL, :user => @access_token, :password => 'x')
-
-    request[endpoint_path].post(Array(run_status.backtrace).join("\n"))
-  end
-
-  # Proxies calls for +report_metrics+ and, on failure, +report_exception+.
-  def report
-    report_metrics
-    if run_status.failed?
-      report_exception
-    end
-  end
-end