nagios-herald 0.0.2

data/lib/nagios-herald/messages/irc.rb

@@ -0,0 +1,58 @@
+require 'nagios-herald/messages/base'
+# probs need socket here
+
+module NagiosHerald
+  class Message
+    class IRC < Message
+
+      attr_accessor :text
+
+      # Public: Initializes a new Message::IRC object.
+      #
+      # recipients - A list of recipients for this message.
+      # options - The options hash from Executor.
+      # FIXME: Is that ^^ necessary now with Config.config available?
+      #
+      # Returns a new Message::IRC object.
+      def initialize(recipients, options = {})
+        @text = ""
+        super(recipients, options)
+      end
+
+      # Public: Generates the text portion of the content hash.
+      #
+      # Returns the full text portion of the content hash.
+      def curate_text
+        # FIXME: Gonna need to chomp newlines
+        @text += self.content[:text][:host_info]
+        @text += self.content[:text][:state_info]
+        @text += self.content[:text][:alert_ack_url]
+      end
+
+      # Public: Prints the text content to the terminal.
+      # Useful for debugging.
+      #
+      # Returns nothing.
+      def print
+        puts @text
+      end
+
+      # Public: Sends the IRC message.
+      #
+      # Returns nothing.
+      def send
+        curate_text
+        if @no_send
+          self.print
+          return
+        end
+
+        # TODO: Actually make this send to an IRC server
+        # I expect the IRC server will be a value in the config
+        self.print
+      end
+
+    end
+  end
+end
+

data/lib/nagios-herald/messages/pager.rb

@@ -0,0 +1,75 @@
+require 'nagios-herald/messages/base'
+require 'mail'
+
+module NagiosHerald
+  class Message
+    class Pager < Message
+
+      attr_accessor :subject
+      attr_accessor :text
+
+      # Public: Initializes a new Message::Pager object.
+      #
+      # recipients - A list of recipients for this message.
+      # options - The options hash from Executor.
+      # FIXME: Is that ^^ necessary now with Config.config available?
+      #
+      # Returns a new Message::Pager object.
+      def initialize(recipients, options = {})
+        @replyto     = options[:replyto]
+        @subject     = ""
+        @text        = ""
+        super(recipients, options)
+      end
+
+      # Public: Generates the text portion of the content hash.
+      #
+      # Returns the full text portion of the content hash.
+      def curate_text
+        notification_type = get_nagios_var('NAGIOS_NOTIFICATIONTYPE')
+        if notification_type.eql?('ACKNOWLEDGEMENT')
+          @text += self.content[:text][:ack_info]
+        else
+          @text += self.content[:text][:additional_info]
+        end
+      end
+
+      # Public: Prints the subject and text content to the terminal.
+      # Useful for debugging.
+      #
+      # Returns nothing.
+      def print
+        puts "------------------"
+        puts "Subject : #{@subject}"
+        puts "------------------"
+        puts @text
+      end
+
+      # Public: Sends the pager message.
+      #
+      # Returns nothing.
+      def build_message
+        curate_text
+        if @no_send
+          self.print
+          return
+        end
+
+        @subject = self.content[:subject]
+        mail = Mail.new({
+          :from    => @replyto,
+          :to      => @recipients,
+          :subject => @subject,
+          :body    => @text
+        })
+      end
+
+      def send
+        self.build_message
+        mail.deliver!
+      end
+
+    end
+  end
+end
+

data/lib/nagios-herald/messages.rb

@@ -0,0 +1,3 @@
+require 'nagios-herald/messages/email'
+require 'nagios-herald/messages/pager'
+require 'nagios-herald/messages/irc'

data/lib/nagios-herald/test_helpers/base_test_case.rb

