flapjack 0.7.7 → 0.7.8

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## Flapjack Changelog
 
-# 0.7.7 - 2012-05-22
+# 0.7.8 - 2013-05-30
+- Feature: support multiline check output (thanks @bs-github) gh-100 (@jessereynolds)
+- Bug: notification rule with no entities or entity tags not being allowed gh-193 (@jessereynolds)
+- Bug: correct jabber alias in example acknowledgement strings gh-189 (@jessereynolds)
+- Bug: entity lists in Web UI should be sorted alphabetically gh-195 (@jessereynolds)
+
+# 0.7.7 - 2013-05-22
 - Bug: relax notification rule validations somewhat gh-185 (@jessereynolds)
 - Chore: log notification rule validation errors from api gh-183 (@jessereynolds)
 

data/bin/flapjack-nagios-receiver

@@ -25,11 +25,11 @@ def process_input(opts)
       skip unless line
       split_line = line.split("\t")
 
-      object_type, timestamp, entity, check, state, check_time, check_latency, check_output, check_perfdata = split_line
+      object_type, timestamp, entity, check, state, check_time, check_latency, check_output, check_perfdata, check_long_output = split_line
 
       case
-      when split_line.length != 9
-        puts "ERROR - rejecting this line as it doesn't split into 9 tab separated strings: [#{line}]"
+      when ! (split_line.length > 8)
+        puts "ERROR - rejecting this line as it doesn't split into at least 9 tab separated strings: [#{line}]"
         next
       when (timestamp !~ /^\d+$/)
         puts "ERROR - rejecting this line as second string doesn't look like a timestamp: [#{line}]"
@@ -39,16 +39,18 @@ def process_input(opts)
         next
       end
 
-      puts "#{object_type}, #{timestamp}, #{entity}, #{check}, #{state}, #{check_output}"
+      puts "#{object_type}, #{timestamp}, #{entity}, #{check}, #{state}, #{check_output}, #{check_long_output}"
 
       state = 'ok'       if state.downcase == 'up'
       state = 'critical' if state.downcase == 'down'
+      details = check_long_output ? check_long_output.gsub(/\\n/, "\n") : nil
       event = {
         'entity'    => entity,
         'check'     => check,
         'type'      => 'service',
         'state'     => state,
         'summary'   => check_output,
+        'details'   => details,
         'timestamp' => timestamp,
       }.to_json
       redis.lpush 'events', event
@@ -63,7 +65,7 @@ def main(opts)
   redis = Redis.new(opts[:redis_options])
   while true
     process_input(:redis => redis, :fifo => fifo)
-    puts "Whoops, restarting main loop in 10 seconds"
+    puts "Whoops with the fifo, restarting main loop in 10 seconds"
     sleep 10
   end
 end

data/features/notification_rules.feature

@@ -6,22 +6,45 @@ Feature: Notification rules on a per contact basis
       | id  | first_name | last_name | email             | sms          | timezone         |
       | 1   | Malak      | Al-Musawi | malak@example.com | +61400000001 | Asia/Baghdad     |
       | 2   | Imani      | Farooq    | imani@example.com | +61400000002 | Europe/Moscow    |
+      | 3   | Vera       | Дурейко   | vera@example.com  | +61400000003 | Europe/Paris     |
 
     And the following entities exist:
       | id  | name | contacts |
       | 1   | foo  | 1        |
-      | 2   | bar  | 1,2      |
-      | 3   | baz  | 1        |
+      | 2   | bar  | 1,2,3    |
+      | 3   | baz  | 1,3      |
+      | 4   | buf  | 1,2,3    |
 
     And user 1 has the following notification intervals:
       | email | sms |
       | 15    | 60  |
 
+    And user 2 has the following notification intervals:
+      | email | sms |
+      | 15    | 60  |
+
+    And user 3 has the following notification intervals:
+      | email | sms |
+      | 15    | 60  |
+
     And user 1 has the following notification rules:
