flapjack 1.0.0rc3 → 1.0.0rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d91c5e561fafc64a7698f898d1c02b6f00386c97
-  data.tar.gz: c7c4e4ba3e84c4a59ff09964fc67278c12b2fb04
+  metadata.gz: c120d5918cc99ade12d514f7e749575473d9ba2b
+  data.tar.gz: ea16941a668662bf037e43e83a657d47a11b444a
 SHA512:
-  metadata.gz: 6efd501448115a5a97a23df6ece95b2f53bf2b4a01d4fe268c1ae851bdb850aaa5d242497f2c5e4871f5b945076151081ae7df33b6eb15fe6e01f06d99a8cda0
-  data.tar.gz: d11a32ab75ad2cbcf7b9f9d432cd6f5dfd2da498b127a2c653291f55cf08b7f7eafbc9da9894510b94bbde7d9edcc5ac9ede703761c612563d5e32b2851dabad
+  metadata.gz: af27ce434e61d18e20efef7343524280267bb9c6b9c1fd75cb983757a5e6f8e0d16ff4a8337d70764617e8ec00c3b03a13033ebc86aa1cb7a0fb8eb06a2d3216
+  data.tar.gz: 0f5c37e9cd734d705e96440b0e742df38f3e28e3d18a57a4104deba38feab58fcd555dad6e33428c1bdf2bf0e850c910f2f7e275ee1d10eb13c2473c8b925a7e

data/.gitignore

