flapjack 0.7.0 → 0.7.1

data/README.md

@@ -5,6 +5,8 @@
 [id_travis_link]: https://secure.travis-ci.org/#!/flpjck/flapjack
 [id_travis_img]: https://secure.travis-ci.org/flpjck/flapjack.png
 
+[flapjack-project.com](http://flapjack-project.com/)
+
 Flapjack is a highly scalable and distributed monitoring notification system.
 
 Flapjack provides a scalable method for dealing with events representing changes in system state (OK -> WARNING -> CRITICAL transitions) and alerting appropriate people as necessary.
@@ -16,17 +18,13 @@ Flapjack's `executive` component picks up the events and processes them -- decid
 Additional check engines can be supported by adding additional receiver processes similar to the nagios receiver.
 
 
-## Using Flapjack
-
-### Quickstart
-
-TODO numbered list for simplest possible Flapjack run.
+## Using
 
-For more information, including full specification of the configuration file and the data import formats, please refer to the [Flapjack Wiki](https://github.com/flpjck/flapjack/wiki/USING).
+For more information, including full specification of the configuration file and the data import formats, please refer to the [USING](https://github.com/flpjck/flapjack/wiki/USING) section of the Flapjack wiki
 
 ## Developing Flapjack
 
-Information on developing more Flapjack components or contributing to core Flapjack development can be found in the [Flapjack Wiki](https://github.com/flpjck/flapjack/wiki/DEVELOPING).
+Information on developing more Flapjack components or contributing to core Flapjack development can be found in the [DEVELOPING](https://github.com/flpjck/flapjack/wiki/DEVELOPING) section of the Flapjack wiki
 
 ## Documentation Submodule
 
@@ -43,4 +41,16 @@ If you make changes to the documentation locally, here's how to publish them:
 * git add, commit and push from inside the doc subdir
 * Add, commit and push the doc dir from the root (this updates the pointer in the main git repo to the correct ref in the doc repo, we think...)
 
+## More on the wiki
+
+https://github.com/flpjck/flapjack/wiki has even more goodies:
+
+- [Using Flapjack](https://github.com/flpjck/flapjack/wiki/USING)
+- [Developing Flapjack](https://github.com/flpjck/flapjack/wiki/DEVELOPING)
+- [Redis Data Structure](https://github.com/flpjck/flapjack/wiki/DATA_STRUCTURES)
+- [API](https://github.com/flpjck/flapjack/wiki/API)
+- [Importing](https://github.com/flpjck/flapjack/wiki/IMPORTING)
+- [Debugging Flapjack](https://github.com/flpjck/flapjack/wiki/DEBUGGING)
+- [Flapjack Glossary](https://github.com/flpjck/flapjack/wiki/GLOSSARY)
+
 

data/bin/flapjack-nagios-receiver

@@ -51,7 +51,7 @@ def process_input(opts)
         'summary'   => check_output,
         'timestamp' => timestamp,
       }.to_json
-      redis.rpush 'events', event
+      redis.lpush 'events', event
     end
   rescue Redis::CannotConnectError
     puts "Error, unable to to connect to the redis server (#{$!})"

data/etc/flapjack_config.yaml.example

@@ -1,26 +1,5 @@
 ---
 
-quickstart:
-  redis:
-    host: 127.0.0.1
-    port: 6379
-    db: 6
-  executive:
-    enabled: yes
-    email_queue: email_notifications
-    notification_log_file: log/flapjack-notification.log
-  gateways:
-    email:
-      enabled: yes
-      queue: email_notifications
-      smtp_config:
-        address: "localhost"
-        domain: 'localhost.localdomain'
-        port: 25
-    web:
-      enabled: yes
-      port: 5080
-
 development:
   pid_file: tmp/pids/flapjack.pid
   log_file: log/flapjack.log
@@ -34,7 +13,11 @@ development:
     email_queue: email_notifications
     sms_queue: sms_notifications
     jabber_queue: jabber_notifications
-    notification_log_file: log/flapjack-notification.log
+    pagerduty_queue: pagerduty_notifications
+    notification_log_file: log/notification.log
+    default_contact_timezone: Australia/Broken_Hill
+    archive_events: true
+    events_archive_maxage: 10800
     logger:
       level: INFO
   gateways:

data/lib/flapjack/data/contact.rb

@@ -276,6 +276,8 @@ module Flapjack
 
       # return the timezone of the contact, or the system default if none is set
       def timezone(opts = {})
+        logger = opts[:logger]
+
         tz_string = @redis.get("contact_tz:#{self.id}")
         tz = opts[:default] if (tz_string.nil? || tz_string.empty?)
 
@@ -283,7 +285,9 @@ module Flapjack
           begin
             tz = ActiveSupport::TimeZone.new(tz_string)
           rescue ArgumentError
-            logger.warn("Invalid timezone string set for contact #{self.id} or TZ (#{tz_string}), using 'UTC'!")
+            if logger
+              logger.warn("Invalid timezone string set for contact #{self.id} or TZ (#{tz_string}), using 'UTC'!")
+            end
             tz = ActiveSupport::TimeZone.new('UTC')
           end
         end

data/lib/flapjack/data/event.rb

@@ -21,17 +21,30 @@ module Flapjack
       def self.next(opts={})
         raise "Redis connection not set" unless redis = opts[:redis]
 
-        defaults = { :block => true }
+        defaults = { :block => true,
+                     :archive_events => false,
+                     :events_archive_maxage => (3 * 60 * 60) }
         options  = defaults.merge(opts)
 
-        # In production, we wait indefinitely for events coming from other systems.
-        if options[:block]
-          return self.new( ::JSON.parse( redis.blpop('events', 0).last ) )
+        if options[:archive_events]
+          dest = "events_archive:#{Time.now.utc.strftime "%Y%m%d%H"}"
+          if options[:block]
+            raw = redis.brpoplpush('events', dest, 0)
+          else
+            raw = redis.rpoplpush('events', dest)
+            return unless raw
+          end
+          redis.expire(dest, options[:events_archive_maxage])
+        else
+          if options[:block]
+            raw = redis.brpop('events', 0)[1]
+          else
+            raw = redis.rpop('events')
+            return unless raw
+          end
         end
+        return self.new( ::JSON.parse( raw ) )
 
-        # In testing, we take care that there are no events on the queue.
-        return unless raw = redis.lpop('events')
-        self.new( ::JSON.parse(raw) )
       end
 
       # creates, or modifies, an event object and adds it to the events list in redis

data/lib/flapjack/executive.rb

@@ -57,6 +57,9 @@ module Flapjack
       end
       @default_contact_timezone = tz
 
+      @archive_events        = @config['archive_events'] || false
+      @events_archive_maxage = @config['events_archive_maxage']
+
       # FIXME: Put loading filters into separate method
       # FIXME: should we make the filters more configurable by the end user?
       options = { :log => opts[:logger], :persistence => @redis }
@@ -100,7 +103,9 @@ module Flapjack
 
       until @should_quit
         @logger.debug("Waiting for event...")
-        event = Flapjack::Data::Event.next(:redis => @redis)
+        event = Flapjack::Data::Event.next(:redis => @redis,
+                                           :archive_events => @archive_events,
+                                           :events_archive_maxage => @events_archive_maxage)
         process_event(event) unless event.nil?
       end
 

data/lib/flapjack/gateways/api.rb

@@ -100,7 +100,7 @@ module Flapjack
         entity.check_list.to_json
       end
 
-      get %r{/status/([a-zA-Z0-9][a-zA-Z0-9\.\-]*[a-zA-Z0-9])(?:/(\w+))?} do
+      get %r{/status/([a-zA-Z0-9][a-zA-Z0-9\.\-]*[a-zA-Z0-9])(?:/(.+))?} do
         content_type :json
 
         entity_name = params[:captures][0]
@@ -119,6 +119,10 @@ module Flapjack
             entity_check_status(entity, c)
           }
         end
+        if ret.nil?
+          status 404
+          return
+        end
         ret.to_json
       end
 

data/lib/flapjack/pikelet.rb

@@ -26,6 +26,16 @@ require 'flapjack/gateways/email'
 require 'flapjack/gateways/sms_messagenet'
 require 'flapjack/gateways/web'
 require 'flapjack/logger'
+require 'thin/version'
+
+
+module Thin
+  # disable Thin's loading of daemons
+  # workaround for https://github.com/flpjck/flapjack/issues/133
+  def self.win?
+    true
+  end
+end
 
 module Flapjack
 

data/lib/flapjack/version.rb

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

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

@@ -74,14 +74,100 @@ describe 'Flapjack::Gateways::API', :sinatra => true, :logger => true, :json =>
   end
 
   it "returns a list of checks for an entity" do
-    check_list = ['ping']
-    entity.should_receive(:check_list).and_return(check_list)
+    entity.should_receive(:check_list).and_return([check])
     Flapjack::Data::Entity.should_receive(:find_by_name).
       with(entity_name, :redis => redis).and_return(entity)
 
     get "/checks/#{entity_name_esc}"
     last_response.should be_ok
-    last_response.body.should == check_list.to_json
+    last_response.body.should == [check].to_json
+  end
+
+  it "returns the status for all checks on an entity" do
+    entity.should_receive(:check_list).and_return([check])
+    Flapjack::Data::Entity.should_receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(entity)
+
+    now = Time.now.to_i
+
+    entity_check.should_receive(:state).and_return('OK')
+    entity_check.should_receive(:in_unscheduled_maintenance?).and_return(false)
+    entity_check.should_receive(:in_scheduled_maintenance?).and_return(false)
+    entity_check.should_receive(:last_update).and_return(now - 30)
+    entity_check.should_receive(:last_problem_notification).and_return(now - 60)
+    entity_check.should_receive(:last_recovery_notification).and_return(now - 30)
+    entity_check.should_receive(:last_acknowledgement_notification).and_return(now - 45)
+    Flapjack::Data::EntityCheck.should_receive(:for_entity).
+      with(entity, check, :redis => redis).and_return(entity_check)
+
+    get "/status/#{entity_name_esc}"
+    last_response.should be_ok
+    last_response.body.should == [{'name' => check,
+                                   'state' => 'OK',
+                                   'in_unscheduled_maintenance' => false,
+                                   'in_scheduled_maintenance' => false,
+                                   'last_update' => (now - 30),
+                                   'last_problem_notification' => (now - 60),
+                                   'last_recovery_notification' => (now - 30),
+                                   'last_acknowledgement_notification' => (now - 45)
+                                  }].to_json
+  end
+
+  it "should not show the status for an entity that's not found" do
+    Flapjack::Data::Entity.should_receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(nil)
+
+    get "/status/#{entity_name_esc}"
+    last_response.should be_not_found
+  end
+
+  it "returns the status for a check (with non-word characters) on an entity" do
+    nw_check = "HTTP Port 443"
+    Flapjack::Data::Entity.should_receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(entity)
+
+    now = Time.now.to_i
+
+    entity_check.should_receive(:state).and_return('OK')
+    entity_check.should_receive(:in_unscheduled_maintenance?).and_return(false)
+    entity_check.should_receive(:in_scheduled_maintenance?).and_return(false)
+    entity_check.should_receive(:last_update).and_return(now - 30)
+    entity_check.should_receive(:last_problem_notification).and_return(now - 60)
+    entity_check.should_receive(:last_recovery_notification).and_return(now - 30)
+    entity_check.should_receive(:last_acknowledgement_notification).and_return(now - 45)
+    Flapjack::Data::EntityCheck.should_receive(:for_entity).
+      with(entity, nw_check, :redis => redis).and_return(entity_check)
+
+    get "/status/#{entity_name_esc}/#{URI.escape(nw_check)}"
+    last_response.should be_ok
+    last_response.body.should == {'name' => nw_check,
+                                  'state' => 'OK',
+                                  'in_unscheduled_maintenance' => false,
+                                  'in_scheduled_maintenance' => false,
+                                  'last_update' => (now - 30),
+                                  'last_problem_notification' => (now - 60),
+                                  'last_recovery_notification' => (now - 30),
+                                  'last_acknowledgement_notification' => (now - 45)
+                                 }.to_json
+  end
+
+  it "should not show the status for a check on an entity that's not found" do
+    Flapjack::Data::Entity.should_receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(nil)
+
+    get "/status/#{entity_name_esc}/#{check}"
+    last_response.should be_not_found
+  end
+
+  it "should not show the status for a check that's not found on an entity" do
+    Flapjack::Data::Entity.should_receive(:find_by_name).
+      with(entity_name, :redis => redis).and_return(entity)
+
+    Flapjack::Data::EntityCheck.should_receive(:for_entity).
+      with(entity, check, :redis => redis).and_return(nil)
+
+    get "/status/#{entity_name_esc}/#{check}"
+    last_response.should be_not_found
   end
 
   it "returns a list of scheduled maintenance periods for an entity" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
@@ -534,12 +534,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 308146534625742434
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 308146534625742434
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23