@@ -0,0 +1,82 @@
+require 'test/unit'
+require 'ostruct'
+
+NAGIOS_VARS = {
+  :HOSTNAME               => "test.host.com",
+  :LONGDATETIME           => "Thu May 11 11:11:11 UTC 2011",
+  :NOTIFICATIONNUMBER     => "1",
+  :NOTIFICATIONRECIPIENTS => "testuser",
+  
+  :SERVICEDESC            => "TestService",
+
+  :SERVICEACKAUTHOR       => "service on call",
+  :HOSTACKAUTHOR          => "host on call",
+  
+  :SERVICEATTEMPT         => "4",
+  :HOSTATTEMPT            => "3",
+  
+  :SERVICEACKCOMMENT      => "service comment",
+  :HOSTACKCOMMENT         => "host comment",
+  
+  :SERVICEDURATION        => "0d 0h 5m 11s",
+  :HOSTDURATION           => "0d 0h 10m 11s",
+  
+  :SERVICENOTES           => "note for service",
+  :HOSTNOTES              => "note for host",
+  
+  :SERVICEOUTPUT          => "short service output",
+  :HOSTOUTPUT             => "short host output",
+  
+  :SERVICESTATE           => "S_TESTING",
+  :HOSTSTATE              => "H_TESTING",
+  
+  :SERVICENOTESURL        => "service_url",
+  :HOSTNOTESURL           => "host_url",
+  
+  :LASTSERVICESTATE       => "LAST_S_TESTING",
+  :LASTHOSTSTATE          => "LAST_H_TESTING",
+  
+  :LONGSERVICEOUTPUT      => "long service output",
+  :LONGHOSTOUTPUT         => "long host output",
+  
+  :MAXSERVICEATTEMPTS     => "4",
+  :MAXHOSTATTEMPTS        => "3",
+  
+  # The below vars are not available to nagios-herald from the env,
+  # but should be generated in the email.
+  :SERVICE_ACK_URL        => "http://test/nagios/?cmd_typ=34&host=test.host.com&service=TestService",
+  :HOST_ACK_URL           => "http://test/nagios/?cmd_typ=33&host=test.host.com"
+}
+module NagiosHerald
+  module TestHelpers
+    class BaseTestCase < Test::Unit::TestCase
+      def simple_options
+        options = OpenStruct.new
+        options.pager_mode = false
+        options.noemail = false
+        options.debug = false
+        options.nagiosurl = 'http://test/nagios/'
+        options
+      end
+
+      def load_env(notification_type, expected_vars)
+        # Load the env with the nagios var we want
+        all_vars = NAGIOS_VARS
+        all_vars[:NOTIFICATIONTYPE] = notification_type
+        
+        # Load all the new values
+        expected_vars.each do |var|
+          val = all_vars.fetch(var)
+          ENV["NAGIOS_#{var}"] = val
+        end
+      end
+      
+      def clear_env
+        # Load the env with empty strings
+        NAGIOS_VARS.each do |k,_|
+          ENV["NAGIOS_#{k}"] = ""
+        end
+      end
+    end
+  end
+end

data/lib/nagios-herald/util.rb

@@ -0,0 +1,45 @@
+require 'nagios-herald/logging'
+
+module NagiosHerald
+  module Util
+  include NagiosHerald::Logging
+
+    # TODO: add methods for handling HTTP(s) requests so we can control timeouts
+
+    def unescape_text(text)
+      return text.gsub("\\n", "\n").gsub("\\t", "\t")
+    end
+
+    def self.get_script_path(script_name)
+      current_dir = File.dirname(__FILE__)
+      rel_path = File.join(current_dir, '..', '..', 'bin', script_name)
+      return File.expand_path(rel_path)
+    end
+
+    def self.load_helper(name)
+      helper_path = File.expand_path(File.join(File.dirname(__FILE__), 'helpers', name))
+      logger.warn "Helper '#{name}' not found" unless File.exist?(helper_path + ".rb")
+      begin
+        require helper_path
+        return true
+      rescue LoadError
+        logger.fatal "Exception encountered loading '#{name}' helper library!"
+        return false
+      end
+    end
+
+    def get_nagios_var(name)
+      # If we're running Icinga, change the variable prefix.
+      if Config.config['icinga']
+        name.gsub!(/^NAGIOS_/, 'ICINGA_')
+      end
+      value = ENV[name]
+    end
+
+    def self.underscore_to_camel_case(name)
+      words = name.downcase.split('_')
+      return words.map! {|w| w.capitalize}.join('')
+    end
+
+  end
+end

