flapjack 0.7.32 → 0.7.33

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Flapjack Changelog
 
+# 0.7.33 - 2013-11-15
+- Feature: Ignore XMPP transcript history replay on connect gh-23 (@ali-graham)
+- Feature: Allow newlines in Jabber comments and commands gh-34 (@ali-graham)
+- Docs: Add quickstarts to README gh-352 (@jessereynolds)
+
 # 0.7.32 - 2013-11-12
 - Feature: Improve flapjack-nagios-receiver --help to output example Nagios config gh-317 (@jessereynolds)
 - Bug: Crash with jabber query 'tell me about ENTITY' gh-367 (@ali-graham)

data/README.md

@@ -10,12 +10,98 @@ Flapjack provides a scalable method for dealing with events representing changes
 
 At its core, Flapjack processes events received from external check execution engines, such as Nagios. Nagios provides a 'perfdata' event output channel, which writes to a named pipe. `flapjack-nagios-receiver` then reads from this named pipe, converts each line to JSON and adds them to the events queue.
 
-Flapjack's `executive` component picks up the events and processes them -- deciding when and who to notifify about problems, recoveries, acknowledgements, etc.
+Flapjack picks up the events and processes them -- deciding when and who to notifify about problems, recoveries, acknowledgements, etc.
 
 Additional check engines can be supported by adding additional receiver processes similar to the nagios receiver.
 
+## Installing
 