-      | id | entities | entity_tags | warning_media | critical_media   | warning_blackhole | critical_blackhole | time_restrictions |
-      | 1  | foo      |             | email         | sms,email        |                   |                    | 8-18 weekdays     |
-      | 2  | bar      |             |               | sms,email        | true              |                    |                   |
-      | 3  | baz      |             | email         | sms,email        |                   |                    |                   |
+      | entities | entity_tags | warning_media | critical_media   | warning_blackhole | critical_blackhole | time_restrictions |
+      | foo      |             | email         | sms,email        |                   |                    | 8-18 weekdays     |
+      | bar      |             |               | sms,email        | true              |                    |                   |
+      | baz      |             | email         | sms,email        |                   |                    |                   |
+
+    And user 2 has the following notification rules:
+      | entities | entity_tags | warning_media | critical_media   | warning_blackhole | critical_blackhole | time_restrictions |
+      |          |             | email         | email            |                   |                    |                   |
+      |          |             | sms           | sms              |                   |                    |                   |
+      | bar      |             | email         | email,sms        |                   |                    |                   |
+
+    And user 3 has the following notification rules:
+      | entities | entity_tags | warning_media | critical_media   | warning_blackhole | critical_blackhole | time_restrictions |
+      | buf      |             | email         | email            |                   |                    |                   |
+      | buf      |             | sms           | sms              |                   |                    |                   |
+      |          |             | email         | email            |                   |                    |                   |
+      | baz      |             | sms           | sms              |                   |                    |                   |
 
   @time_restrictions @time
   Scenario: Alerts only during specified time restrictions
@@ -152,3 +175,58 @@ Feature: Notification rules on a per contact basis
     And   a critical event is received
     Then  3 email alerts should be queued for malak@example.com
     And   3 sms alerts should be queued for +61400000001
+
+  @time
+  Scenario: Contact with only entity specific rules should not be notified for other entities they are a contact for
+    Given the check is check 'ping' on entity 'buf'
+    And   the check is in an ok state
+    When  a critical event is received
+    And   1 minute passes
+    And   a critical event is received
+    Then  no email alerts should be queued for malak@example.com
+
+  @time
+  Scenario: Contact with entity specific rules and general rules should be notified for other entities they are a contact for
+    Given the check is check 'ping' on entity 'buf'
+    And   the check is in an ok state
+    When  a critical event is received
+    And   1 minute passes
+    And   a critical event is received
+    Then  1 email alert should be queued for imani@example.com
+
+  @time
+  Scenario: Mutiple rules for an entity should be additive
+    Given the check is check 'ping' on entity 'buf'
+    And   the check is in an ok state
+    When  a critical event is received
+    And   1 minute passes
+    And   a critical event is received
+    Then  1 email alert should be queued for vera@example.com
+    Then  1 sms alert should be queued for +61400000003
+
+  @time
+  Scenario: Multiple general rules should be additive
+    Given the check is check 'ping' on entity 'buf'
+    And   the check is in an ok state
+    When  a critical event is received
+    And   1 minute passes
+    And   a critical event is received
+    Then  1 email alert should be queued for imani@example.com
+    Then  1 sms alert should be queued for +61400000002
+
+  @time
+  Scenario: An entity specific rule should override general rules
+    Given the check is check 'ping' on entity 'baz'
+    And   the check is in an ok state
+    When  a critical event is received
+    And   1 minute passes
+    And   a critical event is received
+    Then  0 email alerts should be queued for vera@example.com
+    Then  1 sms alert should be queued for +61400000003
+
+  @time
+  Scenario: A blackhole rule on an entity should override another matching entity specific rule
+
+  @time
+  Scenario: A blackhole rule on an entity should override another matching general rule
+

data/lib/flapjack/data/entity_check.rb

@@ -94,6 +94,7 @@ module Flapjack
         event = { 'type'               => 'action',
                   'state'              => 'test_notifications',
                   'summary'            => options['summary'],
+                  'details'            => options['details'],
                   'entity'             => entity.name,
                   'check'              => check
                 }
@@ -221,6 +222,7 @@ module Flapjack
         timestamp = options[:timestamp] || Time.now.to_i
         client = options[:client]
         summary = options[:summary]
+        details = options[:details]
         count = options[:count]
 
         # Note the current state (for speedy lookups)
@@ -233,6 +235,7 @@ module Flapjack
         @redis.rpush("#{@key}:states", timestamp)
         @redis.set("#{@key}:#{timestamp}:state",   state)
         @redis.set("#{@key}:#{timestamp}:summary", summary) if summary
