flapjack 1.0.0rc1 → 1.0.0rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e16bef3e8503fd14954e5bdf4b843e9d92e598a6
-  data.tar.gz: b85df2a0ca05163744d236b6c6237c63ad1b2520
+  metadata.gz: dcd6cb806d57b78108cc67f2064b1b435a73f79e
+  data.tar.gz: 753950c0c1decff7c6d5fc954eede8a0e686d0ec
 SHA512:
-  metadata.gz: c0daf6b0e65f5810b695de85af843dfab1cafcda10d0e750c5e93adf6f4f0b9bf8506f19341cd0e29c5b06db47382a1016248d1f356fc335f47207187f8da9ce
-  data.tar.gz: 71fe02a6300726b86393640e1d919c43537b6f07a90d95e3a22ba366f05836dea16966227d11643530b1acf1e9dc0407464bbd73c23b54689ed70f413734183a
+  metadata.gz: 08641c26fb0307d9d9df4d97cc28876d962e883ea5094e719a2837eaad608f8f03d5c936a495cb42aba8d67c651c89dfc1a70da2a22e4aaf5caa70d5414c61b3
+  data.tar.gz: 7011a9ad02bf9bebed297f288496f7e1dc5af7a91e9fffa1d85e78a040514fc069e9cbe021917533f32b3f224b3f1b7c63f5f5d981749c0420afcbd04f52a1dc

data/.gitignore

