flapjack 0.7.22 → 0.7.25

data/lib/flapjack/filters/ok.rb

@@ -5,46 +5,43 @@ require 'flapjack/filters/base'
 module Flapjack
   module Filters
 
+    # * If the service event's state is ok and there is unscheduled maintenance set, end the unscheduled
+    #   maintenance
     # * If the service event’s state is ok and the previous state was ok, don’t alert
-    # * If the service event's state is ok and the previous notification was a recovery, don't alert
-    # * If the service event's state is ok and the previous state was not ok and for less than 30
-    # seconds, don't alert
-    # * If the service event's state is ok and there is unscheduled downtime set, end the unscheduled
-    #   downtime
+    # * If the service event’s state is ok and there's never been a notification, don't alert
+    # * If the service event's state is ok and the previous notification was a recovery or ok, don't alert
     class Ok
       include Base
 
-      def block?(event)
-        result = false
-
-        if event.ok?
-          if event.previous_state == 'ok'
-            @logger.debug("Filter: Ok: existing state was ok, and the previous state was ok, so blocking")
-            result = true
-          end
-
-          entity_check = Flapjack::Data::EntityCheck.for_event_id(event.id, :redis => @redis)
-
-          last_notification = entity_check.last_notification
-          @logger.debug("Filter: Ok: last notification: #{last_notification.inspect}")
-          if last_notification[:type] == 'recovery'
-            @logger.debug("Filter: Ok: last notification was a recovery, so blocking")
-            result = true
-          end
-
-          if event.previous_state != 'ok'
-            if event.previous_state_duration < 30
-              @logger.debug("Filter: Ok: previous non ok state was for less than 30 seconds, so blocking")
-              result = true
-            end
-          end
-
-          # end any unscheduled downtime
-          entity_check.end_unscheduled_maintenance(Time.now.to_i)
+      def block?(event, entity_check, previous_state)
+        unless event.ok?
+          @logger.debug("Filter: Ok: pass")
+          return false
         end
 
-        @logger.debug("Filter: Ok: #{result ? "block" : "pass"}")
-        result
+        entity_check.end_unscheduled_maintenance(Time.now.to_i)
+
+        if previous_state == 'ok'
+          @logger.debug("Filter: Ok: block - previous state was ok, so blocking")
+          return true
+        end
+
+        last_notification = entity_check.last_notification
+        @logger.debug("Filter: Ok: last notification: #{last_notification.inspect}")
+
+        unless last_notification[:type]
+          @logger.debug("Filter: Ok: block - last notification type is nil (never notified)")
+          return true
+        end
+
+        if [:recovery, :ok].include?(last_notification[:type])
+          @logger.debug("Filter: Ok: block - last notification was a recovery")
+          return true
+        end
+
+        @logger.debug("Filter: Ok: previous_state: #{previous_state}")
+        @logger.debug("Filter: Ok: pass")
+        false
       end
     end
   end

data/lib/flapjack/filters/scheduled_maintenance.rb

@@ -7,8 +7,8 @@ module Flapjack
     class ScheduledMaintenance
       include Base
 
-      def block?(event)
-        result = @redis.exists("#{event.id}:scheduled_maintenance")
+      def block?(event, entity_check, previous_state)
+        result = entity_check.in_scheduled_maintenance?
         @logger.debug("Filter: Scheduled Maintenance: #{result ? "block" : "pass"}")
         result
       end

data/lib/flapjack/filters/unscheduled_maintenance.rb

@@ -7,9 +7,8 @@ module Flapjack
     class UnscheduledMaintenance
       include Base
 
-      def block?(event)
-        result = @redis.exists("#{event.id}:unscheduled_maintenance") &&
-          !event.acknowledgement?
+      def block?(event, entity_check, previous_state)
+        result = entity_check.in_unscheduled_maintenance? && !event.acknowledgement?
         @logger.debug("Filter: Unscheduled Maintenance: #{result ? "block" : "pass"}")
         result
       end

data/lib/flapjack/gateways/email.rb

@@ -28,138 +28,135 @@ module Flapjack
           @sent = 0
         end
 