data/lib/nagios-herald/version.rb

@@ -0,0 +1,3 @@
+module NagiosHerald
+  VERSION = "0.0.2"
+end

data/lib/nagios-herald.rb

@@ -0,0 +1,7 @@
+require 'nagios-herald/version'
+require 'nagios-herald/config'
+require 'nagios-herald/util'
+require 'nagios-herald/messages'
+require 'nagios-herald/logging'
+require 'nagios-herald/formatters'
+require 'nagios-herald/helpers'

data/lib/stackbars/chart_utils.py

@@ -0,0 +1,25 @@
+import os
+from PIL import ImageFont
+
+def get_width_for_font_size(draw, font_type, font_size, label):
+    font = ImageFont.truetype(font_type, font_size)
+    return draw.textsize(label, font=font)
+
+def get_optimal_font_size(draw, font_type, max_width, max_height, label, min_font_size, font_size = 100):
+    """ Find the maximum font_size given a label to display in a max_width, using a font_type """
+    if font_size < min_font_size:
+        return None
+
+    font = ImageFont.truetype(font_type, font_size)
+    label_width, label_height = draw.textsize(label, font=font)
+    if label_width < max_width and label_height < max_height:
+        return font_size
+    else:
+        return get_optimal_font_size(draw, font_type, max_width, max_height, label, min_font_size, font_size -1)
+
+def get_font(font_name):
+  font_path = os.path.join(os.path.dirname(__file__), 'pilfonts', font_name)
+  if os.path.isfile(font_path):
+      return font_path
+  else:
+      raise Exception("Font %s not found" % font_name)

data/lib/stackbars/grouped_stackbars.py

@@ -0,0 +1,97 @@
+import os
+from PIL import Image, ImageDraw
+from stackbar import Stackbar
+from chart_utils import get_optimal_font_size, get_font, get_width_for_font_size
+
+class GroupedStackbars:
+    def __init__(self, options = {}):
+
+        self.options =  options
+
+        self.width = options.get('width', 500)
+        assert self.width > 0, "width must be > 0"
+
+        self.bar_area_ratio = options.get('bar_area_ratio', .65)
+        assert self.bar_area_ratio <=1, "bar_area_ration must be <= 1"
+
+        self.bar_height_ratio = options.get('bar_height_ratio', .2)
+        assert self.bar_height_ratio <=1, "bar_height_ratio must be <= 1"
+
+        self.font_type = options.get('font_type', get_font('arial_black.ttf'))
+        self.min_font_size = 15
+
+        self.img = None
+        self.draw = None
+
+        self.stack_bars = []
+
+    def initializeDims(self, data, optimize_bar_area_width = True):
+        self.bars_width = int(self.bar_area_ratio * self.width)
+        self.bar_height = int(self.bar_height_ratio * self.bars_width)
+        self.height = len(data) * self.bar_height
+
+        self.img = Image.new('RGBA', (self.width, self.height), (255, 255, 255))
+        self.draw = ImageDraw.Draw(self.img)
+
+        longest_label = self.get_longest_label(data)
+        optimal_font_size = get_optimal_font_size(
+            self.draw,
+            self.font_type,
+            self.width -self.bars_width,
+            self.bar_height,
+            longest_label,
+            self.min_font_size
+        )
+
+        if not optimal_font_size and optimize_bar_area_width:
+            # we did not find an optimal font size - shrink the bar area to find an acceptable font size
+            label_width, label_height = get_width_for_font_size(self.draw, self.font_type, self.min_font_size, longest_label)
+            new_bar_width = self.width - label_width - 3 #3 is some right border
+            bar_width = max(0.3 * self.width, new_bar_width)
+            self.bar_area_ratio = float(bar_width) / float(self.width)
+            self.initializeDims(data, False)
+
+        self.font_size = optimal_font_size or self.min_font_size
+
+    def get_longest_label(self, data):
+        # One liner for python 2.6 and above
+        #longest_legend = reduce(lambda x, y: x if len(x) < len(y) else y, data)[0]
+        longest_label = ""
+        for i in data:
+            label = i[0]
+            if len(label) > len(longest_label):
+                longest_label = label
+        return longest_label
+
+    def initiliazeStackBars(self, data):
+        self.stack_bars = []
+        # get the dimensions for the gauges area and for the text area
+        for label, value in data:
+            sb = Stackbar(self.draw, label, value, self.options)
+            self.stack_bars.append(sb)
+
+    def renderStackBars(self):
+        offset = 0
+        for i, sb in enumerate(self.stack_bars):
+            draw_bottom_border = i == (len(self.stack_bars) - 1)
+            sb.render(self.width, offset, self.bars_width, self.bar_height, self.font_size, draw_bottom_border)
+            offset += self.bar_height
+
+    def render(self, data):
+        if not data:
+            return
+
+        # Initialize the drawing area
+        self.initializeDims(data)
+
+        # Create new stack bars
+        self.initiliazeStackBars(data)
+
+        # render each gauge according to the optimal dims
+        self.renderStackBars()
+
+        return self.img
+
+    def save(self, path):
+        self.img.save(path)
+        print "image saved as %s" % path

