Open source @github's Hubot PagerDuty integration #858

jnewland · 2013-03-29T18:28:17Z

Usage

hubot pager help

  /who's on call              # return the username of who's on call

  /pager me page <msg>        # create a new incident

  /pager me 60                # take the pager for 60 minutes

  /pager me incidents         # return the current incidents
  /pager me problems          # return all open inicidents

  /pager me ack 24            # ack incident #24
  /pager me resolve 24        # resolve incident #24

Config

Some environment variables are required:

HUBOT_PAGERDUTY_USERNAME
HUBOT_PAGERDUTY_PASSWORD
HUBOT_PAGERDUTY_SUBDOMAIN
HUBOT_PAGERDUTY_APIKEY
HUBOT_PAGERDUTY_SCHEDULE_ID

Caveats

/pager me 60 assumes your Campfire and PagerDuty usernames are identical.

Easter Eggs

major can be substituted for pager in most places. Thank Siri for this one.

technicalpickles · 2013-03-29T19:09:08Z

I'm working on some style updates (ie documentation format) and generalizing... So, plz hold off merging quite yet :)

On Mar 29, 2013, at 2:28 PM, Jesse Newland [email protected] wrote:

Usage

hubot pager help

/who's on call # return the username of who's on call

/pager me page # create a new incident

/pager me 60 # take the pager for 60 minutes

/pager me incidents # return the current incidents
/pager me problems # return all open inicidents

/pager me ack 24 # ack incident #24
/pager me resolve 24 # resolve incident #24
Config

Some environment variables are required:

HUBOT_PAGERDUTY_USERNAME
HUBOT_PAGERDUTY_PASSWORD
HUBOT_PAGERDUTY_SUBDOMAIN
HUBOT_PAGERDUTY_APIKEY
HUBOT_PAGERDUTY_SCHEDULE_ID
Caveats

/pager me 60 assumes your Campfire and PagerDuty usernames are identical.

Easter Eggs

major can be substituted for pager in most places. Thank Siri for this one.

You can merge this Pull Request by running

git pull https://github.com/jnewland/hubot-scripts pagerduty
Or view, comment on, or merge it at:

#858

Commit Summary

open source @github's hubot pagerduty script
File Changes

A src/scripts/pagerduty.coffee (235)
Patch Links:

https://github.com/github/hubot-scripts/pull/858.patch
https://github.com/github/hubot-scripts/pull/858.diff

jnewland · 2013-03-29T19:09:40Z

Thanks @technicalpickles 👍

…r me

technicalpickles · 2013-03-30T17:06:08Z

So far, I was able to:

document the commands and environment variables
add error checking for environment variables missing
cleanup formatting of incidents (ie underline 'acknowledged' and 'triggered', since it confused me the first time when there were triggered or acknowledged, but not both)

The last thing I'd like to see in this is getting rid of the caveat that pagerduty & chat user name has to match. Thereotically, a msg has a user object, but the metadata of that will depend on the adapter. campfire (might) have an email, which could be looked up against the pagerduty API, but that changes the assumption to the pagerduty & campfire email are the same. The Shell does not have that though, but maybe could be fixed to.

Another thought is to have a pager me command to tell the bot your pagerduty id. that'd help a little, but it'd make it more manual for new team members.

martinisoft · 2013-03-30T21:01:59Z

@technicalpickles I'm in favor of introducing yourself to hubot for the pagerduty id. It's similar to telling hubot your github name for the Play integration.

technicalpickles · 2013-04-01T14:25:31Z

@martinisoft yeah, I think that'll be needed. I would still like to see if we can correctly guess based on a user's name/email what their pagerduty thing is

tombell · 2013-04-04T20:48:43Z

What's the status on this, good to merge?

technicalpickles · 2013-04-04T20:59:28Z

Not yet, still needs those changes I was talking about to either tell hubot your pagerduty user info, or correctly guess it based on campfire's user.

Sent from my iPhone

On Apr 4, 2013, at 4:48 PM, Tom Bell [email protected] wrote:

What's the status on this, good to merge?

—
Reply to this email directly or view it on GitHub.

tombell · 2013-04-05T10:18:49Z

I modified hubot to allow adapters to pass more details along with the message, so if that isn't there it should be easy to add without breaking all the things.

joemiller · 2013-04-06T22:59:40Z

Would love to use this with an irc-based hubot so I'm waiting to see what comes of the "register yourself to hubot so he knows your PD email". Anxiously awaiting final commits. Also available to help if needed.

tombell · 2013-04-06T23:07:27Z

I think the best way is attempt to identity you by campfire email else fallback to some manual identification. This means it won't be entirely tied to the campfire adapter.

joemiller · 2013-04-06T23:10:29Z