-## Using
+**Ubuntu Precise 64 (12.04):**
+
+Add the flapjack deb repository to your apt sources:
+
+```text
+echo 'deb http://packages.flapjack.io/deb precise main' > /tmp/flapjack.list
+sudo cp /tmp/flapjack.list /etc/apt/sources.list.d/flapjack.list
+sudo apt-get update
+```
+
+Install the latest flapjack package:
+
+```text
+sudo apt-get install flapjack
+```
+
+Alternatively, [download the deb](http://packages.flapjack.io/deb/pool/main/f/flapjack/) and install using `sudo dpkg -i <filename>`
+
+The flapjack package is an 'omnibus' package and as such contains most dependencies under /opt/flapjack, including redis.
+
+Installing the package will start redis and flapjack. You should now be able to access the flapjack Web UI at:
+
+[http://localhost:3080/](http://localhost:3080)
+
+And consume the REST API at:
+
+[http://localhost:3081/](http://localhost:3081)
+
+**Other OSes:**
+
+Currently we only make a package for Ubuntu Precise (amd64). If you feel comfortable getting a ruby 1.9 or 2.0 environment going on your preferred OS, then you can also just install flapjack from rubygems.org:
+
+```text
+gem install flapjack
+```
+
+Using a tool like [rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/) is recommended to keep your ruby applications from intefering with one another.
+
+Alternatively, you can add support for your OS of choice to [omnibus-flapjack](https://github.com/flpjck/omnibus-flapjack) and build a native package. Pull requests welcome!
+
+## Configuring
+
+Have a look at the default config file and modify things as required. See the [Configuring Components](https://github.com/flpjck/flapjack/wiki/USING#wiki-configuring_components) section on the wiki for more details.
+
+```bash
+# hack the config
+sudo vi /etc/flapjack/flapjack_config.yaml
+
+# reload the config
+sudo /etc/init.d/flapjack reload
+```
+
+## Running
+
+**Ubuntu Precise 64:**
+
+After installing the flapjack package, redis and flapjack should be automatically started.
+
+First up, start redis if it's not already started:
+```bash
+# status:
+sudo /etc/init.d/redis status
+
+# start:
+sudo /etc/init.d/redis start
+```
+
+Operating flapjack:
+```bash
+# status:
+sudo /etc/init.d/flapjack status
+
+# reload:
+sudo /etc/init.d/flapjack reload
+
+# restart:
+sudo /etc/init.d/flapjack restart
+
+# stop:
+sudo /etc/init.d/flapjack stop
+
+# start:
+sudo /etc/init.d/flapjack start
+```
+
+## Using - Details
 
 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
 

data/dist/etc/init.d/flapjack

@@ -1,10 +1,20 @@
 #!/bin/bash
-#
+
+### BEGIN INIT INFO
+# Provides:       flapjack
+# Required-Start: $syslog $remote_fs redis-flapjack
+# Required-Stop:  $syslog $remote_fs redis-flapjack
+# Should-Start:   $local_fs
+# Should-Stop:    $local_fs
+# Default-Start:  2 3 4 5
+# Default-Stop:   0 1 6
+# Short-Description:  flapjack - scalable monitoring notification system
+# Description:    flapjack - scalable monitoring notification system
+### END INIT INFO
+
 # Copyright (c) 2009-2013 Lindsay Holmwood <lindsay@holmwood.id.au>
 #
-# flapjack
 # Boots flapjack (coordinator, processor, notifier, gateways...)
-#
 
 PATH=/opt/flapjack/bin:$PATH
 
@@ -19,3 +29,4 @@ flapjack $1
 
 RETVAL=$?
 exit $RETVAL
+

data/etc/flapjack_config.yaml.example

@@ -9,7 +9,7 @@ production:
     syslog_errors: yes
   redis:
     host: 127.0.0.1
-    port: 6379
+    port: 6380
     db: 0
   processor:
     enabled: yes

data/lib/flapjack/gateways/jabber.rb

@@ -112,7 +112,7 @@ module Flapjack
             presence = Blather::Stanza::Presence.new
             presence.from = @flapjack_jid
             presence.to = Blather::JID.new("#{room}/#{@config['alias']}")
-            presence << "<x xmlns='http://jabber.org/protocol/muc'/>"
+            presence << "<x xmlns='http://jabber.org/protocol/muc'><history maxstanzas='0'></x>"
             EventMachine::Synchrony.next_tick do
               write presence
               say(room, "flapjack jabber gateway started at #{Time.now}, hello!", :groupchat)
@@ -171,7 +171,7 @@ module Flapjack
         command = th.chunks.join(' ')
 
         case command
-        when /^ACKID\s+(\d+)(?:\s*(.*?)(?:\s*duration:.*?(\w+.*))?)$/i
+        when /^ACKID\s+(\d+)(?:\s*(.*?)(?:\s*duration:.*?(\w+.*))?)$/im
           ackid        = $1
           comment      = $2
           duration_str = $3
@@ -241,7 +241,7 @@ module Flapjack
                  "System CPU Time: #{t.stime}\n" +
                  `uname -a`.chomp + "\n"
 
-        when /^test notifications for\s+([a-z0-9\-\.]+)(?::(.+))?$/i
+        when /^test notifications for\s+([a-z0-9\-\.]+)(?::(.+))?$/im
           entity_name = $1
           check_name  = $2 || 'test'
 
@@ -254,7 +254,7 @@ module Flapjack
             msg = "yeah, no I can't see #{entity_name} in my systems"
           end
 
-        when /^tell me about\s+([a-z0-9\-\.]+)(?::(.+))?$+/i
+        when /^tell me about\s+([a-z0-9\-\.]+)(?::(.+))?$+/im
           entity_name = $1
           check_name  = $2
 
@@ -280,7 +280,7 @@ module Flapjack
             msg = "hmmm, I can't see #{entity_name} in my systems"
           end
 
-        when /^(?:find )?checks(?:\s+matching\s+\/(.+)\/)?\s+on\s+(?:entities matching\s+\/(.+)\/|([a-z0-9\-\.]+))/i
+        when /^(?:find )?checks(?:\s+matching\s+\/(.+)\/)?\s+on\s+(?:entities matching\s+\/(.+)\/|([a-z0-9\-\.]+))/im
           check_pattern = $1 ? $1.chomp.strip : nil
           entity_pattern = $2 ? $2.chomp.strip : nil
           entity_name = $3
@@ -333,7 +333,7 @@ module Flapjack
             end
           end
 
-        when /^(?:find )?entities matching\s+\/(.+)\//i
+        when /^(?:find )?entities matching\s+\/(.+)\//im
           pattern = $1.chomp.strip
           entity_list = Flapjack::Data::Entity.find_all_name_matching(pattern, :redis => @redis)
 
@@ -371,7 +371,7 @@ module Flapjack
         return if @should_quit
         @logger.debug("groupchat message received: #{stanza.inspect}")
 
-        if stanza.body =~ /^#{@config['alias']}:\s+(.*)/
+        if stanza.body =~ /^#{@config['alias']}:\s+(.*)/m
           command = $1
         end
 
@@ -397,7 +397,7 @@ module Flapjack
         return if @should_quit
         @logger.debug("chat message received: #{stanza.inspect}")
 
-        if stanza.body =~ /^flapjack:\s+(.*)/
+        if stanza.body =~ /^flapjack:\s+(.*)/m
           command = $1
         else
           command = stanza.body

data/lib/flapjack/version.rb

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

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

@@ -116,6 +116,38 @@ describe Flapjack::Gateways::Jabber, :logger => true do
     fj.on_groupchat(stanza)
   end
 
+  it "handles a message with a newline in it" do
+    stanza.should_receive(:body).
+      and_return("flapjack: tell me about \nexample.com")
+
+    from = double('from')
+    from.should_receive(:stripped).and_return('sender')
+    stanza.should_receive(:from).and_return(from)
+
+    redis = double('redis')
+    entity = double(Flapjack::Data::Entity)
+    entity.should_receive(:check_list).and_return(['ping'])
+
+    Flapjack::Data::Entity.should_receive(:find_by_name).with('example.com',
+      :redis => redis).and_return(entity)
+
+    entity_check = double(Flapjack::Data::EntityCheck)
+    entity_check.should_receive(:current_maintenance).with(:scheduled => true).and_return(nil)
+    entity_check.should_receive(:current_maintenance).with(:unscheduled => true).and_return(nil)
+
+    Flapjack::Data::EntityCheck.should_receive(:for_entity).with(entity, 'ping',
+      :redis => redis).and_return(entity_check)
+
+    Flapjack::RedisPool.should_receive(:new).and_return(redis)
+    fj = Flapjack::Gateways::Jabber.new(:config => config, :logger => @logger)
+
+    EventMachine::Synchrony.should_receive(:next_tick).and_yield
+    fj.should_receive(:connected?).and_return(true)
+    fj.should_receive(:write).with(an_instance_of(Blather::Stanza::Message))
+
+    fj.on_groupchat(stanza)
+  end
+
   it "receives a message it doesn't understand" do
     stanza.should_receive(:body).once.and_return('flapjack: hello!')
     from = double('from')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 0.7.32
+  version: 0.7.33
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
@@ -558,7 +558,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 834691896094237630
+      hash: -3960452771586560623
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -567,7 +567,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 834691896094237630
+      hash: -3960452771586560623
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23