PagerDuty 0.0.0

PagerDuty

Client that sends Alert and Change events to the PagerDuty Events API V2

Prerequisites

• PagerDuty account (the free plan is sufficient)
• Any Microsoft .NET runtime that supports .NET Standard 2.0 or later
  • .NET 5.0 or later
  • .NET Core 2.0 or later
  • .NET Framework 4.6.1 or later

Installation

You can install this library into your project from NuGet Gallery using any of the following techniques.

• dotnet add package PagerDuty
• Install-Package PagerDuty
• Project › Manage NuGet Packages… in Visual Studio

Usage

Configuration

1. Create an Integration in PagerDuty and get its Integration Key.
   1. Sign into your PagerDuty account.
   2. Go to Services › Service Directory.
   3. Select an existing Service for which you want to publish events, or create a new Service.
   4. In the Integrations tab of the Service, add a new Integration.
   5. Under Most popular integrations, select Events API V2, then click Add.
   6. Expand the newly-created Integration and copy its Integration Key, which will be used to authorize this library to send Events to the correct Service.
   7. Optionally, you can also rename the Integration to make it more recognizable.
2. Construct a new PagerDuty API client instance in your project, passing your Integration Key as a constructor parameter.

   IPagerDuty pagerDuty = new PagerDuty(integrationKey: "dfca74ebb7450b3e6da3ba6083a323f4");
   

Triggering an Alert

Construct a new TriggerAlert instance with the required parameters, and pass it to the IPagerDuty.Send(Alert) method. This returns an AlertResponse.

AlertResponse alert = await pagerDuty.Send(new TriggerAlert(Severity.Error, "Summary of Alert"));

You can specify optional parameters with an object initializer or assignments.

var trigger = new TriggerAlert(Severity.Warning, "My summary") {
    Class = "my class",
    Component = "my component",
    Group = "my group",
    Links = { new Link("https://aldaviva.com/", "Aldaviva") },
    Images = { new Image("https://aldaviva.com/avatars/ben.jpg", "https://aldaviva.com/", "Ben Hutchison") },
    CustomDetails = new {
        A = 1,
        B = "2"
    }
};
trigger.Source = "my source";
trigger.Timestamp = DateTimeOffset.Now;

If a key in your CustomDetails object isn't a valid identifier in C#, for example if it contains spaces, you can also use an IDictionary<string, object>, or any other type that can be serialized into JSON.

trigger.CustomDetails = new Dictionary<string, object> {
    { "key 1", "value 1" },
    { "key 2", "value 2" },
};

Acknowledging an Alert

This is the same as triggering an Alert, except you construct an AcknowledgeAlert and set its DedupKey to the value in the AlertResponse from the prior TriggerAlert, which identifies the specific Alert to acknowledge.

await pagerDuty.Send(new AcknowledgeAlert(alert.DedupKey));

Resolving an Alert

This is the same as acknowledging an Alert, but with ResolveAlert.

await pagerDuty.Send(new ResolveAlert(alert.DedupKey));

Creating a change

You can also create Changes in additon to Alerts.

await pagerDuty.Send(new Change("Summary of Change"));

Cleaning up

PagerDuty contains an HttpClient, so when you're done with the instance, call Dispose() to clean it up and allow the HttpClient to be garbage collected.

pagerDuty.Dispose();

References

• PagerDuty Events API V2 Documentation
• PagerDuty Events API V2 API Reference