For irc (or other systems without a good 1:1 email mapping) I was thinking something like registering your PD email and then save it in the redis brain. I suppose it wouldn't be too hard to include email upon invocation too, something like: "/msg hubot me [email protected] 60" .. ?

technicalpickles · 2013-04-10T23:11:58Z

@jnewland was doing more work on this, and got an error like:

TypeError: Object Wed Apr 10 2013 19:07:24 GMT-0400 (EDT) has no method 'addHours'
  at withCurrentOncall (/Users/technicalpickles/src/hubot/hubot-scripts/src/scripts/pagerduty.coffee:225:19)

Code is:

  oneHour = now.addHours(1).toISOString()

Googling points at datejs. Does that sound right? Need to get that documented. I'm also considering using momentjs instead.

jnewland · 2013-04-10T23:37:56Z

Yeah, likely. Would like to avoid any external deps if possible. I'll see what I can do here.

On Apr 10, 2013, at 7:12 PM, Josh Nichols [email protected] wrote:

@jnewland was doing more work on this, and got an error like:

TypeError: Object Wed Apr 10 2013 19:07:24 GMT-0400 (EDT) has no method 'addHours'
at withCurrentOncall (/Users/technicalpickles/src/hubot/hubot-scripts/src/scripts/pagerduty.coffee:225:19)
Code is:

oneHour = now.addHours(1).toISOString()
Googling points at datejs. Does that sound right? Need to get that documented. I'm also considering using momentjs instead.

—
Reply to this email directly or view it on GitHub.

technicalpickles · 2013-04-10T23:44:25Z

I think I like the idea of moment, rather than datejs, because it doesn't modify the Date prototype. Actually have a version working with moment already.

On Apr 10, 2013, at 7:37 PM, Jesse Newland [email protected] wrote:

Yeah, likely. Would like to avoid any external deps if possible. I'll see what I can do here.

On Apr 10, 2013, at 7:12 PM, Josh Nichols [email protected] wrote:

@jnewland was doing more work on this, and got an error like:

TypeError: Object Wed Apr 10 2013 19:07:24 GMT-0400 (EDT) has no method 'addHours'
at withCurrentOncall (/Users/technicalpickles/src/hubot/hubot-scripts/src/scripts/pagerduty.coffee:225:19)
Code is:

oneHour = now.addHours(1).toISOString()
Googling points at datejs. Does that sound right? Need to get that documented. I'm also considering using momentjs instead.

—
Reply to this email directly or view it on GitHub.
—
Reply to this email directly or view it on GitHub.

jnewland · 2013-04-10T23:45:57Z

Sounds legit.

On Apr 10, 2013, at 7:44 PM, Josh Nichols [email protected] wrote:

I think I like the idea of moment, rather than datejs, because it doesn't modify the Date prototype. Actually have a version working with moment already.

On Apr 10, 2013, at 7:37 PM, Jesse Newland [email protected] wrote:

Yeah, likely. Would like to avoid any external deps if possible. I'll see what I can do here.

On Apr 10, 2013, at 7:12 PM, Josh Nichols [email protected] wrote:

@jnewland was doing more work on this, and got an error like:

TypeError: Object Wed Apr 10 2013 19:07:24 GMT-0400 (EDT) has no method 'addHours'
at withCurrentOncall (/Users/technicalpickles/src/hubot/hubot-scripts/src/scripts/pagerduty.coffee:225:19)
Code is:

oneHour = now.addHours(1).toISOString()
Googling points at datejs. Does that sound right? Need to get that documented. I'm also considering using momentjs instead.

—
Reply to this email directly or view it on GitHub.
—
Reply to this email directly or view it on GitHub.

—
Reply to this email directly or view it on GitHub.

technicalpickles · 2013-04-10T23:51:56Z

Yep yep.

Right now, working on going from a message to the pagerduty user, without assuming that usernames are identical. Emails is probably a safer assumption. For campfire, there's like msg.message.user.email_address, so we can use that. It's not always going to be the same, especially with 37signal logins, so will still want the ability to override.

To be continue?

On Apr 10, 2013, at 7:45 PM, Jesse Newland [email protected] wrote:

Sounds legit.

On Apr 10, 2013, at 7:44 PM, Josh Nichols [email protected] wrote:

I think I like the idea of moment, rather than datejs, because it doesn't modify the Date prototype. Actually have a version working with moment already.

On Apr 10, 2013, at 7:37 PM, Jesse Newland [email protected] wrote:

Yeah, likely. Would like to avoid any external deps if possible. I'll see what I can do here.

On Apr 10, 2013, at 7:12 PM, Josh Nichols [email protected] wrote:

@jnewland was doing more work on this, and got an error like:

