Skip to main content

PagerDuty

CatalogScorecards

Summary

PagerDuty is an alert and on-call management platform. You can use PagerDuty to drive insights into values such as:

  • Oncall rotation
  • Escalation policies
  • Trigger incidents

Setup

In order to connect Cortex to your PagerDuty instance, you’ll need to create a PagerDuty API Key, and add it under Settings → PagerDuty.

caution

If you do not see the Settings page you're looking for in the sidebar, you likely don't have the proper permissions and need to contact your admin.

tip

You can use a Read Only key if you do not wish to use the Trigger Incident feature in the Catalog.

Oncall

Discovery

By default, Cortex will try to "best-guess" the corresponding Service entity in PagerDuty. Cortex first looks up a PagerDuty Service using the name (e.g. My Service), then the service identifier (e.g. my-service). For example, if your service name is “My Service”, then the corresponding Service in PagerDuty should also be “My Service”.

Catalog Descriptor

PagerDuty Service

You can find the service ID value by visiting PagerDuty → Configuration → Services. The URL for the service will contain the ID, for example: https://cortexapp.pagerduty.com/services/<ID>

x-cortex-oncall:
pagerduty:
id: ASDF1234 # Service ID
type: SERVICE

Schedules

You can find the Schedule ID by vising PagerDuty → People → On-Call Schedules and clicking on the desired schedule. The ID is found in the URL, for example https://cortexapp.pagerduty.com/schedules#<ID>.

x-cortex-oncall:
pagerduty:
id: ASDF1234 # Schedule ID
type: SCHEDULE
caution

The Trigger Incident feature in the Catalog only works with PagerDuty Services.

Escalation Policy

You can find the Escalation Policy ID by vising PagerDuty → People → Escalation Policies and clicking on the desired policy. The ID is found in the URL, for example https://cortexapp.pagerduty.com/escalation_policies#<ID>.

x-cortex-oncall:
pagerduty:
id: ASDF1234 # Escalation Policy ID
type: ESCALATION_POLICY