bin/handler-hipchat.rb
#!/usr/bin/env ruby
# frozen_string_literal: true
#
# Sensu Handler: hipchat
#
# This handler script is used to send notifications to Hipchat rooms.
#
# Input:
# @event - Event attributes.
# @event['action'] - Property to figure out the event type i.e. whether it is create or resolve.
# @event['check'] - Map of attributes from the check config which is calling this handler
# @event['client'] - Map of attributes from the client config for the clients from which this event is generated.
# option: json_config - By default, assumes the hipchat config parameters are in the "hipchat" top-level json key.
# This command line option allows to specify a custom json key.
#
# Output:
# Green coloured notification on the Hipchat room if a resolve event is seen.
# Yellow coloured notification used to notify warning if a create event is seen with a status of 1
# Red coloured notification used to notify critical if a create event is seen with a status other than 1
#
# Note: The handler config is fetched and merged from all json config files. The "hipchat" json key is used by default which can
# be overridden with the "json_config" command line option. The hipchat room could also be configured on a per client basis
# by defining the "hipchat_room" attribute in the client config file. This will override the default hipchat room where the
# alerts are being routed to for that particular client.
require 'sensu-handler'
require 'hipchat'
require 'timeout'
require 'erubis'
class HipChatNotif < Sensu::Handler
option :json_config,
description: 'JSON config key name',
short: '-j JsonKeyName',
long: '--json_config JsonKeyName',
required: false,
default: 'hipchat'
def event_name
@event['client']['name'] + '/' + @event['check']['name']
end
def handle
json_config = config[:json_config]
server_url = settings[json_config]['server_url'] || 'https://api.hipchat.com'
apiversion = settings[json_config]['apiversion'] || 'v1'
proxy_url = settings[json_config]['proxy_url']
hipchatmsg = HipChat::Client.new(settings[json_config]['apikey'], api_version: apiversion, http_proxy: proxy_url, server_url: server_url)
rooms = @event['client']['hipchat_room'] || @event['check']['hipchat_room'] || settings[json_config]['room']
from = settings[json_config]['from'] || 'Sensu'
message_template = settings[json_config]['message_template']
message_format = settings[json_config]['message_format'] || 'html'
# If the playbook attribute exists and is a URL, "[<a href='url'>playbook</a>]" will be output.
# To control the link name, set the playbook value to the HTML output you would like.
playbook = +'' # unary operator for unfrozen string literal
if @event['check']['playbook']
begin
uri = URI.parse(@event['check']['playbook'])
playbook << if %w[http https].include?(uri.scheme)
" [<a href='#{@event['check']['playbook']}'>Playbook</a>]"
else
" Playbook: #{@event['check']['playbook']}"
end
rescue StandardError
playbook << " Playbook: #{@event['check']['playbook']}"
end
end
template = if message_template && File.readable?(message_template)
File.read(message_template)
else
'''<%=
[
@event["action"].eql?("resolve") ? "RESOLVED" : "ALERT",
" - [#{event_name}] - ",
@event["check"]["notification"] || @event["check"]["output"],
playbook,
"."
].join
%>'''
end
eruby = Erubis::Eruby.new(template)
message = eruby.result(binding)
begin
Timeout.timeout(3) do
unless rooms.is_a?(Array)
rooms = [rooms]
end
if @event['action'].eql?('resolve')
rooms.each do |room|
hipchatmsg[room].send(from, message, color: 'green', message_format: message_format)
end
else
rooms.each do |room|
hipchatmsg[room].send(from, message, color: @event['check']['status'] == 1 ? 'yellow' : 'red', notify: true, message_format: message_format)
end
end
end
rescue Timeout::Error
puts "hipchat -- timed out while attempting to message #{rooms.join(', ')}"
end
end
end