TypeError: Object Wed Apr 10 2013 19:07:24 GMT-0400 (EDT) has no method 'addHours'
at withCurrentOncall (/Users/technicalpickles/src/hubot/hubot-scripts/src/scripts/pagerduty.coffee:225:19)
Code is:

oneHour = now.addHours(1).toISOString()
Googling points at datejs. Does that sound right? Need to get that documented. I'm also considering using momentjs instead.

—
Reply to this email directly or view it on GitHub.
—
Reply to this email directly or view it on GitHub.

—
Reply to this email directly or view it on GitHub.
—
Reply to this email directly or view it on GitHub.

technicalpickles · 2013-04-10T23:58:25Z

@martinisoft I just looked over play.coffee, and don't see anywhere where you introduce yourself to play, or at least it's not using the brain.

Checking for other scripts that do something similar.

martinisoft · 2013-04-11T00:22:50Z

@technicalpickles its part of the setup, if you look in this area of play.coffee you'll see the reference to githubLogin. Which comes from github-credentials.coffee

technicalpickles · 2013-04-11T00:34:04Z

@martinisoft actually found github-credentials with some clever grepping. Should have something soon...

* use moment instead of datejs for time manipulation (ie adding hours/minutes) * for `pager me N`, try to use the person who's said it email, instead of their name to find a PagerDuty user * add command to remember your PagerDuty email address * use moment's .calendar() to display nicer time when coverage is * `pager me` will also say what it thinks your PagerDuty email address is

technicalpickles · 2013-04-11T00:52:20Z

Changes pushed, for anyone wanting to try them!

Only things I can think of to consider fixing/updating:

moment('something').calendar() doesn't include timezones, which can be confusing for a distributed team
process.env.HUBOT_PAGERDUTY_SCHEDULE_ID needs to be checked if it's defined, because API calls will fail without it

technicalpickles · 2013-04-11T03:42:40Z

I renamed pager me page to pager me trigger because I thought it was a little less confusing, and also matches the PagerDuty language. And I fixed the error checking of HUBOT_PAGERDUTY_SCHEDULE_ID.

The only question is that moment('something').calendar(). It returns like:

Rejoice, Blackhole! Josh Nichols has the pager from Today at 11:41 PM until Today at 11:42 PM

No timezones. I'm guessing it's the TZ of where hubot is running.

tombell · 2013-04-11T07:58:06Z

Welcome to dates in JS :P, you can UTC it like moment(blah).utc().calendar().

technicalpickles · 2013-04-11T12:28:37Z

It's more a display problem. The timezone we get back is in the right timezone, but calendar() doesn't show it.

On Apr 11, 2013, at 3:58 AM, Tom Bell [email protected] wrote:

Welcome to dates in JS :P, you can UTC it like moment(blah).utc().calendar().

—
Reply to this email directly or view it on GitHub.

tombell · 2013-04-11T12:36:41Z

Use .format() instead of .calendar()

…ar, since timezones are hard

technicalpickles · 2013-04-12T01:08:24Z

I had contacted pagerduty about adding support for creating notes at some point, and they recently added it, so added support for that here: hubot pager note 123345 wow this is such a note.

I also changed the hubot pager me 1 to use format instead of calendar. Moment used to have support for nice conversions to like EST and whanot, but it's been deprecated moment/moment#162 . For simplicity, leaving it with the default format.

At this point, I think it's 'ready', but like to have some other folks test it on in their hubots first. Particularly @jnewland, so he can use this script directly via hubot-scripts when it's merged.

This let's us use request_id in places, so when you look at PagerDuty, it reports which user ack/resolved, instead of the logged in user. As part of this, needed to rename HUBOT_PAGERDUTY_APIKEY to HUBOT_PAGERDUTY_SERVICE_API_KEY.

technicalpickles · 2013-04-12T02:52:50Z

Annnnd, one last change hopefully. I switched to using token authentication. This let's us use requester_id in some places, which means that when you look at incidents on the website, it shows ack/resolve/notes as being from the person who said it in chat, rather than the API user.

jnewland · 2013-04-12T12:17:58Z

I'll test that out today.

ches · 2013-04-12T15:16:00Z

Man this is badass.

jnewland · 2013-04-12T17:30:30Z

This has been out for a few hours and gotten good use in the GitHub Ops room. 👍 from me. Thanks for the cleanup @technicalpickles!

tombell · 2013-04-12T21:57:49Z

:squirrel:

Open source @github's Hubot PagerDuty integration

technicalpickles · 2013-04-12T22:02:29Z

🚨 👑 💥 ✨

technicalpickles · 2013-04-12T22:07:35Z

Released hubot-scripts 2.4.3 with this included.

open source @github's hubot pagerduty script

c3256ed

