Package com.squareup.pagerduty.incidents

Utility for programmatically triggering and resolving PagerDuty incidents.

See: Description

Class Summary

Class	Description
FakePagerDuty	A fake implementation of PagerDuty that keeps track of open and closed incidents in memory.
NotifyResult	Response data from triggering or resolving an incident.
PagerDuty	Utility for triggering and resolving PagerDuty incidents.
Resolution	Resolve an existing incident.
Resolution.Builder	Fluent interface for building resolution data.
Trigger	Report a new or ongoing problem.
Trigger.Builder	Fluent interface for building trigger data.

Package com.squareup.pagerduty.incidents Description

Utility for programmatically triggering and resolving PagerDuty incidents.

Usage

Create an instance of PagerDuty with your service's API key:

 PagerDuty pagerDuty = PagerDuty.create("API key");
 

Triggering an incident requires only a description of the problem:

 Trigger trigger = new Trigger.Builder("Sync responded with code: " + code).build();
 NotifyResult result = pagerDuty.notify(trigger);
 

The returned NotifyResult object will contain a generated incident key.

You can also specify a custom incident key as well as additional name-value details:

 Trigger trigger = new Trigger.Builder("Sync responded with code: " + code)
     .withIncidentKey("feed-sync-12")
     .addDetails("Foo", "Bar")
     .addDetails(ImmutableMap.of("Ping", "Pong", "Kit", "Kat"))
     .build();
 pagerDuty.notify(trigger);
 

Resolving an incident requires its key:

 Resolution resolution = new Resolution.Builder("feed-sync-12").build();
 pagerDuty.notify(resolution);
 

A description and additional name-value details can also be specified on resolutions:

 Resolution resolution = new Resolution.Builder("feed-sync-12")
     .withDescription("Sync healthy with code: " + code)
     .addDetails("Foo", "Bar")
     .addDetails(ImmutableMap.of("Ping", "Pong", "Kit", "Kat"))
     .build()
 pagerDuty.notify(resolution);
 

A FakePagerDuty class is provided for testing purposes which behaves similarly to a real PagerDuty backend.