chef-handler-splunkstorm 1.0.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,29 @@
+Description
+===========
+
+A Chef Exception & Reporting Handler for
+[Splunk Storm](https://www.splunkstorm.com).
+
+Usage
+=====
+
+1. Create a [Splunk Storm](https://www.splunkstorm.com) account.
+2. Retrieve your Splunk Storm [REST API Credentials](http://docs.splunk.com/Documentation/Storm/Beta/User/UseStormsRESTAPI).
+3. Download the [chef_handler](https://github.com/ampledata/chef_handler/tree/feature/COOK-1208_splunkstorm_handler) Cookbook.
+4. Add the **chef_handler** Cookbook to your Run List.
+5. Given you've retrieved your Access Token as **ACCESS_TOKEN** and Project ID
+as **PROJECT_ID**, add a chef_handler Resource to one of your Recipes:
+
+```ruby
+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
+```
+
+See also: [Enable Chef Handler with LWRP](http://wiki.opscode.com/display/chef/Distributing+Chef+Handlers#DistributingChefHandlers-EnabletheChefHandlerwiththe%7B%7Bchefhandler%7D%7DLWRP)

data/lib/chef/handler/splunkstorm_handler.rb

@@ -0,0 +1,111 @@
+#!/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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: chef-handler-splunkstorm
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Greg Albrecht
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Allows searching and reporting of Chef run metrics from Splunk Storm.
+email: gba@splunk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/chef/handler/splunkstorm_handler.rb
+homepage: http://github.com/ampledata/chef-handler-splunkstorm
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Chef Exception & Reporting Handler for Splunk Storm.
+test_files: []
+