+        # TODO refactor to remove complexity
         def perform(notification)
-          begin
-            @logger.debug "Woo, got a notification to send out: #{notification.inspect}"
-
-            @notification_type   = notification['notification_type']
-            @contact_first_name  = notification['contact_first_name']
-            @contact_last_name   = notification['contact_last_name']
-            @state               = notification['state']
-            @summary             = notification['summary']
-            @last_state          = notification['last_state']
-            @last_summary        = notification['last_summary']
-            @details             = notification['details']
-            @time                = notification['time']
-            @entity_name, @check = notification['event_id'].split(':', 2)
-
-            entity_check = Flapjack::Data::EntityCheck.for_event_id(notification['event_id'],
-              :redis => ::Resque.redis)
-
-            @in_unscheduled_maintenance = entity_check.in_scheduled_maintenance?
-            @in_scheduled_maintenance   = entity_check.in_unscheduled_maintenance?
-
-            # FIXME: I can not get the entity_check.last_change to work in this context (Resque)
-            # it always returns nil, despite entity_check being a good looking EntityCheck object
-            # and all ...
-            if lc = entity_check.last_change
-              duration  = (Time.now.to_i - lc)
-              @duration = (duration && duration > 40) ? duration : nil
-            end
+          prepare( notification )
+          deliver( notification )
+        end
 
-            headline_map = {'problem'         => 'Problem: ',
-                            'recovery'        => 'Recovery: ',
-                            'acknowledgement' => 'Acknowledgement: ',
-                            'test'            => 'Test Notification: ',
-                            'unknown'         => ''
-                           }
-
-            headline = headline_map[@notification_type] || ''
-
-            @subject = "#{headline}'#{@check}' on #{@entity_name}"
-            @subject += " is #{@state.upcase}" unless ['acknowledgement', 'test'].include?(@notification_type)
-          rescue => e
-            @logger.error "Error preparing email to #{m_to}: #{e.class}: #{e.message}"
-            @logger.error e.backtrace.join("\n")
-            raise
-          end
+        def prepare(notification)
+          @logger.debug "Woo, got a notification to send out: #{notification.inspect}"
+
+          # The instance variables are referenced by the templates, which
+          # share the current binding context
+          @notification_type   = notification['notification_type']
+          @contact_first_name  = notification['contact_first_name']
+          @contact_last_name   = notification['contact_last_name']
+          @state               = notification['state']
+          @duration            = notification['state_duration']
+          @summary             = notification['summary']
+          @last_state          = notification['last_state']
+          @last_summary        = notification['last_summary']
+          @details             = notification['details']
+          @time                = notification['time']
+          @entity_name, @check = notification['event_id'].split(':', 2)
+
+          entity_check = Flapjack::Data::EntityCheck.for_event_id(notification['event_id'],
+            :redis => @redis)
+
+          @in_unscheduled_maintenance = entity_check.in_scheduled_maintenance?
+          @in_scheduled_maintenance   = entity_check.in_unscheduled_maintenance?
+
+          headline_map = {'problem'         => 'Problem: ',
+                          'recovery'        => 'Recovery: ',
+                          'acknowledgement' => 'Acknowledgement: ',
+                          'test'            => 'Test Notification: ',
+                          'unknown'         => ''
+                         }
+
+          headline = headline_map[@notification_type] || ''
+
+          @subject = "#{headline}'#{@check}' on #{@entity_name}"
+          @subject += " is #{@state.upcase}" unless ['acknowledgement', 'test'].include?(@notification_type)
+        rescue => e
+          @logger.error "Error preparing email to #{m_to}: #{e.class}: #{e.message}"
+          @logger.error e.backtrace.join("\n")
+          raise
+        end
 
