pagerduty_tools 0.3.0

data/.gitignore

@@ -0,0 +1,41 @@
+# Ruby
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+pkg/*
+
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Emacs
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+.elc
+auto-save-list
+tramp
+
+# OSX
+.DS_Store
+Icon?
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pagerduty_tools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,160 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of such
+entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative
+Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated
+in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed by
+their Contribution(s) alone or by combination of their Contribution(s) with
+the Work to which such Contribution(s) was submitted. If You institute patent
+litigation against any entity (including a cross-claim or counterclaim in a
+lawsuit) alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent
+licenses granted to You under this License for that Work shall terminate as of
+the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of
+the following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License. You may add Your own copyright statement to Your
+modifications and may provide additional or different license terms and
+conditions for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in this
+License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the Work
+and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised of
+the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,165 @@
+# pagerduty-tools #
+
+Tools to work around limitations in the [PagerDuty](http://www.pagerduty.com)
+[API](http://www.pagerduty.com/docs/api/api-documentation). As an example use,
+here are two Campfire updates from these scripts that set the room topic to
+the current on-call rotation, and then report on the incidents and alerts from
+the previous rotation:
+
+![campfire example](https://github.com/precipice/pagerduty_tools/raw/master/images/campfire-example.png)
+
+## IMPORTANT: Status ##
+
+Several changes to PagerDuty's site have broken parts of these tools. I'm 
+currently working on repairing them and on making the tools into a gem. Status
+as of this writing is that the `bin/pagerduty_oncall.rb` script is working and
+the others are not.  The gem builds and installs.
+
+## Installing ##
+
+Ruby 1.8.7 or later is required.
+
+First, clone the GitHub repo:
+
+    $ git clone git://github.com/precipice/pagerduty-tools.git
+
+If you don't already have [Bundler](http://gembundler.com/) installed, do that
+now:
+
+    $ gem install bundler
+
+Then install required gems via Bundler:
+
+    $ bundle install
+
+The scripts log into the PagerDuty site when first run. Your email address
+will be used to find associated PagerDuty accounts, and you can choose the
+account you want to report on. After the first run, a login cookie is kept in
+`~/.pagerduty-cookies` to allow future runs to be automatic (e.g., from cron).
+
+## Campfire Support ##
+
+If you would like to have PagerDuty reports sent to your
+[Campfire](http://www.campfirenow.com) room, create a "PagerDuty" user in your
+Campfire account, and then add a configuration file at
+`~/.pagerduty-campfire.yaml` containing the following:
+
+    site:  https://example.campfirenow.com
+    room:  99999
+    token: abababababababababababababababababababab
+
+with the values changed to match your configuration. I'd recommend running:
+
+    $ chmod 0600 ~/.pagerduty-campfire.yaml
+
+after creating the file. See the documentation for each script for how to send
+output to Campfire.
+
+Tip: you can use [PagerDuty's Twitter icon](https://twitter.com/pagerduty) as
+a profile icon for your Campfire PagerDuty account. This isn't necessary, but
+it makes the PagerDuty message more recognizable and nicer.
+
+## Limitations ##
+
+* The rotation-report.rb script works well for weekly rotations with no
+  exceptions set. It might work well for daily rotations (comparing to the
+  same day one week ago), but hasn't been tested for that; and it fails
+  completely if any of the weeks compared have an exception set. If you set
+  an exception, you can work around this limitation using the `--start-time`
+  and `--end-time` options to explicitly set the report date range.
+* Login and other errors from PagerDuty's site are not parsed or reported.
+
+# oncall.rb #
+
+The `oncall.rb` script reports who is currently on call for your PagerDuty
+account. Invoked with no arguments, it will list all on-call levels (1..n). If
+one or more levels are given as arguments, it will only list those levels.
+
+If the on call level has an associated on-call rotation, the name of that
+rotation is used in the output. Otherwise, a generic `Level <#>` format is
+used.
+
+You can invoke oncall.rb with a `-t` or `--campfire-topic` option, and the
+output of the script will be set as the topic for the configured room (see
+__Campfire Support__, above). We do this out of cron right after the rotation
+turns over to a new assignment.
+
+oncall.rb defaults to showing the first escalation policy, but if you have
+multiple ones and want to show a specific one, you can invoke it with `-p` or
+`--policy` to specify which one to use.
+
+Calling the script with `-h` or `--help` will display some help.
+
+## Examples ##
+
+    $ ./oncall.rb
+    Hotseat: John Henry, Hotseat Backup: Lisa Limon, Level 3: Steven Sanders
+
+    $ ./oncall.rb 1 2
+    Hotseat: John Henry, Hotseat Backup: Lisa Limon
+
+    $ ./oncall.rb --campfire-topic 1 2
+    [No shell output, but the configured Campfire room's topic becomes:
+    "Hotseat: John Henry, Hotseat Backup: Lisa Limon"]
+
+# rotation-report.rb #
+
+The `rotation-report.rb` script generates an automatic "end of shift" report
+to show what happened over the course of a rotation. It measures how many
+incidents occurred, shows who resolved them, and shows how many alerts people
+got (including a breakout of after-midnight alerts, which we all must strive
+to eradicate!). Also, it lists the top five causes for alerts during the
+rotation, and compares the counts to the same period one week earlier.
+
+Here's an example:
+
+    Rotation report for February 23 - March 02:
+      19 incidents (-9% vs. last week)
+
+    Resolutions:
+      John Henry: 8, George Harrison: 4, Scott Brinkley: 4, Jason Neeson: 2, [Automatic]: 1
+
+    SMS/Phone Alerts (62 total, +77% vs. last week; 6 after midnight, -53% vs. last week):
+      John Henry: 44, George Harrison: 10, Jason Neeson: 4, Scott Brinkley: 4
+
+    Top triggers:
+      6 'Pingdom: DOWN alert: example-health (www.example.com) is DOWN' (-14% vs. last week)
+      5 'Pingdom: DOWN alert: sg-health (sg.example.com) is DOWN' (no occurrences last week)
+      4 'Nagios: vip-api - check_api_lag' (+300% vs. last week)
+      1 'Nagios: vip-redisapi - check_live_redis_lag' (-66% vs. last week)
+      1 'Pingdom: DOWN alert: client-nike (www.nike.com) is DOWN' (no occurrences last week)
+
+By default the script will report on the most recently-completed rotation.
+However, you can use the `-a`|`--rotations-ago COUNT` option to specify how
+far back in history you want to go. Or, you can use `-s`|`--start-time DATETIME`
+and `-e`|`--end-time DATETIME` (giving the date in
+[ISO 8601](http://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
+date and time format, e.g. "2011-03-02T14:00:00-05:00") to set a specific range
+for the report.
+
+Calling rotation-report.rb with a `-m`|`--campfire-message` argument will
+cause the rotation report to be pasted into the configured Campfire room. (See
+__Campfire Support__, above, for information about setting this up.)
+
+Calling the script with `-h` or `--help` will display some help.
+
+# alerts-by-day.rb #
+
+This script is being revised and doesn't work with the rest of the package yet.
+
+# Contributions #
+
+Pull requests welcome. There are no tests or specs yet, so hey, contributing
+couldn't be easier.
+
+Thanks to the following people for contributions!
+
+* [Jeffrey Wescott](https://github.com/binaryfeed)
+* [André Arko](https://github.com/indirect)
+* [Brian Donovan](https://github.com/eventualbuddha)
+* [Brad Greenlee](https://github.com/bgreenlee)
+
+# License #
+
+Copyright 2011 Marc Hedlund. Distributed under the Apache License, version 2.0.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/oncall-email.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+# Copyright 2011 Marc Hedlund <marc@precipice.org>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# oncall-email.rb -- Notify on-call people about shift start.
+#
+# Original script contributed by Jeffrey Wescott
+# (https://github.com/binaryfeed). Thanks!
+
+require 'rubygems'
+require 'bundler/setup'
+require 'net/smtp'
+
+require 'optparse'
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'pagerduty_tools'
+
+# Look for reporting options
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: oncall-email.rb\n" +
+                "Send an email reminder to the on-call person (and any relevant CCs)."
+
+  options[:smtp_server] = 'localhost'
+  opts.on( '-m', '--smtp-server HOSTNAME', 'Use HOSTNAME as the SMTP server.') do |host|
+    options[:smtp_server] = host
+  end
+
+  options[:subject] = '[PagerDuty] You are now on call'
+  opts.on( '-s', '--subject SUBJECT', 'Use SUBJECT as the subject line of the email.') do |subject|
+    options[:subject] = subject
+  end
+
+  options[:from_address] = 'nobody@example.com'
+  opts.on( '-f', '--from ADDRESS', 'Use ADDERSS as the "From:" line of the email.') do |from|
+    options[:from_address] = from
+  end
+
+  # REVIEW: Should this be an ARRAY option?
+  options[:ccs] = []
+  opts.on( '-c', '--cc EMAIL', 'Send a copy of the email to EMAIL.' ) do |cc|
+    options[:ccs] << cc
+  end
+
+  options[:message_file] = nil
+  opts.on( '-m', '--message-file FILENAME', 'Use contents of FILENAME as the email body.') do |filename|
+    options[:message_file] = filename
+  end
+
+  opts.on( '-p', '--policy POLICY', 'Set the Escalation Policy to display') do |policy|
+    options[:policy] = policy
+  end
+
+  opts.on( '-h', '--help', 'Display this message' ) do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
+# Default to sending mail to the first-level assignee only, or use levels
+# given as arguments.
+mail_to_levels = ARGV.count > 0 ? ARGV : "1"
+
+# Log into PagerDuty and get the Dashboard page.
+pagerduty  = PagerDuty::Agent.new
+escalation = PagerDuty::Escalation.new mail_to_levels, options[:policy]
+
+# REVIEW: don't we need one Person per level? What's this for?
+person     = PagerDuty::Person.new
+
+# Log into PagerDuty and get the on-call info block.
+oncall_info = pagerduty.fetch "/on_call_info"
+levels      = escalation.parse oncall_info.body
+
+
+# Get the email address for each on-call level.
+levels.each do |level|
+  user = pagerduty.fetch level['person_path']
+  person.parse user.body
+  level['email'] = person.email
+end
+
+# REVIEW: Is the 'recips' line needed? Can Net::SMTP pull addresses from the header?
+recips = options[:ccs] + (levels.map { |level| level['email'] })
+to_line = levels.map{|level| "#{level['person']} <#{level['email']}>" }.join(", ")
+cc_line = options[:ccs].join(", ")
+
+header = <<HEADER_END
+From: PagerDuty <#{options[:from_address]}>
+To: #{to_line}
+CC: #{cc_line}
+Subject: #{options[:subject]}
+
+HEADER_END
+
+# REVIEW: Hmm...wonder if the email should be different for each person, telling
+# them what level assignment they have now.
+
+# REVIEW: Should show the full assignment list as a table.
+
+body = <<BODY_END
+Your PagerDuty on-call rotation has started. If you receive alerts about new
+incidents, please acknowledge them as soon as possible if you can respond. If
+not, please escalate them to the next level so they can be handled quickly.
+For more information about an alert, please log into our PagerDuty account at:
+
+    https://#{pagerduty.domain}
+
+Thanks.
+BODY_END
+
+if options[:message_file] != nil
+  body = ""
+  File.open(options[:message_file], "r") do |file|
+    file.each_line do |line|
+      body += line
+    end
+  end
+end
+
+Net::SMTP.start(options[:smtp_server]) do |smtp|
+  smtp.send_message header + body, options[:from_address], recips
+end
+
+exit(0)