nagios-herald 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjBhMDg0MjY5NWYxMTk4NjMxOThjNjA5MzVkZWNmOTA4NGM2Y2FlYQ==
-  data.tar.gz: !binary |-
-    ZDU0MTJhZWNjZWU1Mjc2ODIyMjgwOGEyMjIwNDdiNzU0MmFmZDU5ZQ==
+SHA1:
+  metadata.gz: 43674651e4996e822aaa24cb3b3ab308c78ed001
+  data.tar.gz: f99c755e90bb0095412a565c791961029dcfe1ea
 SHA512:
-  metadata.gz: !binary |-
-    OTRiNDA4MGRjMGYxZjk4NzBhZTJhZjcwZjRkZTQ2ZjAwMjNjMjA4ZTlhYjll
-    MzZkY2ViODZjMDgwMGY4Nzg3YmQ2ZmNjNzMyNjE5MTlhNjRiNmM3NGFlNWIz
-    NmNjYTZlZTI5ODJmZWZmOTY2NjU2NTQwNjkzOTY0MDYzOWZiMmE=
-  data.tar.gz: !binary |-
-    ZGViMzUwY2NiZTMyMDMxNmJmMWU3MTdjNmVmNGJlZjI0ODUxYjFlN2JkNTQ1
-    ZDFkMzRkZjY0ZjEyY2EwMjUwOWI2ZjMzNGRlNGQ1MjMyNjA4M2YyNjRlMzQ4
-    ZjUwNTRkZDJhOWE0ODhkMDBlMzJlOTI0OTVkYjk1NWM3Y2IxOGY=
+  metadata.gz: 5fb5a65b2acd8916aa04680cf4093bf70ecea27ba594cf63bc2e2ed451c2fccda2ab5f917281205f80391e56fbf39b97a8ac24d5ce04156b4fb2dd0d8634cfad
+  data.tar.gz: 2f3a7f725c30f69e8c2928c78230224a6d634330b9b37a40b18e107acda91599ce70313d4c0582a1d09062390482ddc1d7d4306ee9130a77a175f4e6c6342a98

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.0.4 (29th Oct, 2014)
+
+Features:
+
+    - Support for short messages (i.e. SMS) added.
+
+Thanks:
+    - @mrtazz is my hero.
+
 ## 0.0.3 (10th Oct, 2014)
 
 Features:

data/lib/nagios-herald/formatters/base.rb

@@ -31,6 +31,7 @@ module NagiosHerald
       @content[:html]
       @content[:subject] = ""
       @content[:text]
+      @content[:short_text]
       @nagios_url = options[:nagios_url]
       @sandbox  = get_sandbox_path
       @state_type = get_nagios_var("NAGIOS_SERVICESTATE") != "" ? "SERVICE" : "HOST"
@@ -57,6 +58,30 @@ module NagiosHerald
       formatters[subclass_base_name] = subclass
     end
 
+    # Public: remove a section from the content hash
+    #
+    # section - section to remove
+    #
+    # Returns the content that got removed or nil if the type or section
+    # doesn't exist
+    def delete_section_for_type(type, section)
+      return nil if @content[type].nil?
+      @content[type].delete(section)
+    end
+
+    def delete_html(section)
+      delete_section_for_type(:html, section)
+    end
+
+    def delete_text(section)
+      delete_section_for_type(:text, section)
+    end
+
+    def delete_short_text(section)
+      delete_section_for_type(:short_text, section)
+    end
+
+
     # Public: Concatenates text content.
     #
     # section - The content section name whose text we'll concatenate
@@ -77,6 +102,27 @@ module NagiosHerald
       end
     end
 
+    # Public: Concatenates short text content. This is really for usage in
+    # limited space messages like SMS or chat based mediums.
+    #
+    # section - The content section name whose text we'll concatenate
+    # text - The text we want to concatenate
+    #
+    # Example:
+    #
+    #   add_short_text("state_detail", "Service is somewhere in Kansas")
+    #
+    # Returns the concatenated short text for the given section.
+    def add_short_text(section, text)
+      # Ensure our key is a symbol, regardless if we're passed a string or symbol
+      section = section.to_sym
+      if @content[:short_text][section].nil? or @content[:short_text][section].empty?
+        @content[:short_text][section] = text
+      else
+        @content[:short_text][section] += text
+      end
+    end
+
     # Public: Concatenates HTML content.
     #
     # section - The content section name whose HTML we'll concatenate