data/lib/stackbars/stackbar.py

@@ -0,0 +1,100 @@
+import os
+from PIL import ImageFont
+from chart_utils import get_optimal_font_size, get_font
+
+class Stackbar:
+    def __init__(self, draw, legend, fill_value, options = {}):
+
+        assert fill_value <= 100, "Invalid fill value - must be <= 100"
+
+        self.legend = legend
+        self.fill_value = fill_value
+
+        self.border = options.get('bar_border', 1)
+        self.full_color = options.get('green', (255, 0, 0))
+        self.empty_color = options.get('red', (0, 255, 0))
+        self.font_type = options.get('font_type', get_font('arial_black.ttf'))
+
+        self.light_font_color = options.get('fontcolor', (255, 255, 255))
+        self.dark_font_color = options.get('fontcolor', (0, 0, 0))
+
+        self.draw = draw
+
+    def drawFullRectangle(self, width, bar_height, height_offset, font_size, bottom_border_offset):
+
+
+        rect_width = self.fill_value * width / 100.
+        full_top_left = (self.border, self.border + height_offset)
+        full_bottom_right = (rect_width, height_offset + bar_height - self.border - bottom_border_offset)
+        self.draw.rectangle((full_top_left, full_bottom_right), fill=self.full_color)
+
+        # Draw text
+        rect_label = "%i%%" % self.fill_value
+        optimal_font_size = get_optimal_font_size(self.draw, self.font_type, rect_width, bar_height, rect_label, 7, font_size)
+        if not optimal_font_size:
+            return
+
+        font = ImageFont.truetype(self.font_type, optimal_font_size)
+        label_width, label_height = self.draw.textsize(rect_label, font=font)
+        label_margin = (rect_width - label_width) / 2
+        label_offset = (bar_height - label_height) / 2
+        self.draw.text(
+            (self.border + 1 + label_margin, height_offset + self.border + 1 + label_offset),
+            rect_label,
+            font=font,
+            fill=self.light_font_color
+        )
+
+    def drawEmptyRectangle(self, width, bar_height, height_offset, font_size, bottom_border_offset):
+        rect_start = self.fill_value * width / 100.
+        rect_width = width - rect_start
+
+        empty_top_left = (rect_start + self.border + 1, self.border + height_offset)
+        empty_bottom_right = (width - self.border, height_offset + bar_height - self.border -bottom_border_offset)
+
+        self.draw.rectangle((empty_top_left, empty_bottom_right), fill=self.empty_color)
+
+        rect_label = "%i%%" % (100 - self.fill_value)
+        optimal_font_size = get_optimal_font_size(self.draw, self.font_type, rect_width, bar_height, rect_label, 7, font_size)
+        if not optimal_font_size:
+            return
+
+        font = ImageFont.truetype(self.font_type, optimal_font_size)
+        label_width, label_height = self.draw.textsize(rect_label, font=font)
+        label_margin = rect_start + (rect_width - label_width) / 2
+        label_offset = (bar_height - label_height) / 2
+        self.draw.text(
+            (label_margin, height_offset + self.border + 1 + label_offset),
+            rect_label,
+            font=font,
+            fill=self.dark_font_color
+        )
+
+    def drawLegend(self, width_offset, bar_height, height_offset, font_size):
+        font = ImageFont.truetype(self.font_type, font_size)
+        label_width, label_height = self.draw.textsize(self.legend, font=font)
+        label_margin = width_offset + 2 #some left padding
+        label_offset = (bar_height - label_height) / 2
+        self.draw.text(
+            (label_margin, height_offset + self.border + 1 + label_offset),
+            self.legend,
+            font=font,
+            fill=self.dark_font_color
+        )
+
+    def drawBase(self, width, bar_height, height_offset):
+        self.draw.rectangle((0,height_offset, width, height_offset + bar_height), fill=(0,0,0))
+
+    def render(self, width, height_offset, bars_width, bar_height, font_size, draw_bottom_border = True):
+        if draw_bottom_border:
+            bottom_border_offset = 1
+        else:
+            bottom_border_offset = 0
+
+        self.drawBase(bars_width, bar_height, height_offset)
+
+        self.drawFullRectangle(bars_width, bar_height, height_offset, font_size - 1, bottom_border_offset)
+
+        self.drawEmptyRectangle(bars_width, bar_height, height_offset, font_size - 1, bottom_border_offset)
+
+        self.drawLegend(bars_width, bar_height, height_offset, font_size)