+        @redis.set("#{@key}:#{timestamp}:details", details) if details
         @redis.set("#{@key}:#{timestamp}:count", count) if count
 
         @redis.zadd("#{@key}:sorted_state_timestamps", timestamp, timestamp)
@@ -349,6 +352,11 @@ module Flapjack
         @redis.get("#{@key}:#{timestamp}:summary")
       end
 
+      def details
+        timestamp = @redis.lindex("#{@key}:states", -1)
+        @redis.get("#{@key}:#{timestamp}:details")
+      end
+
       # Returns a list of states for this entity check, sorted by timestamp.
       #
       # start_time and end_time should be passed as integer timestamps; these timestamps
@@ -368,7 +376,8 @@ module Flapjack
           state_data = state_ts.collect {|ts|
             {:timestamp => ts.to_i,
              :state     => r.get("#{@key}:#{ts}:state"),
-             :summary   => r.get("#{@key}:#{ts}:summary")}
+             :summary   => r.get("#{@key}:#{ts}:summary"),
+             :details   => r.get("#{@key}:#{ts}:details")}
           }
         end
 
@@ -392,7 +401,8 @@ module Flapjack
         return if ts.nil? || ts.empty?
         {:timestamp => ts.first.to_i,
          :state     => @redis.get("#{@key}:#{ts.first}:state"),
-         :summary   => @redis.get("#{@key}:#{ts.first}:summary")}
+         :summary   => @redis.get("#{@key}:#{ts.first}:summary"),
+         :details   => @redis.get("#{@key}:#{ts.first}:details")}
       end
 
       # Returns a list of maintenance periods (either unscheduled or scheduled) for this

data/lib/flapjack/data/event.rb

@@ -126,6 +126,10 @@ module Flapjack
         @attrs['summary']
       end
 
+      def details
+        @attrs['details']
+      end
+
       def time
         return unless @attrs['time']
         @attrs['time'].to_i

data/lib/flapjack/data/notification.rb

@@ -39,6 +39,7 @@ module Flapjack
         @contents ||= {'event_id'              => event.id,
                        'state'                 => event.state,
                        'summary'               => event.summary,
+                       'details'               => event.details,
                        'time'                  => event.time,
                        'duration'              => event.duration || nil,
                        'notification_type'     => type,

data/lib/flapjack/data/notification_rule.rb

@@ -218,13 +218,13 @@ module Flapjack
                                 d[:entity_tags].all? {|et| et.is_a?(String)} ) } =>
                        "entity_tags must be a list of strings",
 