-          begin
-            host = @smtp_config ? @smtp_config['host'] : nil
-            port = @smtp_config ? @smtp_config['port'] : nil
-            starttls = @smtp_config ? !! @smtp_config['starttls'] : nil
-            if @smtp_config
-              if auth_config = @smtp_config['auth']
-                auth = {}
-                auth[:type]     = auth_config['type'].to_sym || :plain
-                auth[:username] = auth_config['username']
-                auth[:password] = auth_config['password']
-              end
+        def deliver(notification)
+          host = @smtp_config ? @smtp_config['host'] : nil
+          port = @smtp_config ? @smtp_config['port'] : nil
+          starttls = @smtp_config ? !! @smtp_config['starttls'] : nil
+          if @smtp_config
+            if auth_config = @smtp_config['auth']
+              auth = {}
+              auth[:type]     = auth_config['type'].to_sym || :plain
+              auth[:username] = auth_config['username']
+              auth[:password] = auth_config['password']
             end
+          end
 
-            fqdn = `/bin/hostname -f`.chomp
-            m_from = "flapjack@#{fqdn}"
-            @logger.debug("flapjack_mailer: set from to #{m_from}")
-            m_reply_to = m_from
-            m_to       = notification['address']
-
-            @logger.debug("sending Flapjack::Notification::Email " +
-              "#{notification['id']} to: #{m_to} subject: #{@subject}")
-
-            mail = prepare_email(:subject => @subject,
-                                 :from    => m_from,
-                                 :to => m_to)
-
-            smtp_args = {:from     => m_from,
-                         :to       => m_to,
-                         :content  => "#{mail.to_s}\r\n.\r\n",
-                         :domain   => fqdn,
-                         :host     => host || 'localhost',
-                         :port     => port || 25,
-                         :starttls => starttls}
-            smtp_args.merge!(:auth => auth) if auth
-            email = EM::P::SmtpClient.send(smtp_args)
-
-            response = EM::Synchrony.sync(email)
-
-            # http://tools.ietf.org/html/rfc821#page-36 SMTP response codes
-            if response && response.respond_to?(:code) &&
-              ((response.code == 250) || (response.code == 251))
-              @logger.info "Email sending succeeded"
-              @sent += 1
-            else
-              @logger.error "Email sending failed"
-            end
+          fqdn = `/bin/hostname -f`.chomp
+          m_from = "flapjack@#{fqdn}"
+          @logger.debug("flapjack_mailer: set from to #{m_from}")
+          m_reply_to = m_from
+          m_to       = notification['address']
+
+          @logger.debug("sending Flapjack::Notification::Email " +
+            "#{notification['id']} to: #{m_to} subject: #{@subject}")
+
+          mail = prepare_email(:subject => @subject,
+                               :from    => m_from,
+                               :to => m_to)
+
+          smtp_args = {:from     => m_from,
+                       :to       => m_to,
+                       :content  => "#{mail.to_s}\r\n.\r\n",
+                       :domain   => fqdn,
+                       :host     => host || 'localhost',
+                       :port     => port || 25,
+                       :starttls => starttls}
+          smtp_args.merge!(:auth => auth) if auth
+          email = EM::P::SmtpClient.send(smtp_args)
+
+          response = EM::Synchrony.sync(email)
+
+          # http://tools.ietf.org/html/rfc821#page-36 SMTP response codes
+          if response && response.respond_to?(:code) &&
+            ((response.code == 250) || (response.code == 251))
+            @logger.info "Email sending succeeded"
+            @sent += 1
+          else
+            @logger.error "Email sending failed"
+          end
 
-            @logger.info "Email response: #{response.inspect}"
+          @logger.info "Email response: #{response.inspect}"
 
-          rescue => e
-            @logger.error "Error delivering email to #{m_to}: #{e.class}: #{e.message}"
-            @logger.error e.backtrace.join("\n")
-            raise
-          end
+        rescue => e
+          @logger.error "Error delivering email to #{m_to}: #{e.class}: #{e.message}"
+          @logger.error e.backtrace.join("\n")
+          raise
         end
 
-      end
+        private
 
-    private
+        def prepare_email(opts = {})
 
-      def self.prepare_email(opts = {})
+          text_template = ERB.new(File.read(File.dirname(__FILE__) +
+            '/email/alert.text.erb'), nil, '-')
 
-        text_template = ERB.new(File.read(File.dirname(__FILE__) +
-          '/email/alert.text.erb'))
+          html_template = ERB.new(File.read(File.dirname(__FILE__) +
+            '/email/alert.html.erb'), nil, '-')
 
