flapjack 0.7.18 → 0.7.19

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Flapjack Changelog
 
+# 0.7.19 - 2013-07-17
+- Feature: Removed log4r and YAJL dependencies gh-25 (@ali-graham)
+- Feature: Made jabber entity status messages more verbose gh-245 (@ali-graham)
+- Feature: Split executive pikelet into two parts (processor and notifier) gh-247 (@ali-graham)
+- Feature: marking entities and entity_checks as disabled / inactive gh-104 (@jessereynolds)
+- Feature: include check summary when listing checks (all, failing, and per entity) gh-255 (@jessereynolds)
+
 # 0.7.18 - 2013-07-05
 - Feature: delete currently active scheduled maintenance via api should truncate from Time.now gh-242 (@ali-graham)
 

data/bin/flapjack

@@ -9,6 +9,9 @@ require 'dante'
 require 'optparse'
 require 'ostruct'
 
+require 'oj'
+Oj.default_options = { :indent => 0, :mode => :strict }
+
 require 'flapjack/configuration'
 require 'flapjack/version'
 

data/bin/flapjack-nagios-receiver

@@ -7,7 +7,10 @@ end
 require 'optparse'
 require 'ostruct'
 require 'redis'
-require 'yajl/json_gem'
+
+require 'oj'
+Oj.default_options = { :indent => 0, :mode => :strict }
+
 require 'dante'
 
 require 'flapjack/configuration'

data/bin/flapjack-netsaint-parser

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'yajl/json_gem'
+require 'oj'
+Oj.default_options = { :indent => 0, :mode => :strict }
 
 module Netsaint
   class Service

data/bin/flapjack-populator

@@ -2,7 +2,10 @@
 
 require 'optparse'
 require 'ostruct'
-require 'yajl/json_gem'
+
+require 'oj'
+Oj.default_options = { :indent => 0, :mode => :strict }
+
 require 'redis'
 
 # add lib to the default include path
@@ -60,7 +63,7 @@ end
 
 case command
 when "import-contacts"
-  contacts = JSON.parse(file)
+  contacts = Oj.load(file)
 
   if contacts && contacts.is_a?(Enumerable) && contacts.any? {|e| !e['id'].nil?}
     @persistence = Redis.new(redis_options)
@@ -75,7 +78,7 @@ when "import-contacts"
   end
 
 when "import-entities"
-  entities = JSON.parse(file)
+  entities = Oj.load(file)
 
   if entities && entities.is_a?(Enumerable) && entities.any? {|e| !e['id'].nil?}
     @persistence = Redis.new(redis_options)

data/bin/receive-events

@@ -7,7 +7,9 @@ end
 require 'optparse'
 require 'ostruct'
 require 'redis'
-require 'yajl/json_gem'
+
+require 'oj'
+Oj.default_options = { :indent => 0, :mode => :strict }
 
 require 'flapjack/configuration'
 

data/bin/simulate-failed-check

@@ -7,9 +7,10 @@ end
 require 'optparse'
 require 'ostruct'
 require 'redis'
-require 'yajl/json_gem'
 require 'eventmachine'
 
+require 'json'
+
 require 'flapjack/configuration'
 
 def pike(message)

data/etc/flapjack_config.yaml.example

@@ -8,6 +8,26 @@ development:
     host: 127.0.0.1
     port: 6379
     db: 13
+  processor:
+    enabled: no
+    queue: events
+    notifier_queue: notifications
+    archive_events: true
+    events_archive_maxage: 10800
+    new_check_scheduled_maintenance_duration: 1 month
+    logger:
+      level: INFO
+  notifier:
+    enabled: no
+    queue: notifications
+    email_queue: email_notifications
+    sms_queue: sms_notifications
+    jabber_queue: jabber_notifications
+    pagerduty_queue: pagerduty_notifications
+    notification_log_file: log/notification.log
+    default_contact_timezone: Australia/Broken_Hill
+    logger:
+      level: INFO
   executive:
     enabled: yes
     email_queue: email_notifications

data/features/events.feature

@@ -1,4 +1,4 @@
-@events
+@events @processor
 Feature: events
   So people can be notified when things break and recover
   flapjack-executive must process events correctly