@@ -29,3 +29,11 @@ _site/*
 .ruby-version
 .rvmrc
 artifacts/*
+libexec/httpbroker
+libexec/httpbroker.linux_386
+libexec/httpbroker.linux_amd64
+libexec/oneoff
+libexec/oneoff.linux_386
+libexec/oneoff.linux_amd64
+src/github.com
+src/gopkg.in

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## Flapjack Changelog
 
+# 1.0.0rc2 - 2014-07-17
+- Feature: jsonapi GET /checks badab0d (@ali-graham)
+- Feature: Add HTTP broker, one-off event submitter, general Go support #553 (@auxesis)
+- Feature: Add ability to disable check via JSON API #529 (@ali-graham)
+- Feature: Jabber - Resource in JID should be supported in the config #557 (@jessereynolds)
+- Feature: Jabber - add an 'identifiers' list to the config #558 (@jessereynolds)
+- Feature: Jabber - handle HipChat style status updates as per XEP-0085 #559 (@jessereynolds)
+- Feature: auto generate entity ID on creation if none supplied #568 (@jessereynolds)
+- Feature: Use friendly help if you run the server with old syntax #564 (@Hobbsee)
+- Bug: Decommission Check button returning a 404 #538 (@ali-graham)
+- Bug: incorrect default config path in flapjack gli #554 (@jessereynolds)
+- Bug: make sure that base_url isn't escaped so that links work correctly #556 (@mattdelves)
+- Chore: Update development section of example config file #546 (@Hobbsee)
+
+
 # 1.0.0rc1 - 2014-06-25
 - Feature: Allow ncsm to be skipped using a configured whitelist #485 (@StephenWeber)
 - Feature: GLI the CLI (one command to rule them all) #478 (@auxesis, @ali-graham)

data/README.md

@@ -15,6 +15,10 @@ Flapjack will be immediately useful to you if:
 * 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.
 
+### Try it out with the Quickstart Guide
+
+The [Quickstart](http://flapjack.io/quickstart/) guide will help you get Flapjack up and running in a VM locally using Vagrant and VirtualBox.
+
 ### 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.

data/bin/flapjack

@@ -12,7 +12,7 @@ program_desc 'Flexible monitoring notification routing system'
 version Flapjack::VERSION
 
 desc 'Configuration file to use'
-default_value '/etc/flapjack/flapjack.yaml'
+default_value '/etc/flapjack/flapjack_config.yaml'
 arg_name '/path/to/flapjack.yaml'
 flag [:c,:config]
 
@@ -34,7 +34,20 @@ post do |global,command,options,args|
 end
 
 on_error do |exception|
-  true
+  # We've changed the commands to control the flapjack server.  If we detect
+  # the user has tried one of the old commands, show them what they should
+  # have used instead.
+  SERVER_COMMANDS = %w(start stop restart reload status)
+  message = exception.message
+  input = message.split("'").last.downcase
+  old_command = message.start_with?('Unknown command') && SERVER_COMMANDS.include?(input)
+  if old_command
+    puts exception.message
+    puts "\nDid you mean: #{$PROGRAM_NAME} server #{input}?"
+    puts "\nTry #{$PROGRAM_NAME} help"
+  end
+  # If this wasn't an old server command, return true to show the standard error dialog
+  !old_command
 end
 
 exit run(ARGV)

data/build.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+export GOPATH=$(pwd):$GOPATH
+
+go get github.com/garyburd/redigo/redis
+go get github.com/go-martini/martini
+go get gopkg.in/alecthomas/kingpin.v1
+
+go test flapjack
+
+go build -x -o libexec/httpbroker libexec/httpbroker.go
+go build -x -o libexec/oneoff libexec/oneoff.go
+
+
+if [ ! -z "$CROSSCOMPILE" ]; then
+  for command in httpbroker oneoff; do
+    GOOS=linux GOARCH=amd64 CGOENABLED=0 go build -x -o libexec/$command.linux_amd64 libexec/$command.go
+    GOOS=linux GOARCH=386 CGOENABLED=0 go build -x -o libexec/$command.linux_386 libexec/$command.go
+  done
+fi

data/dist/etc/init.d/flapjack

@@ -25,7 +25,7 @@ if [ ! $(which flapjack) ]; then
 fi
 
 # Evaluate command
-flapjack $1
+flapjack server $@
 
 RETVAL=$?
 exit $RETVAL

data/dist/etc/init.d/flapjack-nagios-receiver

@@ -8,14 +8,14 @@
 
 PATH=/opt/flapjack/bin:$PATH
 
-if [ ! $(which flapjack-nagios-receiver) ]; then
-  echo "Error: flapjack-nagios-receiver isn't in PATH."
+if [ ! $(which flapjack) ]; then
+  echo "Error: flapjack isn't in PATH."
   echo "Refusing to do anything!"
   exit 1
 fi
 
 # Evaluate command
-flapjack-nagios-receiver $1 --daemonize
+flapjack receiver nagios $1 --daemonize
 
 RETVAL=$?
 exit $RETVAL

data/dist/etc/init.d/flapper

@@ -5,14 +5,14 @@
 
 PATH=/opt/flapjack/bin:$PATH
 
-if [ ! $(which flapper) ]; then
-  echo "Error: flapper isn't in PATH."
+if [ ! $(which flapjack) ]; then
+  echo "Error: flapjack isn't in PATH."
   echo "Refusing to do anything!"
   exit 1
 fi
 
 # Evaluate command
-flapper $1
+flapjack flapper $1
 
 RETVAL=$?
 exit $RETVAL

data/etc/flapjack_config.yaml.example

@@ -90,6 +90,8 @@ production:
       jabberid: "flapjack@jabber.example.com"
       password: "good-password"
       alias: "flapjack"
+      identifiers:
+        - "@flapjack"
       rooms:
         - "gimp@conference.jabber.example.com"
         - "log@conference.jabber.example.com"
@@ -152,7 +154,7 @@ development:
   log_file: log/flapjack.log
   daemonize: yes
   logger:
-    level: INFO
+    level: DEBUG
     syslog_errors: yes
   redis:
     host: 127.0.0.1
@@ -165,7 +167,8 @@ development:
     archive_events: true
     events_archive_maxage: 10800
     new_check_scheduled_maintenance_duration: 100 years
-    new_check_scheduled_maintenance_ignore: onetime
+    new_check_scheduled_maintenance_ignore_tags:
+      - bypass_ncsm
     logger:
       level: DEBUG
       syslog_errors: yes
@@ -182,19 +185,25 @@ development:
       level: DEBUG
       syslog_errors: yes
   nagios-receiver:
-    fifo: "/usr/local/var/lib/nagios/event_stream.fifo"
+    fifo: "/var/cache/nagios3/event_stream.fifo"
     pid_file: "tmp/pids/flapjack-nagios-receiver.pid"
     log_file: "log/flapjack-nagios-receiver.log"
+  nsca-receiver:
+    fifo: "/var/lib/nagios3/rw/nagios.cmd"
+    pid_file: "/var/run/flapjack/flapjack-nsca-receiver.pid"
+    log_file: "/var/log/flapjack/flapjack-nsca-receiver.log"
   gateways:
     email:
-      enabled: yes
+      enabled: no
       queue: email_notifications
       logger:
-        level: INFO
+        level: DEBUG
         syslog_errors: yes
       smtp_config:
-        # port 1025 is the default port for http://mailcatcher.me
+        # from: "Flapjack Example <flapjack@noreply.example>"
+        # reply_to: "flapjack@support.example"
         host: 127.0.0.1
+        # 1025 is the default port for http://mailcatcher.me
         port: 1025
         starttls: false
         #auth:
@@ -210,15 +219,13 @@ development:
       #  rollup.html: '/etc/flapjack/templates/email/rollup.html.erb'
       #  alert.html: '/etc/flapjack/templates/email/alert.html.erb'
     sms:
-      enabled: yes
+      enabled: no
       queue: sms_notifications
-      # if you run up something like 200ok locally you can then view the
-      # sms messages being emitted
-      endpoint: 'http://localhost:9292/FakeMessagenetAPI.aspx'
-      username: "gretta"
+      endpoint: 'https://www.messagenet.com.au/dotnet/Lodge.asmx/LodgeSMSMessage'
+      username: "ermahgerd"
       password: "xxxx"
       logger:
-        level: INFO
+        level: DEBUG
         syslog_errors: yes
       # location of custom alert templates
       #templates:
@@ -230,13 +237,13 @@ development:
       server: "jabber.example.com"
       port: 5222
       jabberid: "flapjack@jabber.example.com"
-      password: "xxxx"
+      password: "good-password"
       alias: "flapjack"
       rooms:
         - "gimp@conference.jabber.example.com"
         - "log@conference.jabber.example.com"
       logger:
-        level: INFO
+        level: DEBUG
         syslog_errors: yes
       # location of custom alert templates
       #templates:
@@ -253,11 +260,22 @@ development:
       #  alert.text: '/etc/flapjack/templates/pagerduty/alert.text.erb'
     web:
       enabled: yes
-      port: 4080
+      port: 3080
       timeout: 300
       access_log: "log/web_access.log"
+      api_url: "http://localhost:3081/"
+      #logo_image_path: "/etc/flapjack/web/custom_logo/flapjack-2013-notext-transparent-300-300.png"
       logger:
-        level: INFO
+        level: DEBUG
+        syslog_errors: yes
+    jsonapi:
+      enabled: yes
+      port: 3081
+      timeout: 300
+      access_log: "log/jsonapi_access.log"
+      base_url: "http://localhost:3081/"
+      logger:
+        level: DEBUG
         syslog_errors: yes
     oobetet:
       enabled: no
@@ -275,7 +293,7 @@ development:
         - "gimp@conference.jabber.example.com"
         - "log@conference.jabber.example.com"
       logger:
-        level: INFO
+        level: DEBUG
         syslog_errors: yes
 
 test:

data/lib/flapjack/cli/receiver.rb

@@ -8,6 +8,7 @@ Oj.default_options = { :indent => 0, :mode => :strict }
 
 require 'flapjack/configuration'
 require 'flapjack/data/event'
+require 'flapjack/patches'
 
 # TODO options should be overridden by similar config file options
 
@@ -630,8 +631,31 @@ command :receiver do |receiver|
     end
   end
 
-end
 
+  receiver.desc 'One-off event submitter'
+  receiver.command :oneoff do |oneoff|
+    oneoff.passthrough = true
+    oneoff.action do |global_options, options, args|
+      libexec = Pathname.new(__FILE__).parent.parent.parent.parent.join('libexec').expand_path
+      oneoff  = libexec.join('oneoff')
+      if oneoff.exist?
+        Kernel.exec(oneoff.to_s, *ARGV)
+      end
+    end
+  end
+
+  receiver.desc 'HTTP API that caches and submits events'
+  receiver.command :httpbroker do |httpbroker|
+    httpbroker.passthrough = true
+    httpbroker.action do |global_options, options, args|
+      libexec = Pathname.new(__FILE__).parent.parent.parent.parent.join('libexec').expand_path
+      httpbroker  = libexec.join('httpbroker')
+      if httpbroker.exist?
+        Kernel.exec(httpbroker.to_s, *ARGV)
+      end
+    end
+  end
+end
 
 
 # # Nsca example line for a storage-device check:

data/lib/flapjack/cli/simulate.rb

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 
+require 'eventmachine'
+require 'em-synchrony'
 require 'redis'
+require 'redis/connection/synchrony'
 
 require 'flapjack/configuration'
 require 'flapjack/data/event'
@@ -66,25 +69,29 @@ module Flapjack
         recovery = event.merge('state' => 'ok',  'summary' => 'Simulated check output (test by operator)')
         key = "#{event['entity']}:#{event['check']}"
 
-        puts "#{Time.now}: sending failure event (#{state}) for #{key}"
-        Flapjack::Data::Event.add(failure, :redis => redis)
+        EM.synchrony do
 
-        EM.run do
+          puts "#{Time.now}: sending failure event (#{state}) for #{key}"
+          Flapjack::Data::Event.add(failure, :redis => redis)
 
           EM.add_timer(stop_after) do
             puts "#{Time.now}: stopping"
             if recover
-              puts "#{Time.now}: sending recovery event for #{key}"
-              Flapjack::Data::Event.add(recovery.merge('time' => Time.now.to_i),
-                :redis => redis)
+              EM.synchrony do
+                puts "#{Time.now}: sending recovery event for #{key}"
+                Flapjack::Data::Event.add(recovery.merge('time' => Time.now.to_i),
+                  :redis => redis)
+              end
             end
             EM.stop
           end
 
           EM.add_periodic_timer(opts[:interval]) do
-            puts "#{Time.now}: sending failure event (#{state}) for #{key}"
-            Flapjack::Data::Event.add(failure.merge('time' => Time.now.to_i),
-              :redis => redis)
+            EM.synchrony do
+              puts "#{Time.now}: sending failure event (#{state}) for #{key}"
+              Flapjack::Data::Event.add(failure.merge('time' => Time.now.to_i),
+                :redis => redis)
+            end
           end
 
         end

data/lib/flapjack/data/entity.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'securerandom'
+
 require 'flapjack/data/contact'
 require 'flapjack/data/tag'
 require 'flapjack/data/tag_set'
@@ -34,28 +36,22 @@ module Flapjack
 
         #FIXME: should probably raise an exception if trying to create a new entity with the
         # same name or id as an existing entity. (Go away and use update instead.)
-        if entity['id']
-          existing_name = redis.hget("entity:#{entity['id']}", 'name')
-          redis.del("entity_id:#{existing_name}") unless existing_name == entity['name']
-          redis.set("entity_id:#{entity['name']}", entity['id'])
-          redis.hset("entity:#{entity['id']}", 'name', entity['name'])
-
-          redis.del("contacts_for:#{entity['id']}")
-          if entity['contacts'] && entity['contacts'].respond_to?(:each)
-            entity['contacts'].each {|contact_id|
-              next if Flapjack::Data::Contact.find_by_id(contact_id, :redis => redis).nil?
-              redis.sadd("contacts_for:#{entity['id']}", contact_id)
-            }
-          end
-          self.new(:name  => entity['name'],
-                   :id    => entity['id'],
-                   :redis => redis)
-        else
-          # empty string is the redis equivalent of a Ruby nil, i.e. key with
-          # no value
-          redis.set("entity_id:#{entity['name']}", '')
-          nil
+        entity_id = entity['id'] ? entity['id'] : SecureRandom.uuid
+        existing_name = redis.hget("entity:#{entity_id}", 'name')
+        redis.del("entity_id:#{existing_name}") unless existing_name == entity['name']
+        redis.set("entity_id:#{entity['name']}", entity_id)
+        redis.hset("entity:#{entity_id}", 'name', entity['name'])
+
+        redis.del("contacts_for:#{entity_id}")
+        if entity['contacts'] && entity['contacts'].respond_to?(:each)
+          entity['contacts'].each {|contact_id|
+            next if Flapjack::Data::Contact.find_by_id(contact_id, :redis => redis).nil?
+            redis.sadd("contacts_for:#{entity_id}", contact_id)
+          }
         end
+        self.new(:name  => entity['name'],
+                 :id    => entity_id,
+                 :redis => redis)
       end
 
       def self.find_by_name(entity_name, options = {})

data/lib/flapjack/data/entity_check.rb

@@ -661,6 +661,16 @@ module Flapjack
         @ack_hash
       end
 
+      def to_jsonapi(opts = {})
+        {
+          "name"        => @check,
+          "entity_name" => @entity.name,
+          "links"       => {
+            :entities     => opts[:entity_ids] || [],
+          }
+        }.to_json
+      end
+
     private
 
       def initialize(entity, check, options = {})