-        html_template = ERB.new(File.read(File.dirname(__FILE__) +
-          '/email/alert.html.erb'))
+          bnd = binding
 
-        bnd = binding
+          mail = Mail.new do
+            from     opts[:from]
+            to       opts[:to]
+            subject  opts[:subject]
+            reply_to opts[:from]
 
-        # this part is the only use of the mail gem -- maybe this can be done
-        # using standard library calls instead?
-        mail = Mail.new do
-          from     opts[:from]
-          to       opts[:to]
-          subject  opts[:subject]
-          reply_to opts[:from]
+            text_part do
+              body text_template.result(bnd)
+            end
 
-          text_part do
-            body text_template.result(bnd)
+            html_part do
+              content_type 'text/html; charset=UTF-8'
+              body html_template.result(bnd)
+            end
           end
 
-          html_part do
-            content_type 'text/html; charset=UTF-8'
-            body html_template.result(bnd)
-          end
         end
       end
 

data/lib/flapjack/gateways/email/alert.html.erb

@@ -18,56 +18,56 @@
 <table>
   <tbody>
     <tr>
-      <td>Entity</td>
+      <td><strong>Entity</strong></td>
       <td><%= @entity_name %></td>
     </tr>
 
     <tr>
-      <td>Check</td>
+      <td><strong>Check</strong></td>
       <td><%= @check %></td>
     </tr>
 
     <tr>
-      <td>State</td>
+      <td><strong>State</strong></td>
       <td><%= @state.upcase %></td>
     </tr>
 
     <tr>
-      <td>Summary</td>
+      <td><strong>Summary</strong></td>
       <td><%= @summary %></td>
     </tr>
 
     <% if @details %>
       <tr>
-        <td>Details</td>
+        <td><strong>Details</strong></td>
         <td><%= @details %></td>
       </tr>
     <% end %>
 
     <% if @time %>
       <tr>
-        <td>Time</td>
+        <td><strong>Time</strong></td>
         <td><%= Time.at(@time.to_i).to_s %></td>
       </tr>
     <% end %>
 
-    <% if @duration %>
+    <% if @duration && @duration > 40 %>
       <tr>
-        <td>Duration</td>
+        <td><strong>Duration</strong></td>
         <td><%= ChronicDuration.output(@duration) %></td>
       </tr>
     <% end %>
 
     <% if @last_state %>
       <tr>
-        <td>Previous state</td>
-        <td><%= @last_state %></td>
+        <td><strong>Previous State</strong></td>
+        <td><%= @last_state.upcase %></td>
       </tr>
     <% end %>
 
     <% if @last_summary %>
       <tr>
-        <td>Previous summary</td>
+        <td><strong>Previous Summary</strong></td>
         <td><%= @last_summary %></td>
       </tr>
     <% end %>

data/lib/flapjack/gateways/email/alert.text.erb

@@ -2,12 +2,25 @@ Hi <%= @contact_first_name %>
 
 Monitoring has detected the following:
 
-Entity:  <%= @entity_name %>
-Check:   <%= @check %>
-State:   <%= @state %>
-Summary: <%= @summary %>
-<%= @time ? "Time:    #{Time.at(@time.to_i).to_s}" : '' %>
-<%= @last_state ? "\nPrevious state: #{@last_state}" : '' %><%= @last_summary ? "\nPrevious summary: #{@last_summary}" : '' %>
+Entity:   <%= @entity_name %>
+Check:    <%= @check %>
+State:    <%= @state.upcase %>
+Summary:  <%= @summary %>
+<% if @details -%>
+Details:  <%= @details %>
+<% end -%>
+<% if @time -%>
+Time:     <%= Time.at(@time.to_i).to_s %>
+<% end -%>
+<% if @duration && @duration > 40 -%>
+Duration: <%= ChronicDuration.output(@duration) %>
+<% end -%>
+<% if @last_state -%>
+Previous State:   <%= @last_state.upcase %>
+<% end -%>
+<% if @last_summary -%>
+Previous Summary: <%= @last_summary %>
+<% end -%>
 
 Cheers,
 Flapjack