data/features/events_check_names.feature

@@ -1,4 +1,4 @@
-@events
+@events @processor
 Feature: events and check names
   Flapjack must handle weird characters in check names in events
 

data/features/notification_rules.feature

@@ -1,4 +1,4 @@
-@notification_rules @resque
+@notification_rules @resque @processor @notifier
 Feature: Notification rules on a per contact basis
 
   Background:

data/features/notifications.feature

@@ -1,4 +1,4 @@
-@notifications
+@notifications @processor @notifier
 Feature: notifications
   So people can be notified when things break and recover
   flapjack-notifier must send notifications correctly

data/features/steps/events_steps.rb

@@ -2,9 +2,19 @@
 
 def drain_events
   loop do
-    event = Flapjack::Data::Event.next(:block => false, :redis => @redis)
+    event = Flapjack::Data::Event.next('events', :block => false, :redis => @redis)
     break unless event
-    @app.send(:process_event, event)
+    @processor.send(:process_event, event)
+  end
+  drain_notifications
+end
+
+def drain_notifications
+  return unless @notifier_redis
+  loop do
+    notification = Flapjack::Data::Notification.next('notifications', :block => false, :redis => @notifier_redis)
+    break unless notification
+    @notifier.send(:process_notification, notification)
   end
 end
 
@@ -15,7 +25,7 @@ end
 def set_scheduled_maintenance(entity, check, duration = 60*60*2)
   entity_check = Flapjack::Data::EntityCheck.for_entity_name(entity, check, :redis => @redis)
   t = Time.now.to_i
-  entity_check.create_scheduled_maintenance(:start_time => t, :duration => duration, :summary => "upgrading everything")
+  entity_check.create_scheduled_maintenance(t, duration, :summary => "upgrading everything")
   @redis.setex("#{entity}:#{check}:scheduled_maintenance", duration, t)
 end
 
@@ -23,7 +33,7 @@ def remove_scheduled_maintenance(entity, check)
   entity_check = Flapjack::Data::EntityCheck.for_entity_name(entity, check, :redis => @redis)
   sm = entity_check.maintenances(nil, nil, :scheduled => true)
   sm.each do |m|
-    entity_check.delete_scheduled_maintenance(:start_time => m[:start_time])
+    entity_check.end_scheduled_maintenance(m[:start_time])
   end
 end
 
@@ -255,16 +265,16 @@ end
 Then /^a notification should not be generated(?: for check '([\w\.\-]+)' on entity '([\w\.\-]+)')?$/ do |check, entity|
   check  ||= @check
   entity ||= @entity
