Chef Handler SNS

A simple Chef report handler that reports status of a Chef run through Amazon SNS.

This Chef Handler is heavily based on Joshua Timberman examples.

Gem Version Dependency Status Code Climate Build Status

Requirements

  • Amazon AWS: uses Amazon SNS service.
  • Uses the right_aws library.

Usage

You can install this handler in two ways:

Method 1: In the Chef config file

You can install the RubyGem and configure Chef to use it:

gem install chef-handler-sns

Then add to the configuration (/etc/chef/solo.rb for chef-solo or /etc/chef/client.rb for chef-client):

require "chef/handler/sns"

# Create the handler
sns_handler = Chef::Handler::Sns.new

# Your Amazon AWS credentials
sns_handler.access_key "***AMAZON-KEY***"
sns_handler.secret_key "***AMAZON-SECRET***"

# Some Amazon SNS configurations
sns_handler.topic_arn "arn:aws:sns:***"
sns_handler.region "us-east-1" # optional

# Add your handler
exception_handlers << sns_handler

Method 2: In a recipe with the chef_handler LWRP

Use the chef_handler LWRP, creating a recipe with the following:

# Handler configuration options
argument_array = [
  :access_key => "***AMAZON-KEY***",
  :secret_key => "***AMAZON-SECRET***",
  :topic_arn => "arn:aws:sns:***",
]

# Install the `chef-handler-sns` RubyGem during the compile phase
chef_gem "chef-handler-sns"

# Then activate the handler with the `chef_handler` LWRP
chef_handler "Chef::Handler::Sns" do
  source "#{Gem::Specification.find_by_name("chef-handler-sns").lib_dirs_glob}/chef/handler/sns"
  arguments argument_array
  supports :exception => true
  action :enable
end

If you have an old version of gem package (< 1.8.6) without find_by_name or old chef-client (< 0.10.10) without chef_gem, you can try creating a recipe similar to the following:

# Handler configuration options
argument_array = [
  :access_key => "***AMAZON-KEY***",
  :secret_key => "***AMAZON-SECRET***",
  :topic_arn => "arn:aws:sns:***",
]

# Install the `chef-handler-sns` RubyGem during the compile phase
if defined?(Chef::Resource::ChefGem)
  chef_gem "chef-handler-sns"
else
  gem_package("chef-handler-sns") do
    action :nothing
  end.run_action(:install)
end

# Get the installed `chef-handler-sns` gem path
sns_handler_path = Gem::Specification.respond_to?("find_by_name") ?
  Gem::Specification.find_by_name("chef-handler-sns").lib_dirs_glob :
  Gem.all_load_paths.grep(/chef-handler-sns/).first

# Then activate the handler with the `chef_handler` LWRP
chef_handler "Chef::Handler::Sns" do
  source "#{sns_handler_path}/chef/handler/sns"
  arguments argument_array
  supports :exception => true
  action :enable
end

Handler Configuration Options

The following options are available to configure the handler:

  • access_key - AWS access key (required).
  • secret_key - AWS secret key (required).
  • topic_arn - AWS topic ARN name (required).
  • region - AWS region (optional).
  • subject - Message subject string in erubis format (optional).
  • body_template - Full path of an erubis template file to use for the message body (optional).

subject

Here is an example of the subject configuration option using the ruby configuration file (solo.rb or client.rb):

sns_handler.subject: "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>"

Using the chef_handler LWRP:

argument_array = [
  :access_key => "***AMAZON-KEY***",
  :secret_key => "***AMAZON-SECRET***",
  :topic_arn => "arn:aws:sns:***",
  :subject => "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>",
  # [...]
]
chef_handler "Chef::Handler::Sns" do
  # [...]
  arguments argument_array
end

The following variables are accesible inside the template:

  • start_time - The time the chef run started.
  • end_time - The time the chef run ended.
  • elapsed_time - The time elapsed between the start and finish of the chef run.
  • run_context - The Chef::RunContext object used by the chef run.
  • exception - The uncaught Exception that terminated the chef run, or nil if the run completed successfully.
  • backtrace - The backtrace captured by the uncaught exception that terminated the chef run, or nil if the run completed successfully.
  • node - The Chef::Node for this client run.
  • all_resources - An Array containing all resources in the chef run's resource_collection.
  • updated_resources - An Array containing all resources that were updated during the chef run.
  • success? - Was the chef run successful? True if the chef run did not raise an uncaught exception.
  • failed? - Did the chef run fail? True if the chef run raised an uncaught exception.

body_template

This configuration option needs to contain the full path of an erubis template. For example:

# recipe "myapp::sns_handler"

cookbook_file "chef_handler_sns_body.erb" do
  path "/tmp/chef_handler_sns_body.erb"
  # [...]
end

argument_array = [
  :access_key => "***AMAZON-KEY***",
  :secret_key => "***AMAZON-SECRET***",
  :topic_arn => "arn:aws:sns:***",
  :body_template => "/tmp/chef_handler_sns_body.erb",
  # [...]
]
chef_handler "Chef::Handler::Sns" do
  # [...]
  arguments argument_array
end

<%# file "myapp/files/default/chef_handler_sns_body.erb" %>

Node Name: <%= node.name %>
<% if node.attribute?("fqdn") -%>
Hostname: <%= node.fqdn %>
<% end -%>

Chef Run List: <%= node.run_list.to_s %>
Chef Environment: <%= node.chef_environment %>

<% if node.attribute?("ec2") -%>
Instance Id: <%= node.ec2.instance_id %>
Instance Public Hostname: <%= node.ec2.public_hostname %>
Instance Hostname: <%= node.ec2.hostname %>
Instance Public IPv4: <%= node.ec2.public_ipv4 %>
Instance Local IPv4: <%= node.ec2.local_ipv4 %>
<% end -%>

Chef Client Elapsed Time: <%= elapsed_time.to_s %>
Chef Client Start Time: <%= start_time.to_s %>
Chef Client Start Time: <%= end_time.to_s %>

<% if exception -%>
Exception: <%= run_status.formatted_exception %>
Stacktrace:
<%= Array(backtrace).join("\n") %>

<% end -%>

See the subject documentation for more details on the variables accesible inside the template.

Running the tests

Minitest tests can be run as usual:

rake test

Contributing

Pull Requests are welcome.

License and Author
Author: Xabier de Zuazo ([email protected])
Copyright: Copyright (c) 2013 Onddo Labs, SL. (www.onddo.com)
License: Apache License, Version 2.0

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.