@@ -25,10 +25,9 @@ tmp/spec*
 tmp/profiles
 flapjack-*.gem
 _site/*
-.rbenv-version
-.ruby-version
 .rvmrc
 artifacts/*
+libexec/httpchecker*
 libexec/httpbroker
 libexec/httpbroker.linux_386
 libexec/httpbroker.linux_amd64

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## Flapjack Changelog
 
+# 1.0.0rc5 - 2014-08-20
+- Bug: Fix fatal web UI errors #611 (@jessereynolds)
+- Bug: use same base time for Chronic, time comparison #615 (@ali-graham)
+- Feature: Add more ids for capybara testing #617 (@Hobbsee)
+
+# 1.0.0rc4 - 2014-08-19
+- Feature: Add maintenance to the CLI #597 (@Hobbsee)
+- Feature: Always show the search bar #604 (@Hobbsee)
+- Feature: Allow custom Flapjack branding #505 (@ferrisoxide)
+- Feature: Rename state with entity, and reparent orphaned entity data #600 (@ali-graham)
+- Feature: Added AWS SNS Notification Gateway #602 (@clarkf)
+- Feature: httpchecker binary from pandik project #601 (@michaelneale)
+- Feature: Add id labels to media boxes to make testing easier #610 (@Hobbsee)
+- Bug: gli 2.11 incompatability #585 (@jessereynolds)
+- Bug: web ui: editing contacts doesn't work with included example config #588 (@jessereynolds)
+- Bug: Add return code if the end unscheduled maintenance was successful #596 (@Hobbsee)
+- Bug: Pid fixes, handle exit codes correctly with GLI #603 (@Hobbsee)
+- Bug: PID and consistency fixes #606 (@Hobbsee)
+- Chore: Fix links to refer to our new flapjack documentation #590 (@Hobbsee)
+
 # 1.0.0rc3 - 2014-07-24
 - Bug: fix jsonapi methods for report checks/methods, maintenance reports, outage reports (@ali-graham)
 - Bug: improve tests around notification rules and rollup, tweak rollup behaviour on recovery (@ali-graham)

data/CONTRIBUTING.md

@@ -1,8 +1,8 @@
-#Contributing to ![Flapjack](https://raw.github.com/flapjack/flapjack/gh-pages/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
+#Contributing to ![Flapjack](http:////flapjack.io/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
 
 [![Build Status](https://travis-ci.org/flapjack/flapjack.png)](https://travis-ci.org/flapjack/flapjack)
 
-Please see the [Contributing to Flapjack](https://github.com/flapjack/flapjack/wiki/DEVELOPING) section of the Flapjack wiki.
+Please see the [Contributing to Flapjack](http://flapjack.io/docs/1.0/development/DEVELOPING) section of the Flapjack wiki.
 
 > Flapjack is, and will continue to be, well tested. Monitoring is like continuous integration for production apps, so why shouldn't your monitoring system have tests?
 

data/Gemfile

@@ -7,7 +7,7 @@ group :development do
 end
 
 group :test do
-  gem 'rspec', '~> 3.0.0.beta1'
+  gem 'rspec', '~> 3.0'
   gem 'cucumber'
   gem 'delorean'
   gem 'rack-test'

data/README.md

@@ -1,4 +1,4 @@
-# ![Flapjack](https://raw.github.com/flapjack/flapjack/gh-pages/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
+# ![Flapjack](http://flapjack.io/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
 
 [![Build Status](https://travis-ci.org/flapjack/flapjack.png)](https://travis-ci.org/flapjack/flapjack)
 
@@ -25,7 +25,7 @@ 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 sits downstream of check execution engines (like Nagios, Sensu, Icinga, or cron), processing events to determine: 
+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
@@ -81,7 +81,7 @@ You'll also need Redis >= 2.6.12.
 
 ## Configuring
 
-Have a look at the default config file and modify things as required. See the [Configuring Components](https://github.com/flapjack/flapjack/wiki/USING#wiki-configuring_components) section on the wiki for more details.
+Have a look at the default config file and modify things as required. See the [Configuring Components](http://flapjack.io/docs/1.0/usage/USING#wiki-configuring_components) section on the wiki for more details.
 
 ``` bash
 # hack the config
@@ -128,11 +128,11 @@ 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/flapjack/flapjack/wiki/USING) section of the Flapjack wiki
+For more information, including full specification of the configuration file and the data import formats, please refer to the [USING](http://flapjack.io/docs/1.0/usage/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 [DEVELOPING](https://github.com/flapjack/flapjack/wiki/DEVELOPING) section of the Flapjack wiki
+Information on developing more Flapjack components or contributing to core Flapjack development can be found in the [DEVELOPING](http://flapjack.io/docs/1.0/developing/DEVELOPING) section of the Flapjack wiki
 
 ## Documentation Submodule
 
@@ -151,14 +151,4 @@ If you make changes to the documentation locally, here's how to publish them:
 
 ## More on the wiki
 
-[The Flapjack wiki](https://github.com/flapjack/flapjack/wiki) has even more goodies:
-
-- [Using Flapjack](https://github.com/flapjack/flapjack/wiki/USING)
-- [Developing Flapjack](https://github.com/flapjack/flapjack/wiki/DEVELOPING)
-- [Redis Data Structure](https://github.com/flapjack/flapjack/wiki/DATA_STRUCTURES)
-- [API](https://github.com/flapjack/flapjack/wiki/API)
-- [Importing](https://github.com/flapjack/flapjack/wiki/IMPORTING)
-- [Debugging Flapjack](https://github.com/flapjack/flapjack/wiki/DEBUGGING)
-- [Flapjack Glossary](https://github.com/flapjack/flapjack/wiki/GLOSSARY)
-
-
+[The Flapjack wiki](http://flapjack.io/docs/1.0/wiki/) has even more goodies

data/build.sh

@@ -7,6 +7,8 @@ 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 get github.com/oguzbilgic/pandik
+mv bin/pandik libexec/httpchecker
 
 go test flapjack
 
@@ -18,5 +20,15 @@ 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
+  done 
+  
+  pushd src/github.com/oguzbilgic/pandik
+  GOOS=linux GOARCH=amd64 CGOENABLED=0 go build -x -o httpchecker.linux_amd64 
+  GOOS=linux GOARCH=386 CGOENABLED=0 go build -x -o httpchecker.linux_386 
+  popd 
+  mv src/github.com/oguzbilgic/pandik/httpchecker.linux_amd64 libexec/httpchecker.linux_amd64
+  mv src/github.com/oguzbilgic/pandik/httpchecker.linux_386 libexec/httpchecker.linux_386
+
 fi
+
+

data/etc/flapjack_config.yaml.example

@@ -1,8 +1,8 @@
 ---
 
 production:
-  pid_file: /var/run/flapjack/flapjack.pid
-  log_file: /var/log/flapjack/flapjack.log
+  pid_dir: /var/run/flapjack/
+  log_dir: /var/log/flapjack/
   daemonize: yes
   logger:
     level: INFO
@@ -11,23 +11,35 @@ production:
     host: 127.0.0.1
     port: 6380
     db: 0
+  # Processes monitoring events off the *events* queue (a redis list) and decides
+  # what actions to take (generate notification event, record state changes, etc)
   processor:
     enabled: yes
     queue: events
     notifier_queue: notifications
     archive_events: true
     events_archive_maxage: 10800
+    # Flapjack sets scheduled maintenance on new check results so contacts aren't
+    # notified as soon as Flapjack becomes aware of an entity to notify on.
+    # This is useful is cases where your monitoring starts checking something
+    # before it is completely provisioned
+    # Value parsed by https://github.com/hpoydar/chronic_duration
+    # You can disable this setting by specifying 0 seconds.
     new_check_scheduled_maintenance_duration: 100 years
     new_check_scheduled_maintenance_ignore_tags:
       - bypass_ncsm
     logger:
       level: INFO
       syslog_errors: yes
+  # Processes notification events off the *notifications* queue (a redis list) and
+  # works out who to notify, and on which media, and with what kind of notification
+  # message. It then creates jobs for the various notification gateways below.
   notifier:
     enabled: yes
     queue: notifications
     email_queue: email_notifications
     sms_queue: sms_notifications
+    sns_queue: sns_notifications
     jabber_queue: jabber_notifications
     pagerduty_queue: pagerduty_notifications
     notification_log_file: /var/log/flapjack/notification.log
@@ -37,19 +49,23 @@ production:
       syslog_errors: yes
   nagios-receiver:
     fifo: "/var/cache/nagios3/event_stream.fifo"
-    pid_file: "/var/run/flapjack/flapjack-nagios-receiver.pid"
-    log_file: "/var/log/flapjack/flapjack-nagios-receiver.log"
+    pid_dir: "/var/run/flapjack/"
+    log_dir: "/var/log/flapjack/"
   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"
+    pid_dir: "/var/run/flapjack/"
+    log_dir: "/var/log/flapjack/"
   gateways:
+    # Generates email notifications
     email:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: email_notifications
       logger:
         level: INFO
         syslog_errors: yes
+      # these values are passed directly through to EventMachine::Protocols::SmtpClient configuration,
+      # and can be omitted if the defaults are acceptable
       smtp_config:
         # from: "Flapjack Example <flapjack@noreply.example>"
         # reply_to: "flapjack@support.example"
@@ -69,8 +85,10 @@ production:
       #  alert.text: '/etc/flapjack/templates/email/alert.text.erb'
       #  rollup.html: '/etc/flapjack/templates/email/rollup.html.erb'
       #  alert.html: '/etc/flapjack/templates/email/alert.html.erb'
+    # Generates sms notifications
     sms:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: sms_notifications
       endpoint: 'https://www.messagenet.com.au/dotnet/Lodge.asmx/LodgeSMSMessage'
       username: "ermahgerd"
@@ -82,16 +100,29 @@ production:
       #templates:
       #  rollup.text: '/etc/flapjack/templates/sms/rollup.text.erb'
       #  alert.text: '/etc/flapjack/templates/sms/alert.text.erb'
+    # Generates SNS notifications
+    sns:
+      enabled: no
+      queue: sns_notifications
+      #region_name: us-east-1
+      # Don't forget to use an IAM user's credentials here so revocation is easy!
+      access_key: AKIAIOSFODNN7EXAMPLE
+      secret_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+    # Connects to an XMPP (jabber) server, sends notifications (to rooms and individuals),
+    # handles acknowledgements from jabber users and other commands.
     jabber:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: jabber_notifications
       server: "jabber.example.com"
       port: 5222
       jabberid: "flapjack@jabber.example.com"
       password: "good-password"
       alias: "flapjack"
+      # List of strings that this pikelet user will respond to
       identifiers:
         - "@flapjack"
+      # the Multi-User Chats the pikelet should join and announce to
       rooms:
         - "gimp@conference.jabber.example.com"
         - "log@conference.jabber.example.com"
@@ -102,8 +133,11 @@ production:
       #templates:
       #  rollup.text: '/etc/flapjack/templates/jabber/rollup.text.erb'
       #  alert.text: '/etc/flapjack/templates/jabber/alert.text.erb'
+    # Sends notifications to and accepts acknowledgements from [PagerDuty](http://www.pagerduty.com/)
+    # (NB: contacts will need to have a registered PagerDuty account to use this)
     pagerduty:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: pagerduty_notifications
       logger:
         level: INFO
@@ -111,16 +145,19 @@ production:
       # location of custom alert templates
       #templates:
       #  alert.text: '/etc/flapjack/templates/pagerduty/alert.text.erb'
+    # Browsable web interface
     web:
       enabled: yes
       port: 3080
       timeout: 300
       access_log: "/var/log/flapjack/web_access.log"
       api_url: "http://localhost:3081/"
+      # Full path to location of logo file, e.g. /etc/flapjack/custom_logo.png
       #logo_image_path: "/etc/flapjack/web/custom_logo/flapjack-2013-notext-transparent-300-300.png"
       logger:
         level: INFO
         syslog_errors: yes
+    # HTTP API server
     jsonapi:
       enabled: yes
       port: 3081
@@ -130,17 +167,25 @@ production:
       logger:
         level: INFO
         syslog_errors: yes
+    # "out-of-band" end-to-end testing, used for monitoring other instances of
+    # flapjack to ensure that they are running correctly
     oobetet:
       enabled: no
       server: "jabber.example.com"
       port: 5222
+      # jabberid, password, alias, rooms: see the jabber pikelet
       jabberid: "flapjacktest@jabber.example.com"
       password: "nuther-good-password"
       alias: "flapjacktest"
+      # The check oobetet should watch for the state change
       watched_check: "PING"
+      # The entitiy that the check should be associated with
       watched_entity: "foo.example.com"
+      # The maximum amount of time allowed to pass between state changes on that check
       max_latency: 300
+      # The API key for a service in PagerDuty that the oobetet will use to alert you
       pagerduty_contact: "11111111111111111111111111111111"
+      # Jabber rooms to join
       rooms:
         - "flapjacktest@conference.jabber.example.com"
         - "gimp@conference.jabber.example.com"
@@ -150,8 +195,8 @@ production:
         syslog_errors: yes
 
 development:
-  pid_file: tmp/pids/flapjack.pid
-  log_file: log/flapjack.log
+  pid_dir: tmp/pids/
+  log_dir: log/
   daemonize: yes
   logger:
     level: DEBUG
@@ -160,18 +205,29 @@ development:
     host: 127.0.0.1
     port: 6379
     db: 13
+  # Processes monitoring events off the *events* queue (a redis list) and decides
+  # what actions to take (generate notification event, record state changes, etc)
   processor:
     enabled: yes
     queue: events
     notifier_queue: notifications
     archive_events: true
     events_archive_maxage: 10800
+    # Flapjack sets scheduled maintenance on new check results so contacts aren't
+    # notified as soon as Flapjack becomes aware of an entity to notify on.
+    # This is useful is cases where your monitoring starts checking something
+    # before it is completely provisioned
+    # Value parsed by https://github.com/hpoydar/chronic_duration
+    # You can disable this setting by specifying 0 seconds.
     new_check_scheduled_maintenance_duration: 100 years
     new_check_scheduled_maintenance_ignore_tags:
       - bypass_ncsm
     logger:
       level: DEBUG
       syslog_errors: yes
+  # Processes notification events off the *notifications* queue (a redis list) and
+  # works out who to notify, and on which media, and with what kind of notification
+  # message. It then creates jobs for the various notification gateways below.
   notifier:
     enabled: yes
     queue: notifications
@@ -186,19 +242,23 @@ development:
       syslog_errors: yes
   nagios-receiver:
     fifo: "/var/cache/nagios3/event_stream.fifo"
-    pid_file: "tmp/pids/flapjack-nagios-receiver.pid"
-    log_file: "log/flapjack-nagios-receiver.log"
+    pid_dir: "tmp/pids/"
+    log_dir: "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"
+    pid_dir: "tmp/pids/"
+    log_dir: "log/"
   gateways:
+    # Generates email notifications
     email:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: email_notifications
       logger:
         level: DEBUG
         syslog_errors: yes
+      # these values are passed directly through to EventMachine::Protocols::SmtpClient configuration,
+      # and can be omitted if the defaults are acceptable
       smtp_config:
         # from: "Flapjack Example <flapjack@noreply.example>"
         # reply_to: "flapjack@support.example"
@@ -218,8 +278,10 @@ development:
       #  alert.text: '/etc/flapjack/templates/email/alert.text.erb'
       #  rollup.html: '/etc/flapjack/templates/email/rollup.html.erb'
       #  alert.html: '/etc/flapjack/templates/email/alert.html.erb'
+    # Generates sms notifications
     sms:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: sms_notifications
       endpoint: 'https://www.messagenet.com.au/dotnet/Lodge.asmx/LodgeSMSMessage'
       username: "ermahgerd"
@@ -231,14 +293,21 @@ development:
       #templates:
       #  rollup.text: '/etc/flapjack/templates/sms/rollup.text.erb'
       #  alert.text: '/etc/flapjack/templates/sms/alert.text.erb'
+    # Connects to an XMPP (jabber) server, sends notifications (to rooms and individuals),
+    # handles acknowledgements from jabber users and other commands.
     jabber:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: jabber_notifications
       server: "jabber.example.com"
       port: 5222
       jabberid: "flapjack@jabber.example.com"
       password: "good-password"
       alias: "flapjack"
+      # List of strings that this pikelet user will respond to
+      identifiers:
+        - "@flapjack"
+      # the Multi-User Chats the pikelet should join and announce to
       rooms:
         - "gimp@conference.jabber.example.com"
         - "log@conference.jabber.example.com"
@@ -249,8 +318,11 @@ development:
       #templates:
       #  rollup.text: '/etc/flapjack/templates/jabber/rollup.text.erb'
       #  alert.text: '/etc/flapjack/templates/jabber/alert.text.erb'
+    # Sends notifications to and accepts acknowledgements from [PagerDuty](http://www.pagerduty.com/)
+    # (NB: contacts will need to have a registered PagerDuty account to use this)
     pagerduty:
       enabled: no
+      # the redis queue this pikelet will look for notifications on
       queue: pagerduty_notifications
       logger:
         level: INFO
@@ -258,16 +330,19 @@ development:
       # location of custom alert templates
       #templates:
       #  alert.text: '/etc/flapjack/templates/pagerduty/alert.text.erb'
+    # Browsable web interface
     web:
       enabled: yes
       port: 3080
       timeout: 300
       access_log: "log/web_access.log"
       api_url: "http://localhost:3081/"
+      # Full path to location of logo file, e.g. /etc/flapjack/custom_logo.png
       #logo_image_path: "/etc/flapjack/web/custom_logo/flapjack-2013-notext-transparent-300-300.png"
       logger:
         level: DEBUG
         syslog_errors: yes
+    # HTTP API server
     jsonapi:
       enabled: yes
       port: 3081
@@ -277,17 +352,25 @@ development:
       logger:
         level: DEBUG
         syslog_errors: yes
+    # "out-of-band" end-to-end testing, used for monitoring other instances of
+    # flapjack to ensure that they are running correctly
     oobetet:
       enabled: no
       server: "jabber.example.com"
       port: 5222
+      # jabberid, password, alias, rooms: see the jabber pikelet
       jabberid: "flapjacktest@jabber.example.com"
       password: "nuther-good-password"
       alias: "flapjacktest"
+      # The check oobetet should watch for the state change
       watched_check: "PING"
+      # The entitiy that the check should be associated with
       watched_entity: "foo.example.com"
+      # The maximum amount of time allowed to pass between state changes on that check
       max_latency: 300
+      # The API key for a service in PagerDuty that the oobetet will use to alert you
       pagerduty_contact: "11111111111111111111111111111111"
+      # Jabber rooms to join
       rooms:
         - "flapjacktest@conference.jabber.example.com"
         - "gimp@conference.jabber.example.com"
@@ -297,5 +380,8 @@ development:
         syslog_errors: yes
 
 test:
+  pid_dir: tmp/pids/
+  log_dir: log/
   redis:
     db: 14
+    driver: ruby