-  message = @logger.messages.find_all {|m| m =~ /enerating notifications for event #{entity}:#{check}/ }.last
-  found = message ? message.match(/Not generating notifications/) : false
+  message = @logger.messages.find_all {|m| m =~ /enerating notification for event #{entity}:#{check}/ }.last
+  found = message ? message.match(/Not generating notification/) : false
   found.should be_true
 end
 
 Then /^a notification should be generated(?: for check '([\w\.\-]+)' on entity '([\w\.\-]+)')?$/ do |check, entity|
   check  ||= @check
   entity ||= @entity
-  message = @logger.messages.find_all {|m| m =~ /enerating notifications for event #{entity}:#{check}/ }.last
-  found = message ? message.match(/Generating notifications/) : false
+  message = @logger.messages.find_all {|m| m =~ /enerating notification for event #{entity}:#{check}/ }.last
+  found = message ? message.match(/Generating notification/) : false
   found.should be_true
 end
 
@@ -280,14 +290,12 @@ Then /^show me the (\w+ )*log$/ do |adjective|
 end
 
 # added for notification rules:
-
 Given /^the following entities exist:$/ do |entities|
   entities.hashes.each do |entity|
     contacts = entity['contacts'].split(',')
     contacts.map! do |contact|
       contact.strip
     end
-    #puts "adding entity #{entity['name']} (#{entity['id']}) with contacts: [#{contacts.join(', ')}]"
     Flapjack::Data::Entity.add({'id'       => entity['id'],
                                 'name'     => entity['name'],
                                 'contacts' => contacts},
@@ -358,13 +366,6 @@ Then /^all alert dropping keys for user (\d+) should have expired$/ do |contact_
   @redis.keys("drop_alerts_for_contact:#{contact_id}*").should be_empty
 end
 
-# When /^the (\w*) alert block for user (\d*) for (?:the check|check '([\w\.\-]+)' for entity '([\w\.\-]+)') for state (.*) expires$/ do |media, contact, check, entity, state|
-#   check  = check  ? check  : @check
-#   entity = entity ? entity : @entity
-#   num_deleted = @redis.del("drop_alerts_for_contact:#{contact}:#{media}:#{entity}:#{check}:#{state}")
-#   puts "Warning: no keys expired" unless num_deleted > 0
-# end
-
 Then /^(.*) email alert(?:s)? should be queued for (.*)$/ do |num_queued, address|
   check  = check  ? check  : @check
   entity = entity ? entity : @entity

data/features/steps/flapjack-netsaint-parser_steps.rb

@@ -14,8 +14,7 @@ end
 
 Then /^I should see a valid JSON output$/ do
   lambda {
-    parser = Yajl::Parser.new
-    @data = parser.parse(@output)
+    @data = Oj.load(@output)
   }.should_not raise_error
 end
 

data/features/steps/notifications_steps.rb

@@ -59,14 +59,27 @@ Given /^the user wants to receive SMS notifications for entity '([\w\.\-]+)' and
                              :redis => @redis )
 end
 
+# TODO create the notification object in redis, flag the relevant operation as
+# only needing that part running, split up the before block that covers these
 When /^an event notification is generated for entity '([\w\.\-]+)'$/ do |entity|
   event = Flapjack::Data::Event.new('type'    => 'service',
                                     'state'   => 'critical',
                                     'summary' => '100% packet loss',
                                     'entity'  => entity,
                                     'check'   => 'ping')
+
+  notification_type = Flapjack::Data::Notification.type_for_event(event)
+
   entity_check = Flapjack::Data::EntityCheck.for_entity_name(entity, 'ping', :redis => @redis)
-  @app.send(:generate_notification_messages, event, entity_check, Time.now.to_i)
+  max_notified_severity = entity_check.max_notified_severity_of_current_failure
+
+  severity = Flapjack::Data::Notification.severity_for_event(event, max_notified_severity)
+  last_state = entity_check.historical_state_before(event.time)
+
+  Flapjack::Data::Notification.add('notifications', event,
+    :type => notification_type, :severity => severity, :last_state => last_state,
+    :redis => @redis)
+  drain_notifications
 end
 
 Then /^an SMS notification for entity '([\w\.\-]+)' should be queued for the user$/ do |entity|

data/features/support/env.rb

@@ -24,7 +24,8 @@ require 'pathname'
 require 'webmock/cucumber'
 WebMock.disable_net_connect!
 
-require 'flapjack/executive'
+require 'flapjack/notifier'
+require 'flapjack/processor'
 require 'flapjack/patches'
 
 require 'resque_spec'
@@ -124,20 +125,36 @@ end
 
 Before do
   @logger = MockLogger.new
-  # Use a separate database whilst testing
-  @app = Flapjack::Executive.new(:logger => @logger,
-    :config => {'email_queue' => 'email_notifications',
-                'sms_queue' => 'sms_notifications',
-                'default_contact_timezone' => 'America/New_York'},
-    :redis_config => redis_opts)
-  @redis = @app.instance_variable_get('@redis')
 end
 
 After do
+  @logger.messages = []
+end
+
+
+Before('@processor') do
+  @processor = Flapjack::Processor.new(:logger => @logger,
+    :redis_config => redis_opts, :config => {})
+  @redis = @processor.instance_variable_get('@redis')
+end
+
+After('@processor') do
   @redis.flushdb
   @redis.quit
-  # Reset the logged messages
-  @logger.messages = []
+end
+
+Before('@notifier') do
+  @notifier  = Flapjack::Notifier.new(:logger => @logger,
+    :redis_config => redis_opts,
+    :config => {'email_queue' => 'email_notifications',
+                'sms_queue' => 'sms_notifications',
+                'default_contact_timezone' => 'America/New_York'})
+  @notifier_redis = @notifier.instance_variable_get('@redis')
+end
+
+After('@notifier') do
+  @notifier_redis.flushdb
+  @notifier_redis.quit
 end
 
 Before('@resque') do

data/flapjack.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |gem|
   gem.version       = Flapjack::VERSION
 
   gem.add_dependency 'dante'
-  gem.add_dependency 'log4r'
-  gem.add_dependency 'yajl-ruby'
+  gem.add_dependency 'oj'
   gem.add_dependency 'eventmachine', '~> 1.0.0'
   gem.add_dependency 'hiredis'
   gem.add_dependency 'em-synchrony', '~> 1.0.2'
@@ -29,7 +28,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'resque', '~> 1.23.0'
   gem.add_dependency 'sinatra'
   gem.add_dependency 'rack-fiber_pool'
-  gem.add_dependency 'haml'
   gem.add_dependency 'thin'
   gem.add_dependency 'mail'
   gem.add_dependency 'blather', '~> 0.8.3'

data/lib/flapjack/coordinator.rb

@@ -3,13 +3,14 @@
 require 'eventmachine'
 require 'em-synchrony'
 
+require 'syslog'
+
 require 'flapjack/configuration'
 require 'flapjack/patches'
-require 'flapjack/executive'
 require 'flapjack/redis_pool'
 
+require 'flapjack/logger'
 require 'flapjack/pikelet'
-require 'flapjack/executive'
 
 module Flapjack
 
@@ -20,18 +21,7 @@ module Flapjack
       @redis_options = config.for_redis
       @pikelets = []
 
-      # TODO convert this to use flapjack-logger
-      logger_name = "flapjack-coordinator"
-      @logger = Log4r::Logger.new(logger_name)
-
-      formatter = Log4r::PatternFormatter.new(:pattern => "%d [%l] :: #{logger_name} :: %m",
-        :date_pattern => "%Y-%m-%dT%H:%M:%S%z")
-
-      [Log4r::StdoutOutputter, Log4r::SyslogOutputter].each do |outp_klass|
-        outp = outp_klass.new(logger_name)
-        outp.formatter = formatter
-        @logger.add(outp)
-      end
+      @logger = Flapjack::Logger.new("flapjack-coordinator")
     end
 
     def start(options = {})
@@ -47,6 +37,7 @@ module Flapjack
       return if @stopping
       @stopping = true
       remove_pikelets(@pikelets, :shutdown => true)
+      # Syslog.close if Syslog.opened? # TODO revisit in threading branch
     end
 
     # NB: global config options (e.g. daemonize, pidfile,
@@ -173,13 +164,32 @@ module Flapjack
     end
 
     def pikelets(config_env)
-      return {} unless config_env
-      exec_cfg = config_env.has_key?('executive') && config_env['executive']['enabled'] ?
-        {'executive' => config_env['executive']} :
-        {}
-      return exec_cfg unless config_env && config_env['gateways'] &&
+      config = {}
+      return config unless config_env
+
+      # backwards-compatible with config file for previous 'executive' pikelet
+      exec_cfg = nil
+      if config_env.has_key?('executive') && config_env['executive']['enabled']
+        exec_cfg = config_env['executive']
+      end
+      ['processor', 'notifier'].each do |k|
+        if exec_cfg
+          if config_env.has_key?(k)
+            # need to allow for new config fields to override old settings if both present
+            merged = exec_cfg.merge(config_env[k])
+            config.update(k => merged) if merged['enabled']
+          else
+            config.update(k => exec_cfg)
+          end
+        else
+          next unless (config_env.has_key?(k) && config_env[k]['enabled'])
+          config.update(k => config_env[k])
+        end
+      end
+
+      return config unless config_env && config_env['gateways'] &&
         !config_env['gateways'].nil?
-      exec_cfg.merge( config_env['gateways'].select {|k, v|
+      config.merge( config_env['gateways'].select {|k, v|
         Flapjack::Pikelet.is_pikelet?(k) && v['enabled']
       } )
     end