@@ -126,6 +172,7 @@ module NagiosHerald
     # Appends text and HTML output to the appropriate sections in @content
     def line_break(section)
       add_text(section, "\n")
+      add_short_text(section, "\n")
       add_html(section, "<br>")
     end
 
@@ -134,20 +181,23 @@ module NagiosHerald
     def host_info
       section = __method__
       text = ""
+      short_text = ""
       html = ""
-      notification_type = get_nagios_var("NAGIOS_NOTIFICATIONTYPE")
       hostname          = get_nagios_var("NAGIOS_HOSTNAME")
       service_desc      = get_nagios_var("NAGIOS_SERVICEDESC")
       text += "Host: #{hostname} "
+      short_text += "#{hostname}"
       html += "<br><b>Host</b>: #{hostname} "
       if !service_desc.nil? and !service_desc.empty?
         text += "Service: #{service_desc}\n"
+        short_text += "/#{service_desc}\n"
         html += "<b>Service</b>: #{service_desc}<br/>"
       else
         # we need a trailing newline if no service description
         line_break(section)
       end
       add_text(section, text)
+      add_short_text(section, short_text)
       add_html(section, html)
       line_break(section)
     end
@@ -158,21 +208,24 @@ module NagiosHerald
     def state_info
       section = __method__
       text = ""
+      short_text = ""
       html = ""
       state         = get_nagios_var("NAGIOS_#{@state_type}STATE")
       duration      = get_nagios_var("NAGIOS_#{@state_type}DURATION")
-      last_duration = get_nagios_var("NAGIOS_LAST#{@state_type}STATE")
+      last_state    = get_nagios_var("NAGIOS_LAST#{@state_type}STATE")
       attempts      = get_nagios_var("NAGIOS_#{@state_type}ATTEMPT")
       max_attempts  = get_nagios_var("NAGIOS_MAX#{@state_type}ATTEMPTS")
 
-      text += "State is now: #{state} for #{duration} (was #{last_duration}) after #{attempts} / #{max_attempts} checks\n"
+      text += "State is now: #{state} for #{duration} (was #{last_state}) after #{attempts} / #{max_attempts} checks\n"
+      short_text += "#{state} for #{duration} (was #{last_state}) after #{attempts} / #{max_attempts} checks\n"
 
       if state.eql? 'OK' or state.eql? 'UP'
-          html += "State is now: <b>#{state}</b> for <b>#{duration}</b> (was #{last_duration}) after <b>#{attempts} / #{max_attempts}</b> checks<br/>"
+          html += "State is now: <b>#{state}</b> for <b>#{duration}</b> (was #{last_state}) after <b>#{attempts} / #{max_attempts}</b> checks<br/>"
       else
-          html += "State is now: <b><font style='color:red'>#{state}</font></b> for <b>#{duration}</b> (was #{last_duration}) after <b>#{attempts} / #{max_attempts}</b> checks<br/>"
+          html += "State is now: <b><font style='color:red'>#{state}</font></b> for <b>#{duration}</b> (was #{last_state}) after <b>#{attempts} / #{max_attempts}</b> checks<br/>"
       end
       add_text(section, text)
+      add_short_text(section, short_text)
       add_html(section, html)
       line_break(section)
     end
@@ -197,12 +250,15 @@ module NagiosHerald
     def additional_info
       section = __method__
       text = ""
+      short_text = ""
       html = ""
       output = get_nagios_var("NAGIOS_#{@state_type}OUTPUT")
       if !output.nil? and !output.empty?
         text += "Additional Info: #{unescape_text(output)}\n\n"
+        short_text += "#{unescape_text(output)}\n\n"
         html += "<b>Additional Info</b>: #{output}<br><br>"
         add_text(section, text)
+        add_short_text(section, short_text)
         add_html(section, html)
       end
     end
@@ -212,12 +268,15 @@ module NagiosHerald
     def additional_details
       section = __method__
       text = ""
+      short_text = ""
       html = ""
       long_output = get_nagios_var("NAGIOS_LONG#{@state_type}OUTPUT")
       if !long_output.nil? and !long_output.empty?
         text += "Additional Details: #{unescape_text(long_output)}\n"
+        short_text += "#{unescape_text(long_output)}\n"
         html += "<b>Additional Details</b>: <pre>#{unescape_text(long_output)}</pre><br><br>"
         add_text(section, text)
+        add_short_text(section, short_text)
         add_html(section, html)
       end
     end
@@ -278,7 +337,6 @@ module NagiosHerald
       html = ""
       recipients = get_nagios_var("NAGIOS_NOTIFICATIONRECIPIENTS")
       return if recipients.nil?