data/nagios-herald.gemspec

@@ -0,0 +1,33 @@
+($LOAD_PATH << File.expand_path("../lib", __FILE__)).uniq!
+require "nagios-herald/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = 'nagios-herald'
+  spec.summary     = "A project that aims to make it easy to provide context in Nagios alerts."
+  spec.version     = NagiosHerald::VERSION
+  spec.authors     = ['Ryan Frantz', 'Nassim Kammah']
+  spec.email       = ['rfrantz@etsy.com', 'nkammah@etsy.com']
+  spec.homepage    = "https://github.com/etsy/nagios-herald"
+  spec.license     = "MIT"
+
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = Dir["tests/**/*_test.rb"]
+  #spec.executables = ["draw_stack_bars", "dump_nagios_env.sh", "get_ganglia_graph", "get_graph", "notify-by-handler", "splunk_alert_frequency"]
+  spec.executables = ["nagios-herald"]
+  spec.required_ruby_version = '>=1.9.2'
+
+  spec.add_runtime_dependency 'app_conf', '~> 0.4', '>= 0.4.2'
+  spec.add_runtime_dependency 'choice', '~> 0.1', '>= 0.1.6'
+  spec.add_runtime_dependency 'mail', '~> 2.5', '>= 2.5.4'
+  spec.add_runtime_dependency 'chef', '>= 11.8.2'
+  spec.add_runtime_dependency 'elasticsearch', '>= 1.0.2'
+
+  spec.description = <<-DESCRIPTION_END
+  A project that aims to make it easy to provide context in Nagios alerts.
+  The project consists of a core notifier script that can be called with a formatter
+  to tailor the content of the message sent to an operator.
+DESCRIPTION_END
+
+  spec.post_install_message = "Have fun and write your own formatters!"
+
+end