-                       proc { (d.has_key?(:entities) &&
-                               d[:entities].is_a?(Array) &&
-                               (d[:entities].size > 0)) ||
-                              (d.has_key?(:entity_tags) &&
-                               d[:entity_tags].is_a?(Array) &&
-                               (d[:entity_tags].size > 0)) } =>
-                       "entities or entity tags must have at least one value",
+                       #proc { (d.has_key?(:entities) &&
+                       #        d[:entities].is_a?(Array) &&
+                       #        (d[:entities].size > 0)) ||
+                       #       (d.has_key?(:entity_tags) &&
+                       #        d[:entity_tags].is_a?(Array) &&
+                       #        (d[:entity_tags].size > 0)) } =>
+                       #"entities or entity tags must have at least one value",
 
                        proc { !d.has_key?(:time_restrictions) ||
                               ( d[:time_restrictions].nil? ||

data/lib/flapjack/executive.rb

@@ -208,7 +208,7 @@ module Flapjack
         if event.state != event.previous_state
           entity_check.update_state(event.state, :timestamp => timestamp,
             :summary => event.summary, :client => event.client,
-            :count => @event_count)
+            :count => @event_count, :details => event.details)
         end
 
         # No state change, and event is ok, so no need to run through filters
@@ -314,16 +314,23 @@ module Flapjack
       # don't consider notification rules if the contact has none
 
       tuple = messages.map do |message|
-        @logger.debug "considering message for contact: #{message.contact.id} #{message.medium} #{message.notification.event.id} #{message.notification.event.state}"
         rules    = message.contact.notification_rules
-        @logger.debug "found #{rules.length} rules for this message's contact"
         event_id = message.notification.event.id
+
+        @logger.debug "considering message for contact: #{message.contact.id} #{message.medium} #{event_id} #{message.notification.event.state}"
+        @logger.debug "found #{rules.length} rules for this message's contact"
+
         options  = {}
         options[:no_rules_for_contact] = true if rules.empty?
+
         # filter based on entity, tags, severity, time of day
         matchers = rules.find_all do |rule|
           rule.match_entity?(event_id) && rule_occurring_now?(rule, :contact => message.contact)
         end
+        @logger.debug "#{matchers.length} matchers remain for this message:"
+        matchers.each {|matcher|
+          @logger.debug "matcher: #{matcher.to_json}"
+        }
         [message, matchers, options]
       end
 
@@ -332,19 +339,26 @@ module Flapjack
 
       @logger.debug "apply_notification_rules: num messages after entity and time matching: #{tuple.size}"
 
-      # delete the matcher for all entities if there are more specific matchers
+      # delete any matchers for all entities if there are more specific matchers
       tuple = tuple.map do |message, matchers, options|
+        num_matchers = matchers.length
         if matchers.length > 1
+          @logger.debug("general removal when entity specific: #{matchers.length} matchers")
           have_specific = matchers.detect do |matcher|
-            matcher.entities or matcher.entity_tags
+            ( matcher.entities && !matcher.entities.empty? ) or
+              ( matcher.entity_tags && !matcher.entity_tags.empty? )
           end
           if have_specific
-            # delete the rule for all entities
+            # delete any rules for all entities
             matchers.reject! do |matcher|
-              matcher.entities.nil? && matcher.entity_tags.nil?
+              ( matcher.entities.nil? || matcher.entities.empty? ) &&
+                ( matcher.entity_tags.nil? || matcher.entity_tags.empty? )
             end
           end
         end
+        if num_matchers != matchers.length
+          @logger.debug("apply_notification_rules: removal of general matchers when entity specific matchers are present: number of matchers changed from #{num_matchers} to #{matchers.length} for message id: #{message.contact.id}, medium: #{message.medium}")
+        end
         [message, matchers, options]
       end
 
@@ -361,6 +375,7 @@ module Flapjack
         state = message.notification.event.state
         max_notified_severity = message.notification.max_notified_severity
 
+        @logger.debug "apply_notification_rules severity-media constraints: considering message: #{message.contact.id} #{message.medium} #{state}"
         # use EntityCheck#max_notified_severity_of_current_failure
         # as calculated prior to updating the last_notification* keys
         # if it's a higher severity than the current state
@@ -371,10 +386,13 @@ module Flapjack
         when [state, max_notified_severity].include?('warning')
           severity = 'warning'
         end
-        options[:no_rules_for_contact] ||
-          matchers.any? {|matcher|
+
+        no_rules_for_contact = !!options[:no_rules_for_contact]
+        sev_media_matchers = matchers.any? {|matcher|
             (matcher.media_for_severity(severity) || []).include?(message.medium)
           }
+        @logger.debug "apply_notification_rules severity-media constraints: no_rules_for_contact: #{no_rules_for_contact}, sev_media_matchers: #{sev_media_matchers}"
+        no_rules_for_contact || sev_media_matchers
       end
 
       @logger.debug "apply_notification_rules: num messages after pruning for severity-media constraints: #{tuple.size}"

data/lib/flapjack/gateways/email.rb

@@ -32,6 +32,7 @@ module Flapjack
           @contact_last_name          = notification['contact_last_name']
           @state                      = notification['state']
           @summary                    = notification['summary']
+          @details                    = notification['details']
           @time                       = notification['time']
           @entity_name, @check        = notification['event_id'].split(':')
 

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

@@ -33,6 +33,11 @@
       %td
         %strong Summary
       %td= @summary
+    - if @details
+      %tr
+        %td
+          %strong Details
+        %td= @details
     %tr
       %td
         %strong Time

data/lib/flapjack/gateways/jabber.rb

@@ -128,7 +128,7 @@ module Flapjack
           dur   = nil
 
           if comment.nil? || (comment.length == 0)
-            error = "please provide a comment, eg \"flapjack: ACKID #{$1} AL looking\""
+            error = "please provide a comment, eg \"#{@config['alias']}: ACKID #{$1} AL looking\""
           elsif duration_str
             # a fairly liberal match above, we'll let chronic_duration do the heavy lifting
             dur = ChronicDuration.parse(duration_str)

data/lib/flapjack/gateways/web.rb

@@ -180,6 +180,7 @@ module Flapjack
         @check_last_update          = entity_check.last_update
         @check_last_change          = last_change
         @check_summary              = entity_check.summary
+        @check_details              = entity_check.details
         @last_notifications         = entity_check.last_notifications_of_each_type
         @scheduled_maintenances     = entity_check.maintenances(nil, nil, :scheduled => true)
         @acknowledgement_id         = entity_check.failed? ?

data/lib/flapjack/gateways/web/views/check.haml

@@ -34,6 +34,7 @@
         - if @current_scheduled_maintenance
           %h4 (Scheduled Maintenance - #{@current_scheduled_maintenance[:summary]})
         %h3 Output: #{@check_summary}
+        %p #{@check_details}
         %table{:class => "table table-hover table-condensed"}
           %tr
             %td Last state change:

data/lib/flapjack/gateways/web/views/contacts.haml

@@ -17,7 +17,7 @@
             %tr
               %th Name
               %th Email
-            - @contacts.sort_by {|c| [c.last_name, c.first_name] }.each do |contact|
+            - @contacts.sort_by {|c| [c.first_name, c.last_name] }.each do |contact|
               %tr
                 %td
                   - link = "/contacts/#{contact.id}"

data/lib/flapjack/gateways/web/views/entities.haml

@@ -15,7 +15,7 @@
         %p #{@count_failing_entities} failing out of #{@count_all_entities}
         %table{:class => "table table-bordered table-hover table-condensed"}
           - if @entities.length > 0
-            - @entities.each do |entity|
+            - @entities.sort.each do |entity|
               %tr
                 %td
                   - link = "/entity/#{CGI.escape(entity)}"

data/lib/flapjack/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 module Flapjack
-  VERSION = "0.7.7"
+  VERSION = "0.7.8"
 end

data/spec/lib/flapjack/data/notification_rule_spec.rb

@@ -95,8 +95,7 @@ describe Flapjack::Data::NotificationRule, :redis => true do
   context 'validation' do
 
     it "fails to add a notification rule with invalid data" do
-      rule_data[:entities] = []
-      rule_data[:entity_tags] = []
+      rule_data[:entities] = [1, {}]
       rule = Flapjack::Data::NotificationRule.add(rule_data, :redis => @redis)
       rule.should be_nil
     end
@@ -112,4 +111,4 @@ describe Flapjack::Data::NotificationRule, :redis => true do
 
   end
 
-end
+end

data/spec/lib/flapjack/data/notification_spec.rb

@@ -45,12 +45,14 @@ describe Flapjack::Data::Notification, :redis => true do
     event.should_receive(:id).and_return('example.com:ping')
     event.should_receive(:state).and_return('ok')
     event.should_receive(:summary).and_return('Shiny & happy')
+    event.should_receive(:details).and_return('Really Shiny & happy')
     event.should_receive(:time).and_return(t)
     event.should_receive(:duration).and_return(nil)
 
     notification.contents.should == {'event_id'              => 'example.com:ping',
                                      'state'                 => 'ok',
                                      'summary'               => 'Shiny & happy',
+                                     'details'               => 'Really Shiny & happy',
                                      'time'                  => t,
                                      'duration'              => nil,
                                      'notification_type'     => 'problem',
@@ -58,4 +60,4 @@ describe Flapjack::Data::Notification, :redis => true do
 
   end
 
-end
+end

data/spec/lib/flapjack/gateways/web_spec.rb

@@ -122,6 +122,7 @@ describe Flapjack::Gateways::Web, :sinatra => true, :logger => true do
     entity_check.should_receive(:last_update).and_return(time - (3 * 60 * 60))
     entity_check.should_receive(:last_change).and_return(time - (3 * 60 * 60))
     entity_check.should_receive(:summary).and_return('all good')
+    entity_check.should_receive(:details).and_return('seriously, all very wonderful')
     entity_check.should_receive(:last_notifications_of_each_type).and_return(last_notifications)
     entity_check.should_receive(:maintenances).with(nil, nil, :scheduled => true).and_return([])
     entity_check.should_receive(:failed?).and_return(false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
@@ -553,7 +553,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4574905656823869764
+      hash: 3433474727648053171
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -562,7 +562,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4574905656823869764
+      hash: 3433474727648053171
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23