-      recipients_list = recipients.split(',')
       text += "Sent to #{recipients}\n\n"
       html += "Sent to #{recipients}<br><br>"
       add_text(section, text)
@@ -290,27 +348,33 @@ module NagiosHerald
     def ack_info
       section = __method__
       text = ""
+      short_text = ""
       html = ""
       date = get_nagios_var("NAGIOS_LONGDATETIME")
       author = get_nagios_var("NAGIOS_#{@state_type}ACKAUTHOR")
       comment = get_nagios_var("NAGIOS_#{@state_type}ACKCOMMENT")
       hostname = get_nagios_var("NAGIOS_HOSTNAME")
 
-      text += "At #{date} #{author}"
-      html += "At #{date} #{author}"
+      text       += "At #{date} #{author}"
+      short_text += "At #{date} #{author}"
+      html       += "At #{date} #{author}"
 
       if @state_type == "SERVICE"
         desc = get_nagios_var("NAGIOS_SERVICEDESC")
-        text += " acknowledged #{hostname}/#{desc}.\n\n"
-        html += " acknowledged #{hostname}/#{desc}.<br><br>"
+        text       += " acknowledged #{hostname}/#{desc}.\n\n"
+        short_text += " acked #{hostname}/#{desc}.\n\n"
+        html       += " acknowledged #{hostname}/#{desc}.<br><br>"
       else
-        text += " acknowledged #{hostname}.\n\n"
-        html += " acknowledged #{hostname}.<br><br>"
+        text       += " acknowledged #{hostname}.\n\n"
+        short_text += " acked #{hostname}.\n\n"
+        html       += " acknowledged #{hostname}.<br><br>"
 
       end
-      text += "Comment: #{comment}" if comment
-      html += "Comment: #{comment}" if comment
+      text       += "Comment: #{comment}" if comment
+      short_text += "#{comment}" if comment
+      html       += "Comment: #{comment}" if comment
       add_text(section, text)
+      add_short_text(section, short_text)
       add_html(section, html)
     end
 
@@ -473,7 +537,7 @@ module NagiosHerald
         else
           logger.fatal "Invalid Nagios notification type! Expecting something like PROBLEM or RECOVERY. We got #{nagios_notification_type}."
           exit 1
-        end
+      end
     end
 
     # Public: Generates a subject.
@@ -489,11 +553,19 @@ module NagiosHerald
       subject += "/#{service_desc}" if service_desc != ""
 
       if @state_type == "SERVICE"
-        subject="#{notification_type} Service #{subject} is #{state}"
+        long_subject="#{notification_type} Service #{subject} is #{state}"
       else
-        subject="#{notification_type} Host #{subject} is #{state}"
+        long_subject="#{notification_type} Host #{subject} is #{state}"
       end
-      @content[:subject] = subject
+
+      if notification_type == "ACKNOWLEDGEMENT"
+        short_subject="ACK: #{subject} is #{state}"
+      else
+        short_subject="#{subject} is #{state}"
+      end
+
+      @content[:subject] = long_subject
+      @content[:short_subject] = short_subject
     end
 
     # Public: Generates content body.

data/lib/nagios-herald/formatters/check_disk.rb

@@ -64,8 +64,9 @@ module NagiosHerald
       # Returns nothing. Updates the formatter content hash.
       def additional_info
         section = __method__
+        super
+        delete_html(section)
         output = get_nagios_var("NAGIOS_#{@state_type}OUTPUT")
-        add_text(section, "Additional Info:\n #{unescape_text(output)}\n\n") if output
 
         # Collect partitions data and plot a chart
         # if the check has recovered, $NAGIOS_SERVICEOUTPUT doesn't contain the data we need to parse for images; just give us the A-OK message

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

@@ -15,7 +15,7 @@ module NagiosHerald
       # 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::Email object.
       def initialize(recipients, options = {})
         @replyto     = options[:replyto]
@@ -96,12 +96,12 @@ module NagiosHerald
       def build_message
         curate_text
         curate_html
+        @subject = self.content[:subject]
         if @no_send
           self.print
           return
         end
 
