flapjack 0.7.35 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01e6182ada345384e280d5ed7a9ead80cc1c47c9
+  data.tar.gz: 2c93d9a269af81a435b8d24f17b96c5ffd69996a
+SHA512:
+  metadata.gz: ae3191374c88fae709ada04de6a27cdcd7203e99fb1bde425bf76819681f8c9bad2841f02207c2e41e37cc87b7cd15ede2bb7c61d48aba7af8e6cce6f3bce2ef
+  data.tar.gz: 43f07542553f64a3f886dc8f4dc7efb7f51dc23ddf3f4a802c7ee2fe9eedfb4ef768878655644fc5f8f4316377b21075f7e10d50b18d30f458fd5c3a8998053e

data/.gitignore

@@ -24,8 +24,8 @@ tmp/pids/*
 tmp/spec*
 tmp/profiles
 flapjack-*.gem
+_site/*
 .rbenv-version
 .ruby-version
 .rvmrc
 artifacts/*
-

data/Gemfile

@@ -7,7 +7,7 @@ group :development do
 end
 
 group :test do
-  gem 'rspec'
+  gem 'rspec', '~> 3.0.0.beta1'
   gem 'cucumber'
   gem 'delorean'
   gem 'rack-test'
@@ -15,12 +15,11 @@ group :test do
   gem 'resque_spec'
   gem 'webmock'
   gem 'guard'
-  gem 'rb-fsevent', '~> 0.9.1'
+  gem 'rb-fsevent'
   gem 'guard-rspec'
   gem 'guard-cucumber'
   gem 'fuubar'
-  gem 'fuubar-cucumber'
   gem 'simplecov', :require => false
-  gem 'json_spec'
+  gem 'debugger-ruby_core_source', '>= 1.3.1' # required for perftools
   gem 'perftools.rb'
 end

data/Guardfile

@@ -7,7 +7,7 @@ end
 
 # NB: seems to be buggy with the default --progress formatter, was
 # causing failures to parse the features
-guard 'cucumber', :cli => '--no-profile --color --format Cucumber::Formatter::Fuubar --strict' do
+guard 'cucumber', :cli => '--no-profile --color --strict' do
   watch(%r{^features/.+\.feature$})
   watch(%r{^features/support/.+$})          { 'features' }
   watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }

data/README.md

@@ -2,15 +2,30 @@
 
 [![Build Status](https://travis-ci.org/flpjck/flapjack.png)](https://travis-ci.org/flpjck/flapjack)
 
-[flapjack-project.com](http://flapjack-project.com/)
+[Flapjack](http://flapjack.io/) is a flexible monitoring notification routing system that handles:
 
-Flapjack is a highly scalable and distributed monitoring notification system.
+* **Alert routing** (determining who should receive alerts based on interest, time of day, scheduled maintenance, etc)
+* **Alert summarisation** (with per-user, per media summary thresholds)
+* **Your standard operational tasks** (setting scheduled maintenance, acknowledgements, etc)
+
+Flapjack will be immediately useful to you if:
+
+* You want to **identify failures faster** by rolling up your alerts across multiple monitoring systems.
+* You monitor infrastructures that have **multiple teams responsible** for keeping them up.
+* Your monitoring infrastructure is **multitenant**, and each customer has a **bespoke alerting strategy**.
+* You want to dip your toe in the water and try alternative check execution engines like Sensu, Icinga, or cron in parallel to Nagios.
+
+### The technical low-down
 
 Flapjack provides a scalable method for dealing with events representing changes in system state (OK -> WARNING -> CRITICAL transitions) and alerting appropriate people as necessary.
 
 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 picks up the events and processes them -- deciding when and who to notifify about problems, recoveries, acknowledgements, etc.
+Flapjack sits downstream of check execution engines (like Nagios, Sensu, Icinga, or cron), processing events to determine: 
+
+ * if a problem has been detected
+ * who should know about the problem
+ * how they should be told
 
 Additional check engines can be supported by adding additional receiver processes similar to the nagios receiver.
 
@@ -18,25 +33,25 @@ Additional check engines can be supported by adding additional receiver processe
 
 **Ubuntu Precise 64 (12.04):**
 
-Add the flapjack deb repository to your apt sources:
+Add the Flapjack Debian repository to your Apt sources:
 
-```text
+``` 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:
+Install the latest Flapjack package:
 
-```text
+``` 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.
+The Flapjack package is an [Omnibus](https://github.com/opscode/omnibus-ruby) 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:
+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)
 
@@ -44,23 +59,25 @@ And consume the REST API at:
 
 [http://localhost:3081/](http://localhost:3081)
 
+N.B. The Redis installed by Flapjack runs on a non-standard port, so it doesn't conflict with other Redis instances you may already have installed.
+
 **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:
+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.
+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!
+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, and we'll help you make this happen!
 
 ## 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
+``` bash
 # hack the config
 sudo vi /etc/flapjack/flapjack_config.yaml
 
@@ -72,10 +89,11 @@ sudo /etc/init.d/flapjack reload
 
 **Ubuntu Precise 64:**
 
-After installing the flapjack package, redis and flapjack should be automatically started.
+After installing the Flapjack package, Redis and Flapjack should be automatically started.
 
-First up, start redis if it's not already started:
-```bash
+First up, start Redis if it's not already started:
+
+``` bash
 # status:
 sudo /etc/init.d/redis status
 
@@ -83,8 +101,9 @@ sudo /etc/init.d/redis status
 sudo /etc/init.d/redis start
 ```
 
-Operating flapjack:
-```bash
+Operating Flapjack:
+
+``` bash
 # status:
 sudo /etc/init.d/flapjack status
 
@@ -126,7 +145,7 @@ If you make changes to the documentation locally, here's how to publish them:
 
 ## More on the wiki
 
-https://github.com/flpjck/flapjack/wiki has even more goodies:
+[The Flapjack 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)

data/Rakefile

@@ -19,9 +19,7 @@ Bundler::GemHelper.install_tasks
 
 Cucumber::Rake::Task.new(:features) do |t|
   #t.cucumber_opts = 'features --format pretty'
-  #t.cucumber_opts = '--format progress'
-  #t.cucumber_opts = '--format fuubar'
-  t.cucumber_opts = '--format Cucumber::Formatter::Fuubar'
+  t.cucumber_opts = '--format progress'
 end
 
 require 'rspec/core/rake_task'

data/etc/flapjack_config.yaml.example

@@ -87,13 +87,23 @@ production:
       port: 3080
       timeout: 300
       access_log: "/var/log/flapjack/web_access.log"
+      api_url: "http://localhost:3081/"
       logger:
         level: INFO
         syslog_errors: yes
-    api:
+    jsonapi:
       enabled: yes
       port: 3081
       timeout: 300
+      access_log: "/var/log/flapjack/jsonapi_access.log"
+      base_url: "http://localhost:3081/"
+      logger:
+        level: INFO
+        syslog_errors: yes
+    api:
+      enabled: yes
+      port: 3071
+      timeout: 300
       access_log: "/var/log/flapjack/api_access.log"
       logger:
         level: INFO

data/features/steps/cli_steps.rb

@@ -60,7 +60,7 @@ Then /^(\S+) should ((?:re)?start|stop) within (\d+) seconds$/ do |exe, start_st
       attempts += 1; sleep 0.1; retry if attempts < max_attempts
       running = false
     end
-    running.should be_true
+    expect(running).to be true
   when 'stop'
     if process
       # it's a child process, so we can use waitpid
@@ -84,7 +84,7 @@ Then /^(\S+) should ((?:re)?start|stop) within (\d+) seconds$/ do |exe, start_st
         end
       end
     end
-    running.should be_false
+    expect(running).to be false
   when 'restart'
     read_pid = nil
     while attempts < max_attempts
@@ -93,7 +93,7 @@ Then /^(\S+) should ((?:re)?start|stop) within (\d+) seconds$/ do |exe, start_st
       break if read_pid != pid
       attempts += 1; sleep 0.1
     end
-    read_pid.should_not == pid
+    expect(read_pid).not_to eq(pid)
   end
 
 end

data/features/steps/events_steps.rb

@@ -279,7 +279,7 @@ Then /^a notification should not be generated(?: for check '([\w\.\-]+)' on enti
   entity ||= @entity
   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
+  expect(found).to be_truthy
 end
 
 Then /^a notification should be generated(?: for check '([\w\.\-]+)' on entity '([\w\.\-]+)')?$/ do |check, entity|
@@ -287,13 +287,13 @@ Then /^a notification should be generated(?: for check '([\w\.\-]+)' on entity '
   entity ||= @entity
   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
+  expect(found).to be_truthy
 end
 
 Then /^(un)?scheduled maintenance should be generated(?: for check '([\w\.\-]+)' on entity '([\w\.\-]+)')?$/ do |unsched, check, entity|
   check  ||= @check
   entity ||= @entity
-  @redis.get("#{entity}:#{check}:#{unsched || ''}scheduled_maintenance").should_not be_nil
+  expect(@redis.get("#{entity}:#{check}:#{unsched || ''}scheduled_maintenance")).not_to be_nil
 end
 
 Then /^show me the (\w+ )*log$/ do |adjective|
@@ -401,7 +401,7 @@ Given /^user (\S+) has the following notification rules:$/ do |contact_id, rules
 end
 
 Then /^all alert dropping keys for user (\S+) should have expired$/ do |contact_id|
-  @redis.keys("drop_alerts_for_contact:#{contact_id}*").should be_empty
+  expect(@redis.keys("drop_alerts_for_contact:#{contact_id}*")).to be_empty
 end
 
 Then /^(\w+) (\w+) alert(?:s)?(?: of)?(?: type (\w+))?(?: and)?(?: rollup (\w+))? should be queued for (.*)$/ do |num_queued, media, notification_type, rollup, address|
@@ -412,7 +412,7 @@ Then /^(\w+) (\w+) alert(?:s)?(?: of)?(?: type (\w+))?(?: and)?(?: rollup (\w+))
     num_queued = 0
   end
   queue = Resque.peek("#{media}_notifications", 0, 30)
-  queue.find_all {|n|
+  queued_length = queue.find_all {|n|
     type_ok = notification_type ? ( n['args'].first['notification_type'] == notification_type ) : true
     rollup_ok = true
     if rollup
@@ -423,7 +423,8 @@ Then /^(\w+) (\w+) alert(?:s)?(?: of)?(?: type (\w+))?(?: and)?(?: rollup (\w+))
       end
     end
     type_ok && rollup_ok && ( n['args'].first['address'] == address )
-  }.length.should == num_queued.to_i
+  }.length
+  expect(queued_length).to eq(num_queued.to_i)
 end
 
 When(/^user (\S+) ceases to be a contact of entity '(.*)'$/) do |contact_id, entity|

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

@@ -6,16 +6,16 @@ Given /^NetSaint configuration is at "([^"]*)"$/ do |path|
   files << root.join('netsaint.cfg')
   files << root.join('resource.cfg')
 
-  File.directory?(root).should be_true
+  expect(File.directory?(root)).to be true
   files.each do |filename|
-    File.exists?(filename).should be_true
+    expect(File.exists?(filename)).to be true
   end
 end
 
 Then /^I should see a valid JSON output$/ do
-  lambda {
+  expect {
     @data = Oj.load(@output)
-  }.should_not raise_error
+  }.not_to raise_error
 end
 
 Then /^show me the output$/ do
@@ -23,8 +23,8 @@ Then /^show me the output$/ do
 end
 
 Then /^I should see a list of (\w+)$/ do |type|
-  @data[type].should_not be_nil
-  @data[type].size.should > 0
+  expect(@data[type]).not_to be_nil
+  expect(@data[type].size).to be > 0
 end
 
 Then /^I should see the following attributes for every (\w+):$/ do |type, table|
@@ -33,7 +33,7 @@ Then /^I should see the following attributes for every (\w+):$/ do |type, table|
   @data[type].each_pair do |name, items|
     items.each do |item|
       values.each do |attr|
-        item[attr].should_not be_nil
+        expect(item[attr]).not_to be_nil
       end
     end
   end
@@ -42,7 +42,7 @@ Then /^I should see the following attributes for every (\w+):$/ do |type, table|
   @data[type].each_pair do |name, items|
     items.each do |item|
       nils.each do |attr|
-        item.member?(attr).should be_true
+        expect(item.member?(attr)).to be true
       end
     end
   end

data/features/steps/notifications_steps.rb

@@ -84,22 +84,22 @@ end
 
 Then /^an SMS notification for entity '([\w\.\-]+)' should be queued for the user$/ do |entity|
   queue = ResqueSpec.peek('sms_notifications')
-  queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }.should_not be_empty
+  expect(queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }).not_to be_empty
 end
 
 Then /^an email notification for entity '([\w\.\-]+)' should be queued for the user$/ do |entity|
   queue = ResqueSpec.peek('email_notifications')
-  queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }.should_not be_empty
+  expect(queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }).not_to be_empty
 end
 
 Then /^an SMS notification for entity '([\w\.\-]+)' should not be queued for the user$/ do |entity|
   queue = ResqueSpec.peek('sms_notifications')
-  queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }.should be_empty
+  expect(queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }).to be_empty
 end
 
 Then /^an email notification for entity '([\w\.\-]+)' should not be queued for the user$/ do |entity|
   queue = ResqueSpec.peek('email_notifications')
-  queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }.should be_empty
+  expect(queue.select {|n| n[:args].first['event_id'] =~ /#{entity}:ping/ }).to be_empty
 end
 
 Given /^a user SMS notification has been queued for entity '([\w\.\-]+)'$/ do |entity|
@@ -199,19 +199,19 @@ When /^the email notification handler fails to send an email$/ do
 end
 
 Then /^the user should receive an SMS notification$/ do
-  @request.should have_been_requested
-  Flapjack::Gateways::SmsMessagenet.instance_variable_get('@sent').should == 1
+  expect(@request).to have_been_requested
+  expect(Flapjack::Gateways::SmsMessagenet.instance_variable_get('@sent')).to eq(1)
 end
 
 Then /^the user should receive an email notification$/ do
-  Flapjack::Gateways::Email.instance_variable_get('@sent').should == 1
+  expect(Flapjack::Gateways::Email.instance_variable_get('@sent')).to eq(1)
 end
 
 Then /^the user should not receive an SMS notification$/ do
-  @request.should have_been_requested
-  Flapjack::Gateways::SmsMessagenet.instance_variable_get('@sent').should == 0
+  expect(@request).to have_been_requested
+  expect(Flapjack::Gateways::SmsMessagenet.instance_variable_get('@sent')).to eq(0)
 end
 
 Then /^the user should not receive an email notification$/ do
-  Flapjack::Gateways::Email.instance_variable_get('@sent').should == 0
+  expect(Flapjack::Gateways::Email.instance_variable_get('@sent')).to eq(0)
 end

data/features/steps/packaging-lintian_steps.rb

@@ -1,14 +1,14 @@
 Given /^I am at the project root$/ do
-  Dir.pwd.split('/').last.should == "flapjack"
+  expect(Dir.pwd.split('/').last).to eq("flapjack")
 end
 
 Then /^I should see (\d+) lines of output$/ do |number|
-  @output.split.size.should == number.to_i
+  expect(@output.split.size).to eq(number.to_i)
 end
 
 Then /^every file in the output should start with "([^\"]*)"$/ do |string|
   @output.split.each do |file|
-    `head -n 1 #{file}`.should =~ /^#{string}\s*$/
+    expect(`head -n 1 #{file}`).to match(/^#{string}\s*$/)
   end
 end
 
@@ -21,13 +21,9 @@ When /^I run `([^"]*)`$/ do |cmd|
 end
 
 Then /^the exit status should( not)? be (\d+)$/ do |negativity, number|
-  if negativity
-    @exit_status.should_not == number.to_i
-  else
-    @exit_status.should == number.to_i
-  end
+  expect(@exit_status).send(negativity ? :not_to : :to, eq(number.to_i))
 end
 
 Then /^the output should contain "([^"]*)"$/ do |matcher|
-  @output.should include(matcher)
+  expect(@output).to include(matcher)
 end

data/features/steps/time_travel_steps.rb

@@ -40,6 +40,6 @@ end
 # Then /^the time in UTC should be about (.+)$/ do |timestamp|
 #   actual = Time.now.in_time_zone('UTC')
 #   expected = Time.parse("#{timestamp} UTC")
-#   (expected..expected+5).cover?(actual).should be_true
+#   (expected..expected+5).cover?(actual).should be true
 # end