technicalpickles added 3 commits March 29, 2013 15:57

Update with documentation status, and use robot.helpCommands for page…

a4d41d0

…r me

Adjust format of incidents

f1613a9

Sanity check environment variables

257c8fa

jnewland mentioned this pull request Mar 30, 2013

Filter GH's coffee script hubot bits monitorama/hackathon#55

Closed

technicalpickles added 2 commits April 10, 2013 20:45

Move process.env.HUBOT_PAGERDUTY_SCHEDULE_ID to a variable

a810a31

technicalpickles added 3 commits April 10, 2013 22:40

Better doc for triggering a page

4084e5a

Check for pagerduty schedule id

c3db4fb

Remove unused variable

722daf6

Rename page to trigger, to reflect pagerduty language.

6056ac5

technicalpickles added 3 commits April 11, 2013 20:54

Add support for notes

790808c

Only display until time since start time is now. And don't use calend…

0aec8cc

…ar, since timezones are hard

Update msg.sends to use robot.name instead of hardcoded hubot

f09741a

Replace username/password auth with token auth.

655272f

This let's us use request_id in places, so when you look at PagerDuty, it reports which user ack/resolved, instead of the logged in user. As part of this, needed to rename HUBOT_PAGERDUTY_APIKEY to HUBOT_PAGERDUTY_SERVICE_API_KEY.

technicalpickles added 2 commits April 12, 2013 11:33

Add back 'pager page' as an alternate to 'pager trigger'

0e94503

Add 'pager notes <incident>'

e13a6b9

Fix pager notes doc

de86f58

technicalpickles added a commit that referenced this pull request Apr 12, 2013

Merge pull request #858 from jnewland/pagerduty

387413c

Open source @github's Hubot PagerDuty integration

technicalpickles merged commit 387413c into github:master Apr 12, 2013

technicalpickles deleted the pagerduty branch July 9, 2013 18:32

patcon mentioned this pull request Feb 25, 2014

Set up pagerduty for alerting and accountability gratipay/gratipay.com#2072

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open source @github's Hubot PagerDuty integration #858

Open source @github's Hubot PagerDuty integration #858

jnewland commented Mar 29, 2013

technicalpickles commented Mar 29, 2013

jnewland commented Mar 29, 2013

technicalpickles commented Mar 30, 2013

martinisoft commented Mar 30, 2013

technicalpickles commented Apr 1, 2013

tombell commented Apr 4, 2013

technicalpickles commented Apr 4, 2013

tombell commented Apr 5, 2013

joemiller commented Apr 6, 2013

tombell commented Apr 6, 2013

joemiller commented Apr 6, 2013

technicalpickles commented Apr 10, 2013

jnewland commented Apr 10, 2013

technicalpickles commented Apr 10, 2013

jnewland commented Apr 10, 2013

technicalpickles commented Apr 10, 2013

technicalpickles commented Apr 10, 2013

martinisoft commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

tombell commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

tombell commented Apr 11, 2013

technicalpickles commented Apr 12, 2013

technicalpickles commented Apr 12, 2013

jnewland commented Apr 12, 2013

ches commented Apr 12, 2013

jnewland commented Apr 12, 2013

tombell commented Apr 12, 2013

technicalpickles commented Apr 12, 2013

technicalpickles commented Apr 12, 2013

Open source @github's Hubot PagerDuty integration #858

Open source @github's Hubot PagerDuty integration #858

Conversation

jnewland commented Mar 29, 2013

Usage

Config

Caveats

Easter Eggs

technicalpickles commented Mar 29, 2013

jnewland commented Mar 29, 2013

technicalpickles commented Mar 30, 2013

martinisoft commented Mar 30, 2013

technicalpickles commented Apr 1, 2013

tombell commented Apr 4, 2013

technicalpickles commented Apr 4, 2013

tombell commented Apr 5, 2013

joemiller commented Apr 6, 2013

tombell commented Apr 6, 2013

joemiller commented Apr 6, 2013

technicalpickles commented Apr 10, 2013

jnewland commented Apr 10, 2013

technicalpickles commented Apr 10, 2013

jnewland commented Apr 10, 2013

technicalpickles commented Apr 10, 2013

technicalpickles commented Apr 10, 2013

martinisoft commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

tombell commented Apr 11, 2013

technicalpickles commented Apr 11, 2013

tombell commented Apr 11, 2013

technicalpickles commented Apr 12, 2013

technicalpickles commented Apr 12, 2013

jnewland commented Apr 12, 2013

ches commented Apr 12, 2013

jnewland commented Apr 12, 2013

tombell commented Apr 12, 2013

technicalpickles commented Apr 12, 2013

technicalpickles commented Apr 12, 2013