-        @subject = self.content[:subject]
         mail = Mail.new({
           :from  => @replyto,
           :to    => @recipients,
@@ -142,7 +142,7 @@ module NagiosHerald
 
       def send
         mail = self.build_message
-        mail.deliver!
+        mail.deliver! unless mail.nil?
       end
 
     end

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

@@ -28,9 +28,11 @@ module NagiosHerald
       def curate_text
         notification_type = get_nagios_var('NAGIOS_NOTIFICATIONTYPE')
         if notification_type.eql?('ACKNOWLEDGEMENT')
-          @text += self.content[:text][:ack_info]
+          @text += self.content[:short_text][:ack_info] unless self.content[:short_text][:ack_info].empty?
         else
-          @text += self.content[:text][:additional_info]
+          [:state_info, :additional_info, :additional_details].each do |info|
+            @text += self.content[:short_text][info] unless self.content[:short_text][info].empty?
+          end
         end
       end
 
@@ -39,9 +41,7 @@ module NagiosHerald
       #
       # Returns nothing.
       def print
-        puts "------------------"
-        puts "Subject : #{@subject}"
-        puts "------------------"
+        puts @subject
         puts @text
       end
 
@@ -49,24 +49,29 @@ module NagiosHerald
       #
       # Returns nothing.
       def build_message
+        @subject = self.content[:short_subject]
         curate_text
-        if @no_send
-          self.print
-          return
-        end
 
-        @subject = self.content[:subject]
+
         mail = Mail.new({
           :from    => @replyto,
           :to      => @recipients,
           :subject => @subject,
           :body    => @text
         })
+
+        if @no_send
+          self.print
+          return
+        end
+
+
+        return mail
       end
 
       def send
-        self.build_message
-        mail.deliver!
+        mail = self.build_message
+        mail.deliver! unless mail.nil?
       end
 
     end

data/lib/nagios-herald/version.rb

@@ -1,3 +1,3 @@
 module NagiosHerald
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/unit/test_message_pager.rb

@@ -39,6 +39,17 @@ class TestMessagePager < MiniTest::Unit::TestCase
         :recipients_email_link=>"Sent to ops\n\n",
         :notification_info=>"Notification sent at: Thu May 16 21:06:38 UTC 2013 (notification number 1)\n\n",
         :alert_ack_url=>"Acknowledge this alert: http://nagios.example.com/nagios/cgi-bin/cmd.cgi?cmd_typ=34&host=web.example.com&service=Disk%20Space\nAlternatively, reply to this message with the word 'ack' in the body to acknowledge the alert.\n"
+      },
+      :short_text => {
+        :host_info=>"web.example.com/Disk Space\n\n",
+        :state_info=>"CRITICAL for 0d 0h 5m 12s (was CRITICAL) after 3 / 3 checks\n\n",
+        :additional_info=>"DISK CRITICAL - free space: / 7002 MB (18% inode 60%): /data 16273093 MB (26% inode 99%):\n\n",
+        :action_url=>"Action URL: http://runbook.example.com/disk_space_alerts.html\n\n",
+        :notes=>"",
+        :additional_details=>"THRESHOLDS - WARNING:15%;CRITICAL:20%;\n\nFilesystem            Size  Used Avail Use% Mounted on\n/dev/vda               40G   31G  6.9G  82% /\ntmpfs                 2.5G   83M  2.4G   4% /dev/shm\nnfs.example.example.com:/mnt/user/homes\n                       59T   43T   16T  74% /data\n\n",
+        :recipients_email_link=>"Sent to ops\n\n",
+        :notification_info=>"Notification sent at: Thu May 16 21:06:38 UTC 2013 (notification number 1)\n\n",
+        :alert_ack_url=>"Acknowledge this alert: http://nagios.example.com/nagios/cgi-bin/cmd.cgi?cmd_typ=34&host=web.example.com&service=Disk%20Space\nAlternatively, reply to this message with the word 'ack' in the body to acknowledge the alert.\n"
       }
     }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nagios-herald
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryan Frantz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: app_conf
@@ -18,7 +18,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
@@ -28,7 +28,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.2
 - !ruby/object:Gem::Dependency
@@ -38,7 +38,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
   type: :runtime
@@ -48,7 +48,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
 - !ruby/object:Gem::Dependency
@@ -58,7 +58,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.4
   type: :runtime
@@ -68,40 +68,41 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.4
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 11.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 11.8.2
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.2
-description: ! "  A project that aims to make it easy to provide context in Nagios
-  alerts.\n  The project consists of a core notifier script that can be called with
-  a formatter\n  to tailor the content of the message sent to an operator.\n"
+description: |2
+    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.
 email:
 - rfrantz@etsy.com
 - nkammah@etsy.com
@@ -211,19 +212,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A project that aims to make it easy to provide context in Nagios alerts.
 test_files: []
-has_rdoc: