🍪 We use cookies to provide necessary functionality and an improved experience. Read our Cookie Policy.

pager 2.0.3

by Serious Business

Interact with PagerDuty services, schedules, and incidents with Abbot.

The pager skill is inspired by the Hubot Pager skill. Use it to trigger incidents assigned to specific users, the current on-call user, etc.

Configuration

This skill requires the following secrets to be configured:

pagerduty-api-key - The PagerDuty API Key for your PagerDuty account.

To create an API Key, log into your PagerDuty account, select Integrations and then Api Access Keys under the Developer Tools column heading.

For more information about PagerDuty API Keys, see the PagerDuty docs for generating an API Key to learn how to do this.

Mapping your user to PagerDuty

The pager skill will attempt to map your chat user to a PagerDuty user via email. To see if Abbot already knows your email (obtained from your chat platform), @abbot my email. To set your global Abbot email, @abbot my email is {email}. To set an email address just for the pager skill, @abbot pager me as {email}.

Examples

With that mapping in place, a chat user can be paged like so:

@paul> @abbot pager trigger @haacked hey, the site is down
@abbot> :pager: triggered! Incident #8 assigned to @haacked

Or trigger an incident assigned to an escalation policy:

@haacked> @abbot pager trigger ops hey, the site is down
@abbot> :pager: triggered! Incident #8 assigned to ops!

Check on open incidents:

@haacked> @abbot pager sup
@abbot> Triggered:
----------
8: 2014-11-05T20:17:50Z site is down - assigned to haacked
Acknowledged:
-------------
7: 2014-11-05T20:16:29Z omgwtfbbq - assigned to haacked

Acknowledge triggered incidents assigned to you:

@haacked> @abbot pager ack
@abbot> Incident 7,8 acknowledged

Or acknowledge specific incidents:

@haacked> @abbot pager ack 8
@abbot> Incident 8 acknowledged

Resolve acknowledged alerts assigned to you:

@haacked> @abbot pager resolve
@abbot> Incident 7,8 resorved

Feedback

If you have feedback on this skill, submit an issue here or, better yet, a pull request to this file!

Configuration
@abbot pager me as {email} - to set your PagerDuty email if it's different from your chat email. Note that @abbot my email is {email} sets your chat email if it's currently unknown.
@abbot pager bot is {email} - to set the email address for your PagerDuty bot account.
@abbot pager subdomain is {subdomain} - to set your PagerDuty's account subdomain. Only specify the subdomain part of the URL.
@abbot pager service is {service-id} - If your PagerDuty account has more than one service, you can specify which service to use for incidents for the current room. If your PagerDuty account has one service, this isn't needed.

Usage
@abbot pager acknowledge - Acknowledge triggered alerts assigned to you. Alternative usage: @abbot pager ack
@abbot pager acknowledge! - Acknowledge all triggered not just yours. Alternative usage: @abbot pager ack!
@abbot pager acknowledge {incident1-number} {incident2-number} ... {incidentN-number} - Acknowledge all specified incidents.
@abbot pager trigger @{user} {message} - Triggers the pager and assigns it to the specified user. Alternative usage @abbot pager page @{user} {message}.
Example: @abbot pager trigger @paul did you drop the database again?
@abbot pager trigger {policy} {message} - Trigger an incident assigned to an escalation policy. Alternative usage: @abbot pager page {policy} {message}
Example: @abbot pager trigger ops the site is down.
@abbot pager incidents - List open incidents and their status. Alternative usage: @abbot pager sup
@abbot pager note {incident-number} {content} - Adds a note to the specified incident.
@abbot pager notes {incident-number} - Shows notes for the specified incident.
@abbot pager resolve - Resolve acknowledged incidents assigned to you. Alternative usage: @abbot pager res
@abbot pager resolve! - Resolve all acknowledged incidents, not just yours. Alternative usage: @abbot pager res!
@abbot pager resolve {incident1-number} {incident2-number} ... {incidentN-number} - Resolve all specified incidents.
@abbot pager schedules - Check up coming schedule, and schedule shift overrides on it.
@abbot pager services - Lists the set of services associated with your PagerDuty account.

/*
PagerDuty Skill for triggering pager duty incidents and responding to them.

USAGE:
*Configuration*
`@abbot pager me as {email}` - to set your PagerDuty email if it's different from your chat email. Note that `@abbot my email is {email}` sets your chat email if it's currently unknown.
`@abbot pager bot is {email}` - to set the email address for your PagerDuty bot account.
`@abbot pager subdomain is {subdomain}` - to set your PagerDuty's account subdomain. Only specify the subdomain part of the URL.
`@abbot pager service is {service-id}` - If your PagerDuty account has more than one service, you can specify which service to use for incidents for the current room. If your PagerDuty account has one service, this isn't needed.

*Usage*
`@abbot pager acknowledge` - Acknowledge triggered alerts assigned to you. Alternative usage: `@abbot pager ack`
`@abbot pager acknowledge!` - Acknowledge all triggered not just yours. Alternative usage: `@abbot pager ack!`
`@abbot pager acknowledge {incident1-number} {incident2-number} ... {incidentN-number}` - Acknowledge all specified incidents.
`@abbot pager trigger @{user} {message}` - Triggers the pager and assigns it to the specified user. Alternative usage `@abbot pager page @{user} {message}`.
Example: `@abbot pager trigger @paul did you drop the database again?`
`@abbot pager trigger {policy} {message}` - Trigger an incident assigned to an escalation policy. Alternative usage: `@abbot pager page {policy} {message}`
Example: `@abbot pager trigger ops the site is down`.
`@abbot pager incidents` - List open incidents and their status. Alternative usage: `@abbot pager sup`
`@abbot pager note {incident-number} {content}` - Adds a note to the specified incident.
`@abbot pager notes {incident-number}` - Shows notes for the specified incident.
`@abbot pager resolve` - Resolve acknowledged incidents assigned to you. Alternative usage: `@abbot pager res`
`@abbot pager resolve!` - Resolve all acknowledged incidents, not just yours. Alternative usage: `@abbot pager res!`
`@abbot pager resolve {incident1-number} {incident2-number} ... {incidentN-number}` - Resolve all specified incidents.
`@abbot pager schedules` - Check up coming schedule, and schedule shift overrides on it.
`@abbot pager services` - Lists the set of services associated with your PagerDuty account.
*/

var restApiKey = await Bot.Secrets.GetAsync("pagerduty-api-key");
if (restApiKey is not {Length: > 0}) {
    await Bot.ReplyAsync("Please set your PagerDuty Rest API key in a secret named `pagerduty-api-key`.\nSee https://support.pagerduty.com/docs/generating-api-keys#section-generating-an-api-key for more information about this API key.");
    return;
}

Task task = Bot.Arguments switch {
    ({Value: "ack!"} or {Value: "acknowledge!"}, IMissingArgument, _) => UpdateAllIncidentsAsync(IncidentStatus.Acknowledged),
    ({Value: "ack"} or {Value: "acknowledge"}, IMissingArgument, _) => UpdateAssignedIncidentsAsync(IncidentStatus.Acknowledged),
    ({Value: "ack"} or {Value: "acknowledge"}, _, _) => UpdateIncidentsAsync(Bot.Arguments.Skip(1), IncidentStatus.Acknowledged), // Skip the "ack" arg and pass the rest.
    ({Value: "res!"} or {Value: "resolve!"}, IMissingArgument, _) => UpdateAllIncidentsAsync(IncidentStatus.Resolved),
    ({Value: "res"} or {Value: "resolve"}, IMissingArgument, _) => UpdateAssignedIncidentsAsync(IncidentStatus.Resolved),
    ({Value: "res"} or {Value: "resolve"}, _, _) => UpdateIncidentsAsync(Bot.Arguments.Skip(1), IncidentStatus.Resolved), // Skip the "res" arg and pass the rest.
    ({Value: "am"}, {Value: "I"} or {Value: "i"}, {Value: "on call"} or {Value: "on call?"}) => AmIOnCallAsync(),
    ({Value: "forget"}, {Value: "me"}, IMissingArgument) => ForgetPagerDutyEmail(),
    ({Value: "incident"}, IArgument id, _) => ReplyWithIncidentAsync(id),
    (IMissingArgument, _, _) or ({Value: "me"}, IMissingArgument, _) => ReplyWithPagerUserInfo(Bot.From),
    ({Value: "bot"}, IMissingArgument _) => ReportBotUserEmailAsync(),
    ({Value: "bot"}, {Value: "is"}, var emailArg) => SetPagerDutyBotEmailAsync(emailArg),
    ({Value: "me"}, {Value: "as"}, var emailArg) => SetPagerDutyEmail(emailArg),
    ({Value: "note"}, var id, var content) => AddNoteAndReplyAsync(id, content),
    ({Value: "notes"}, IArgument id, _) => ReplyWithIncidentNotesAsync(id),
    ({Value: "schedules"}, var search) => ListSchedulesAsync(search),
    ({Value: "service"}, {Value: "is"}, var serviceId) => SetServiceIdAsync(serviceId),
    ({Value: "service"}, var serviceId) => SetServiceIdAsync(serviceId),
    ({Value: "services"}, IMissingArgument, IMissingArgument) => ListServicesAsync(),
    ({Value: "subdomain"}, {Value: "is"}, var subdomain) => SetSubdomainAsync(subdomain),
    ({Value: "subdomain"}, var subdomain) => SetSubdomainAsync(subdomain),
    ({Value: "sup"}, _, _) or ({Value: "inc"}, _, _) or ({Value: "incidents"}, _, _) or ({Value: "problems"}, _, _) => ReplyWithIncidentsAsync(),
    ({Value: "trigger"} or {Value: "page"}, _, _) => TriggerPagerDutyAsync(Bot.Arguments.Skip(1)), // Skip the "trigger" arg and pass the rest.
    ({Value: "who's"}, {Value: "on"}, {Value: "call"} or {Value: "call?"}, _) => HandleWhoIsOnCallAsync(Bot.Arguments.Skip(3)),
    ({Value: "who"}, {Value: "is"}, {Value: "on"}, {Value: "call"} or {Value: "call?"}, _)  => HandleWhoIsOnCallAsync(Bot.Arguments.Skip(4)),
    _ => ReplyWithHelpAsync()
};

await task;

// Perform the actual pagerduty actions
async Task TriggerPagerDutyAsync(IArguments args) {
    Task action = args switch {
        (IMentionArgument mention, var msg) => PageUserAsync(mention.Mentioned, msg.Value),
        (IArgument target, var msg) => PageTargetAsync(target.Value, msg.Value),
        _ => ReplyWithHelpAsync()
    };

    await action;
}

async Task PageUserAsync(IChatUser chatUser, string message) {
    var pagerUser = await GetPagerDutyUser(chatUser);
    if (pagerUser?.User is null) {
        return;
    }
    var serviceId = await EnsureServiceIdAsync();
    if (serviceId is null) {
        return;
    }
    
    var response = await CreateIncidentAsync(serviceId, message, pagerUser);
    var incident = response?.incident;
    if (incident is null) {
        await Bot.ReplyAsync("Something went wrong trying to create the incident.");
        return;
    }
    await Bot.ReplyAsync($":pager: triggered! Incident #{incident.incident_number} assigned to {chatUser}");
}

async Task PageTargetAsync(string target, string message) {
    var serviceId = await EnsureServiceIdAsync();
    if (serviceId is null) {
        return;
    }
    var policy = await GetEscalationPolicyAsync(target);
    if (policy is not null) {
        var policyIncident = await CreateIncidentAsync(serviceId, message, escalationPolicy: policy);
        if (policyIncident is null) {
            await Bot.ReplyAsync("Something went wrong trying to create the incident.");
            return;
        }
        await Bot.ReplyAsync($":pager: triggered! Incident #{policyIncident.incident_number} assigned to escalation policy sche`{target}`");
        return;
    }
    var schedules = await GetSchedules(target);
    if (schedules is {Count: > 0}) {
        var schedule = schedules.First();
        var oncall = await GetCurrentOnCallUser(schedule.id);
        if (oncall is null) {
            await Bot.ReplyAsync($"I do not know the on call user for the schedule `{target}`");
            return;
        }
        var incident = await CreateIncidentAsync(serviceId, message, oncall);
        if (incident is null) {
            await Bot.ReplyAsync("Something went wrong trying to create the incident.");
            return;
        }
        await Bot.ReplyAsync($":pager: triggered! Incident #{incident.incident_number} assigned to {oncall.name}, the on call user for the schedule `{target}`");
        return;
    }
}

async Task UpdateAllIncidentsAsync(IncidentStatus updatedStatus) {
    var pagerDutyUser = await GetPagerDutyUser(Bot.From);
    if (pagerDutyUser?.PagerDutyEmail is null) {
        return;
    }
    
    var assigned = await GetIncidentsAsync(IncidentStatus.Triggered, updatedStatus);
    if (assigned is {Count: 0}) {
        await Bot.ReplyAsync("No incidents to acknowledge.");
        return;
    }
    
    await UpdateIncidentsAsync(assigned, IncidentStatus.Acknowledged, pagerDutyUser);
}

async Task UpdateAssignedIncidentsAsync(IncidentStatus updatedStatus) {
    var pagerDutyUser = await GetPagerDutyUser(Bot.From);
    if (pagerDutyUser?.PagerDutyEmail is null) {
        return;
    }
    
    var assigned = await GetAssignedIncidentsAsync(pagerDutyUser);
    if (assigned is {Count: 0}) {
        await Bot.ReplyAsync("No incidents assigned to you.");
        return;
    }
    
    await UpdateIncidentsAsync(assigned, updatedStatus, pagerDutyUser);
}

async Task UpdateIncidentsAsync(IArguments arguments, IncidentStatus status) {
    var incidentNumbers = arguments.Select(arg => arg.ToInt32()).ToList();
    if (incidentNumbers.Any(n => n is null)) {
        await Bot.ReplyAsync("Some of those incident numbers don't seem to be incident numbers");
        return;
    }
    
    // The reason "Acknowledged" are included in the status filter is to allow a different user 
    // to take ownership of an acknowledged incident by using the "ack" sub-command.
    await UpdateIncidentsByNumbersAsync(incidentNumbers.Select(num => num.Value), new[] {IncidentStatus.Triggered, IncidentStatus.Acknowledged }, status);
}

// Update the specified incidents
async Task UpdateIncidentsByNumbersAsync(IEnumerable<int> incidentNumbers, IEnumerable<IncidentStatus> statuses, IncidentStatus updatedStatus) {
    var pagerDutyUser = await GetPagerDutyUser(Bot.From);
    if (pagerDutyUser?.User is null) {
        return;
    }
    var ids = incidentNumbers.ToList();
    var incidents = await GetIncidentsAsync(statuses.ToArray());
    var foundIncidents = incidents.Where(i => ids.Contains((int)i.incident_number)).ToList();
    var incidentNumbersText = string.Join(", ", incidentNumbers);
    if (foundIncidents is {Count: 0}) {
        await Bot.ReplyAsync($"Couldn't find incident(s) {incidentNumbersText}. Use `{Bot} pager incidents` for listing.");
        return;
    }
    
    await UpdateIncidentsAsync(foundIncidents, updatedStatus, pagerDutyUser);
}

async Task UpdateIncidentsAsync(IEnumerable<dynamic> incidents, IncidentStatus updatedStatus, PagerDutyUser pagerDutyUser) {
    var data = new {
        incidents = incidents.Select(i => new {
            i.id,
            type = "incident_reference",
            status = updatedStatus.ToString().ToLowerInvariant()
        })
    };
    var incidentNumbers = string.Join(", ", incidents.Select(i => i.incident_number));
    var response = await CallPagerDutyApiAsync("/incidents", HttpMethod.Put, pagerDutyUser, data);
    List<dynamic> updatedIncidents = response?.incidents?.ToObject<List<dynamic>>();
    if (updatedIncidents is null) {
        await Bot.ReplyAsync($"Problem updating incidents {incidentNumbers}");
        return;
    }
    
    var updatedIncidentNumbers = string.Join(", ", updatedIncidents.Select(i => i.incident_number));
    var pluralSuffix = updatedIncidents.Count > 1 ? "s" : string.Empty;
    await Bot.ReplyAsync($"Incident{pluralSuffix} {updatedIncidentNumbers} {updatedStatus.ToString().ToLowerInvariant()}");
}

Task HandleWhoIsOnCallAsync(IArguments arguments) {
    return arguments switch {
        ({Value: "for"}, var scheduleArg) => WhoIsOnCallAsync(scheduleArg.Value),
        (IMissingArgument, _) => WhoIsOnCallAsync(null),
        _ => ReplyWithHelpAsync()
    };
}

async Task<dynamic> GetCurrentOnCallUser(dynamic scheduleId) {
    var now = DateTimeOffset.UtcNow;
    var oneHour = now.AddHours(1);
    var endpoint = $"/schedules/{scheduleId}/users?since={now:o}&until={oneHour:o}";
    try {
        var response = await CallPagerDutyApiAsync(endpoint);
        if (response?.users?.Count > 0) {
            return response.users[0];
        }
    }
    catch (HttpRequestException e) {
        await Bot.ReplyAsync($"Error requesting {endpoint}\n" + e.Message);
    }
    
    return null;
}

async Task WhoIsOnCallAsync(string scheduleName) {
    var schedules = await GetSchedules(scheduleName);
    if (schedules.Count is 0) {
        var message = scheduleName is {Length: > 0}
            ? $"I could not find a schedule named `{scheduleName}`"
            : "No schedules found!";
        await Bot.ReplyAsync(message);
        return;
    }
    var messages = new List<string>();
    foreach (var schedule in schedules) {
        var user = await GetCurrentOnCallUser(schedule.id);
        if (user is not null) {
            messages.Add($"{user.name} is on call for {schedule.name} - {schedule.html_url}");
        }
    }

    if (messages.Count is 0) {
        await Bot.ReplyAsync("No users are on call!");
        return;
    }
    await Bot.ReplyAsync(messages.ToMarkdownList());
}

async Task AmIOnCallAsync() {
    var user = await GetPagerDutyUser(Bot.From);
    var userId = user.User?.id;
    
    if (userId is null) {
        await Bot.ReplyAsync($"Couldn't figure out the PagerDuty user connected to your account. `{Bot} {Bot.SkillName} me as youremail@yourdomain.com` to set your PagerDuty email.");
        return;
    }
    var schedules = await GetSchedules();
    if (schedules.Count is 0) {
        await Bot.ReplyAsync("No schedules found!");
        return;
    }
    
    var responses = new List<string>();
    foreach (var schedule in schedules) {
        string scheduleId = schedule.id;
        var oncallUser = await GetCurrentOnCallUser(scheduleId);
        if (userId == oncallUser?.id) {
            responses.Add($"Yes, you are on call for {schedule.name} - {schedule.html_url}");
        }
        else if (oncallUser?.name is null) {
            responses.Add($"No, you are NOT on call for {schedule.name} - {schedule.html_url}");
        }
        else {
            responses.Add($"No, you are NOT on call for {schedule.name} (but {oncallUser.name} is) - {schedule.html_url}");
        }
    }
    await Bot.ReplyAsync(responses.ToMarkdownList());
}

async Task ReportBotUserEmailAsync() {
    var botUserEmail = await GetDefaultUserEmail();
    if (botUserEmail is not {Length: > 0}) {
        await Bot.ReplyAsync("Please specify the email address for the PagerDuty bot user. For example, `{Bot} {Bot.SkillName} bot is {{email}}`.");
        return;
    }
    await Bot.ReplyAsync($"`{botUserEmail}`");
    return;
}

async Task SetPagerDutyBotEmailAsync(IArgument emailArg) {
    var botEmail = emailArg.Value;
    if (!botEmail.Contains('@')) {
        await Bot.ReplyAsync("Please specify a valid email address for the PagerDuty bot user. For example, `{Bot} {Bot.SkillName} bot is {{email}}`.");
        return;
    }
    await WriteDefaultUserEmail(botEmail);
    await Bot.ReplyAsync($"Great! I've set the default PagerDuty bot email to `{botEmail}`.");
}

async Task ReplyWithHelpAsync() {
    var botUserEmail = await EnsureBotUserEmailSetAsync();
    if (botUserEmail is null) {
        return; // We've warned the user about setting up the bot.
    }
    await Bot.ReplyAsync($"Sorry, I did not understand that. Try `{Bot} help {Bot.SkillName}` to learn how to use the {Bot.SkillName} skill.");
}

// This would be the email address for a bot user in PagerDuty.
Task<string> GetDefaultUserEmail() {
    return Bot.Brain.GetAsAsync<string>("PAGERDUTY_FROM_EMAIL");
}

Task WriteDefaultUserEmail(string email) {
    return Bot.Brain.WriteAsync("PAGERDUTY_FROM_EMAIL", email);
}

