Skip to content

Configure service dependency sync

The PagerDuty plugin allows users who use Backstage as their service catalog to sync the dependencies automatically to the corresponding PagerDuty services.

This feature is very powerful for users that want to leverage PagerDuty Status Pages properly but are limited by the fact that they don't have service dependencies configured in PagerDuty. With this feature, the plugin will do this automatically for you.

Note

Only the Backstage entities that have corresponding services in PagerDuty will get their service dependencies mapped. This feature is powered by the CatalogProcessor and therefore if you make changes on your Backstage entity configuration they will, in time, be mapped to PagerDuty.

These changes might not reflect immediately because the CatalogProcessor runs on a schedule and the plugin doesn't have control over that. Backstage admins can configure the frequency at which the entities are processed.

This feature is disabled by default but can easily be enabled on the PagerDuty advanced configuration page. If you haven't enabled it yet you can do so by following the instructions here.

dependency-sync-strategy

Here you can choose:

  • to use Backstage as the main source and the plugin will automatically add/remove service dependencies to your mapped entities in PagerDuty
  • to set PagerDuty as the main source and the plugin will automatically add/remove entity relations in Backstage
  • to merge service dependencies from Backstage and PagerDuty
  • to keep it disabled.

Note

The syncing mechanism will overwrite all services on the destination so use this mechanism carefully.

Example: You set Backstage as your main source and you already have service dependencies in PagerDuty. Those will be overwritten as Backstage is now configured as the source of truth.