async Task<string> EnsureBotUserEmailSetAsync() {
    var botUserEmail = await GetDefaultUserEmail();
    if (botUserEmail is not {Length: > 0}) {
        await Bot.ReplyAsync($@"Please set the email of the default ""actor"" user for incident creation and modification. This would be the email address for a Bot User in PagerDuty.
`{Bot} {Bot.SkillName} bot is {{email}}`");
        return null;
    }
    return botUserEmail;
}

async Task ReplyWithIncidentAsync(IArgument idArg) {
    var incidentNumber = idArg.ToInt32();
    if (incidentNumber is null) {
        await Bot.ReplyAsync("That doesn't look like an incident number to me.");
        return;
    }
    var result = await CallPagerDutyApiAsync($"/incidents/{incidentNumber.Value}");
    if (result is null) {
        await Bot.ReplyAsync($"I couldn't find an incident with number {incidentNumber.Value}.");
        return;
    }
    await Bot.ReplyAsync(FormatIncident(result.incident));
}

async Task ReplyWithIncidentsAsync() {
    var incidents = await GetIncidentsAsync(IncidentStatus.Triggered, IncidentStatus.Acknowledged);
    
    var triggered = incidents.Where(i => i.status == "triggered").Select(i => FormatIncident(i)).Cast<string>();
    var acknowledged = incidents.Where(i => i.status == "acknowledged").Select(i => FormatIncident(i)).Cast<string>();
    
    var response = incidents is {Count: 0}
        ? "No open incidents"
        : $"Triggered:\n----------\n{triggered.ToMarkdownList()}\nAcknowledged:\n-------------\n{acknowledged.ToMarkdownList()}";
    await Bot.ReplyAsync(response);
}

async Task<List<dynamic>> GetIncidentsAsync(params IncidentStatus[] statuses) {
    var endpoint = "/incidents?sort_by=incident_number:asc"
        + statuses.Aggregate(string.Empty, (accumulate, status) => $"&statuses[]={status.ToString().ToLowerInvariant()}{accumulate}");
    var result = await CallPagerDutyApiAsync(endpoint);
    return result?.incidents?.ToObject<List<dynamic>>() ?? new List<dynamic>();
}

async Task<List<dynamic>> GetAssignedIncidentsAsync(PagerDutyUser pagerDutyUser) {
    // When user_ids[] are specified, only triggered and acknowledged are returned because resolved are not assigned to anyone.
    var endpoint = $"/incidents?sort_by=incident_number:asc&user_ids[]={pagerDutyUser.User.id}";
    var result = await CallPagerDutyApiAsync(endpoint);
    return result?.incidents?.ToObject<List<dynamic>>() ?? new List<dynamic>();
}

string FormatIncident(dynamic incident) {
    var summary = incident.title;
    List<dynamic> assignments = incident.assignments?.ToObject<List<dynamic>>();
    var assignees = assignments?.Select(a => a?.assignee?.summary);
    string assignedTo = assignees is not null
        ? $"- assigned to {string.Join(", ", assignees)}"
        : string.Empty;
    return $"{incident.incident_number}: {incident.created_at} {summary} {assignedTo}";
}

async Task CreateIncidentNoteAsync(IArgument idArg, IArgument content) {
    var incidentNumber = idArg.ToInt32();
    if (incidentNumber is null) {
        await Bot.ReplyAsync("That doesn't look like an incident number to me.");
        return;
    }
    if (content is IMissingArgument) {
        await Bot.ReplyAsync("Please supply some content for the incident note.");
        return;
    }
}

async Task AddNoteAndReplyAsync(IArgument idArg, IArgument content) {
    var incidentNumber = idArg.ToInt32();
    if (incidentNumber is null) {
        await Bot.ReplyAsync("That doesn't look like an incident number to me.");
        return;
    }
    if (content is IMissingArgument or {Value: {Length: 0}}) {
        await Bot.ReplyAsync("Please specify the content of the note to add");
        return;
    }
    var pagerDutyUser = await GetPagerDutyUser(Bot.From);
    if (pagerDutyUser?.User is null) {
        return;
    }
    
    var data = new {
        note = new {
            content = content.Value
        }
    };
    
    var result = await CallPagerDutyApiAsync($"/incidents/{incidentNumber}/notes", HttpMethod.Post, pagerDutyUser, data);
    if (result is null) {
        await Bot.ReplyAsync("Sorry, I couldn't do it. :(");
        return;
    }
    await Bot.ReplyAsync($"Got it! Note created: {result.note.content}");
}


async Task ReplyWithIncidentNotesAsync(IArgument idArg) {
    var incidentNumber = idArg.ToInt32();
    if (incidentNumber is null) {
        await Bot.ReplyAsync("That doesn't look like an incident number to me.");
        return;
    }
    var notes = new List<string>();
    var result = await CallPagerDutyApiAsync($"/incidents/{incidentNumber}/notes");
    foreach (var note in result.notes) {
        notes.Add($"{note.created_at} {note.user.summary}: {note.content}");
    }
    var response = notes is {Count: 0}
        ? $"Incident {incidentNumber} does not have any notes."
        : notes.ToMarkdownList();
    await Bot.ReplyAsync(response);
}

async Task SetPagerDutyEmail(IArgument emailArg) {
    if (emailArg is IMissingArgument) {
        await Bot.ReplyAsync("Please specify your pager email.");
        return;
    }
    var email = emailArg.Value;
    if (!email.Contains('@')) {
        await Bot.ReplyAsync("Please specify a valid email address for your pager email.");
        return;
    }
    await WritePagerDutyEmail(Bot.From, email);
    await Bot.ReplyAsync($"Okay, I’ll remember your PagerDuty email is {email}");
}

async Task ForgetPagerDutyEmail() {
    await WritePagerDutyEmail(Bot.From, null);
    await Bot.ReplyAsync("Ok, I’ve forgotten your PagerDuty email");
}

Task<string> GetPagerDutyEmail(IChatUser user) {
    return Bot.Brain.GetAsAsync<string>($"{user.Id}|PagerDutyEmail");
}

async Task ReplyWithPagerUserInfo(IChatUser user) {
    var pagerUser = await GetPagerDutyUser(user);
    
    var emailNote = pagerUser switch {
            {PagerDutyEmail: {Length: > 0}} => $"You’ve told me your PagerDuty email is {pagerUser.PagerDutyEmail}",
            {DefaultEmail: {Length: > 0}} => $"I’m assuming your PagerDuty email is {pagerUser.DefaultEmail}. Change it with `{Bot} {Bot.SkillName} me as you@yourdomain.com`",
            _ => $"I don't know your email. Either set it with `{Bot} my email is your@yourdomain.com` or set it specifically for this skill with `{Bot} {Bot.SkillName} me as you@yourdomain.com`"
    };
    
    var response = pagerUser.User is not null
        ? $"I found your PagerDuty user {pagerUser.User.html_url}, {emailNote}"
        : $"I couldn't find your user :( {emailNote}";
    
    await Bot.ReplyAsync(response);
}

async Task<PagerDutyUser> GetPagerDutyUser(IChatUser user) {
    var pagerDutyUser = new PagerDutyUser {
        PagerDutyEmail = await GetPagerDutyEmail(user),
        DefaultEmail = user.Email
    };
    var email = pagerDutyUser.PagerDutyEmail ?? pagerDutyUser.DefaultEmail;
    
    var (possessive, addressee) = user.Id.Equals(Bot.From.Id, StringComparison.Ordinal)
        ? ("your", "you")
        : ($"{user.Name}'s", user.Name);
    
    if (email is null) {
        await Bot.ReplyAsync($"Sorry, I can’t figure out {possessive} email address :( Can {addressee} tell me with `{Bot} pager me as you@yourdomain.com`?");
        return pagerDutyUser;
    }
    var encodedEmail = Uri.EscapeDataString(email);
    dynamic response = await CallPagerDutyApiAsync($"/users?query={encodedEmail}");

    var count = response?.users?.Count ?? 0;
    if (count is 1) {
        pagerDutyUser.User = response.users[0];
        if (pagerDutyUser.User is null) {
            await Bot.ReplyAsync("The Pager Duty API returned a user, but that user is null somehow.");
        }
        return pagerDutyUser;
    }
    await Bot.ReplyAsync($"Sorry, I expected to get 1 user back for {email}, but got {count} :sweat:. If your PagerDuty email is not {email} use `{Bot} pager me as {{email}}`");
    return pagerDutyUser;
}

Task WritePagerDutyEmail(IChatUser user, string email) {
    var key = $"{user.Id}|PagerDutyEmail";
    if (email is null) {
        return Bot.Brain.DeleteAsync(key);
    }
    return Bot.Brain.WriteAsync(key, email);
}

async Task<dynamic> CallPagerDutyApiAsync(string path, HttpMethod method = null, PagerDutyUser fromUser = null, object data = null) {
    var headers = new Headers {
        { "Authorization", $"Token token={restApiKey}" }
    };
    if (fromUser?.PagerDutyEmail is not null) {
        headers["From"] = fromUser.PagerDutyEmail;
    }
    var endpoint = new Uri($"https://api.pagerduty.com{path}");
    try {
        return await Bot.Http.SendJsonAsync(endpoint, method ?? HttpMethod.Get, data, headers);
    }
    catch(Exception e) {
        await Bot.ReplyAsync($"Exception calling the PagerDuty API. {e.Message}");
        return null;
    }
}

async Task<dynamic> CreateIncidentAsync(string serviceId, string message, PagerDutyUser assignee = null, dynamic escalationPolicy = null) {
    var pagerDutyUser = await GetPagerDutyUser(Bot.From);
    if (pagerDutyUser is null) {
        return null;
    }
    var incident = new PagerDutyIncident {
        service = new PagerDutyService { id = serviceId },
        title = message
    };
    if (assignee is not null) {
        incident.assignments = new[] {
            new {
                assignee = new {
                    assignee.User.id,
                    type = "user_reference"
                }
            }
        };
    }
    else if (escalationPolicy is not null) {
        incident.escalation_policy = new {
            escalationPolicy.id,
            type = "escalation_policy_reference"
        };
    }
    var data = new { incident };
    return await CallPagerDutyApiAsync("/incidents", HttpMethod.Post, pagerDutyUser, data);
}

async Task<List<dynamic>> GetSchedules(string scheduleName = null) {
    var endpoint = scheduleName is not null
            ? $"/schedules?query={Uri.EscapeDataString(scheduleName)}"
            : $"/schedules";
    var response = await CallPagerDutyApiAsync(endpoint);
    return response?.schedules?.ToObject<List<dynamic>>() ?? new List<dynamic>();
}

async Task ListServicesAsync() {
    var services = await GetServicesAsync();
    if (services is null) {
        await Bot.ReplyAsync("Something went wrong calling the PagerDuty API.");
        return;
    }
    if (services.Count is 0) {
        await Bot.ReplyAsync("No services found!");
        return;
    }
    var replies = services.Select(service => $"{service.id}: {service.name} ({service.status}) - {service.html_url}").ToMarkdownList();
    await Bot.ReplyAsync(replies);
}

async Task<List<dynamic>> GetServicesAsync() {
    dynamic response = await CallPagerDutyApiAsync("/services");
    var services = response?.services?.ToObject<List<dynamic>>();
    if (services is null) {
        await Bot.ReplyAsync("Something went wrong calling the PagerDuty API. Could not retrieve services.");
    }
    return services ?? new List<dynamic>();
}

async Task ListSchedulesAsync(IArgument searchArg) {
    var subdomain = await EnsureSubdomainAsync();
    if (subdomain is null) {
        return;
    }
    
    var endpoint = "/schedules" + (searchArg is not IMissingArgument ? $"?query={Uri.EscapeDataString(searchArg.Value)}" : string.Empty);
    var response = await CallPagerDutyApiAsync(endpoint);
    List<dynamic> schedules = response?.schedules?.ToObject<List<dynamic>>();
    if (schedules is null) {
        await Bot.ReplyAsync("An error occurred trying to retrieve schedules.");
        return;
    }
    if (schedules is {Count: 0}) {
        await Bot.ReplyAsync("No schedules found!");
        return;
    }
    
    await Bot.ReplyAsync(schedules.Select(schedule => $"<https://{subdomain}.pagerduty.com/schedules{schedule.id}|{schedule.name}>").ToMarkdownList());
}

async Task<string> EnsureSubdomainAsync() {
    var subdomain = await Bot.Brain.GetAsAsync<string>("PAGERDUTY_SUBDOMAIN");
    if (subdomain is not {Length: > 0}) {
        await Bot.ReplyAsync($"Please tell me your account subdomain. `{Bot} {Bot.SkillName} subdomain is {{subdomain}}`");
        return null;
    }
    return subdomain;
}

async Task SetSubdomainAsync(IArgument subdomainArg) {
    if (subdomainArg is IMissingArgument or {Value: {Length: 0}}) {
        await Bot.ReplyAsync("Please specify the subdomain for your PagerDuty account.");
        return;
    }
    await Bot.Brain.WriteAsync("PAGERDUTY_SUBDOMAIN", subdomainArg.Value);
    await Bot.ReplyAsync($"Your PagerDuty account subdomain is now `{subdomainArg.Value}`");
}

var roomKey = Bot.Room.Id ?? Bot.Room.Name;

async Task<string> EnsureServiceIdAsync() {
    var serviceId = await Bot.Brain.GetAsAsync<string>($"{roomKey}|PAGERDUTY_SERVICE_ID");
    if (serviceId is not {Length: > 0}) {
        // Let's see if we can automatically set this.
        var services = await GetServicesAsync();
        if (services is {Count: 1}) {
            serviceId = services[0].id;
            await SetServiceIdAsync(serviceId);
            return serviceId;
        }
        
        if (services is {Count: > 1}) {
            await Bot.ReplyAsync($"You have multiple Services associated with your PagerDuty account. Please specify the Id of the service to use for PagerDuty incidents in this room. `{Bot} {Bot.SkillName} service is {{service-id}}`\nTo see a list of services, `{Bot} {Bot.SkillName} services`");            
        }
        else {
            await Bot.ReplyAsync("You do not have any Services within PagerDuty. Please go to your account in the PagerDuty website and set one up.");
        }

        return null;
    }
    return serviceId;
}

async Task SetServiceIdAsync(IArgument serviceIdArg) {
    if (serviceIdArg is IMissingArgument or {Value: {Length: 0}}) {
        await Bot.ReplyAsync("Please specify the Id for the service this room will page when creating incidents.");
        return;
    }
    await SetServiceIdAsync(serviceIdArg.Value);
}

async Task SetServiceIdAsync(string serviceId) {
    await Bot.Brain.WriteAsync($"{roomKey}|PAGERDUTY_SERVICE_ID", serviceId);
    await Bot.ReplyAsync($"Your PagerDuty account service Id for this room is now `{serviceId}`");
}

async Task<dynamic> GetEscalationPolicyAsync(string query) {
    dynamic response = await CallPagerDutyApiAsync($"/escalation_policies?query={Uri.EscapeDataString(query)}");
    List<dynamic> policies = response?.policies?.ToObject<List<dynamic>>();
    if (policies is null) {
        return null;
    }
    
    if (policies.Count is 1) {
        return policies[0];
    }

    // Try exact match, but only when there is a single exact match.
    var exactMatch = policies.Select(p => query.Equals(p.name, StringComparison.OrdinalIgnoreCase)).SingleOrDefault();
    if (exactMatch is not null) {
        return exactMatch;
    }
    
    return null;
}

public class PagerDutyUser {
    public string PagerDutyEmail { get; set; }
    public string DefaultEmail { get; set; }
    public dynamic User { get; set; }
}

public class PagerDutyIncident {
    public string type => "incident";
    public string title { get; set; }
    public PagerDutyService service { get; set; }
    public object assignments {get; set;}
    public object escalation_policy {get; set;}
}

public class PagerDutyService {
    public string id {get; set;}
    public string type => "service_reference";
}

public enum IncidentStatus {
    Acknowledged,
    Triggered,
    Resolved
}

Version	Created	Author	Release Notes	Installs
2.0.3	10/28/2021	haacked	More handling of null edge cases	1
2.0.2	10/28/2021	haacked	Added better error handling around pager duty API errors.	0
2.0.1	10/22/2021	haacked	Fixed the command to set the PagerDuty bot email address.	0
2.0.0	9/18/2021	haacked	Saving the PagerDuty service Id is per-room. Previous versions of this skill used the room-name as a key to save these values. However, room names can change. Now it uses the room Id if available, otherwise it uses the room name.	0
1.0.0	7/22/2021	haacked	Initial release! ✨	3

Log In or Create Account You need an account to install this package with Abbot. Signing in with Slack or Discord will create an account if you don't have one already.

Details

Last updated: Thursday, 28 October 2024 18:18
Installs: 4 total installs
Language: CSharp
License: MIT License

?	Display shortcuts
Cmd+K	Display shortcuts when a form input has focus.
t	Jump to skill
ctrl+t	Jump to skill when a form input has focus.
Esc	Dismiss modal. Also used to remove focus from a text input to enable keyboard shortcut.
g m	Go to the My Bot page
g s	Go to the skills list
g p	Go to the package directory
g a	Go to the About page
g d	Go to the Docs site
g l	Go to Activity Log

README

Configuration

Mapping your user to PagerDuty

Examples

Feedback

Usage

Code

Version History

Details

Keyboard Shortcuts

Jump to Skill