Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@pagerduty/backstage-plugin

pagerduty21.6kApache-2.00.15.5TypeScript support: included

A Backstage plugin that integrates towards PagerDuty

backstage, plugin, pagerduty

readme

PagerDuty plugin for Backstage

Release npm version License

Bring the power of PagerDuty to Backstage! The PagerDuty plugin reduces the cognitive load on developers responsible for maintaining services in production. Instead of having to go to PagerDuty's console, you can now access the necessary information directly within Backstage. This includes finding active incidents or opening a new incident, reviewing recent changes made to the service, and checking who is on-call.

Features

  • Trigger New Incident - Easily create new incidents for your service directly from Backstage. This feature saves time and reduces the need for context switching.
  • See Active Incidents - View all active incidents for a service directly in Backstage.
  • Check for Recent Changes - Identify recent changes that may be the root cause of potential issues with your service.
  • Identify On-Call Personnel - Quickly determine who is responsible for a failing service and resolve the incident as quickly as possible. This feature allows companies to spend more time solving problems rather than determining who should solve them.
  • Map existing PagerDuty services to Backstage entities - Leverage PagerDuty's Advanced Configuration page to map existing PagerDuty services to Backstage entities without code changes.

Getting Started

Find the complete project's documentation here.

Installation

The installation of the PagerDuty plugin for Backstage is done with yarn as all other plugins in Backstage. This plugin follows a modular approach which means that every individual component will be a separate package (e.g. frontend, backend, common). In this case, you are installing a frontend plugin.

To install this plugin run the following command from the Backstage root folder.

yarn add --cwd packages/app @pagerduty/backstage-plugin

Configuration

To configure this frontend plugin follow the instructions on the Getting Started section of the project's documentation here.

Support

If you need help with this plugin, please open an issue in GitHub, reach out on the Backstage Discord server or PagerDuty's community forum.

Contributing

If you are interested in contributing to this project, please refer to our Contributing Guidelines.

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-contributors/thumbnail.png?limit=30&repo_id=681249868&image_size=auto&color_scheme=dark" width="655" height="auto"> Contributors of PagerDuty/backstage-plugin </picture>

changelog

@backstage/plugin-pagerduty

0.6.2

Patch Changes

0.6.2-next.1

Patch Changes

0.6.2-next.0

Patch Changes

0.6.1

Patch Changes

0.6.1-next.2

Patch Changes

0.6.1-next.1

Patch Changes

0.6.1-next.0

Patch Changes

0.6.0

Minor Changes

  • 64bc274a1ee6: Adds a config schema definition so the plugin will validate with the new Backstage CLI "--strict" flag

Patch Changes

0.5.12-next.3

Patch Changes

0.5.12-next.2

Patch Changes

0.5.12-next.1

Patch Changes

0.5.12-next.0

Patch Changes

0.5.11

Patch Changes

0.5.11-next.2

Patch Changes

0.5.11-next.1

Patch Changes

0.5.11-next.0

Patch Changes

0.5.10

Patch Changes

0.5.10-next.3

Patch Changes

0.5.10-next.2

Patch Changes

0.5.10-next.1

Patch Changes

0.5.10-next.0

Patch Changes

0.5.9

Patch Changes

0.5.9-next.2

Patch Changes

0.5.9-next.1

Patch Changes

0.5.9-next.0

Patch Changes

0.5.8

Patch Changes

0.5.8-next.2

Patch Changes

0.5.8-next.1

Patch Changes

0.5.8-next.0

Patch Changes

0.5.7

Patch Changes

0.5.7-next.2

Patch Changes

0.5.7-next.1

Patch Changes

0.5.7-next.0

Patch Changes

0.5.6

Patch Changes

0.5.5

Patch Changes

0.5.5-next.4

Patch Changes

0.5.5-next.3

Patch Changes

0.5.5-next.2

Patch Changes

0.5.5-next.1

Patch Changes

0.5.5-next.0

Patch Changes

0.5.4

Patch Changes

0.5.4-next.1

Patch Changes

0.5.4-next.0

Patch Changes

0.5.3

Patch Changes

0.5.3-next.2

Patch Changes

0.5.3-next.1

Patch Changes

0.5.3-next.0

Patch Changes

0.5.2

Patch Changes

0.5.2-next.3

Patch Changes

0.5.2-next.2

Patch Changes

0.5.2-next.1

Patch Changes

0.5.2-next.0

Patch Changes

0.5.1

Patch Changes

0.5.1-next.1

Patch Changes

0.5.1-next.0

Patch Changes

0.5.0

Minor Changes

  • 8798f8d93f: Introduces a new annotation pagerduty.com/service-id that can be used instead of the pagerduty.com/integration-key annotation. Note: If both annotations are specified on a given Entity, then the pagerduty.com/integration-key annotation will be prefered

    BREAKING The PagerDutyClient.fromConfig static method now expects a FetchApi compatible object and has been refactored to accept 2 arguments: config and ClientApiDependencies The PagerDutyClient now relies on a fetchApi being available to execute fetch requests.

    BREAKING A new query method getServiceByEntity that is used to query for Services by either the integrationKey or serviceId annotation values if they are defined. The integrationKey value is preferred currently over serviceId. As such, the previous getServiceByIntegrationKey method has been removed.

    BREAKING The return values for each Client query method has been changed to return an object instead of raw values. For example, the getIncidentsByServiceId query method now returns an object in the shape of { incidents: Incident[] } instead of just Incident[]. This same pattern goes for getChangeEventsByServiceId and getOnCallByPolicyId functions.

    BREAKING All public exported types that relate to entities within PagerDuty have been prefixed with PagerDuty (e.g. ServicesResponse is now PagerDutyServicesResponse and User is now PagerDutyUser)

    In addition, various enhancements/bug fixes were introduced:

    • The PagerDutyCard component now wraps error and loading messages with an InfoCard to contain errors/messages. This enforces a consistent experience on the EntityPage
    • If no service can be found for the provided integration key, a new Error Message Empty State component will be shown instead of an error alert
    • Introduces the fetchApi to replace standard window.fetch
      • ensures that Identity Authorization is respected and provided in API requests

Patch Changes

0.5.0-next.3

Patch Changes

0.5.0-next.2

Patch Changes

0.5.0-next.1

Patch Changes

0.5.0-next.0

Minor Changes

  • 8798f8d93f: Introduces a new annotation pagerduty.com/service-id that can be used instead of the pagerduty.com/integration-key annotation. Note: If both annotations are specified on a given Entity, then the pagerduty.com/integration-key annotation will be prefered

    BREAKING The PagerDutyClient.fromConfig static method now expects a FetchApi compatible object and has been refactored to accept 2 arguments: config and ClientApiDependencies The PagerDutyClient now relies on a fetchApi being available to execute fetch requests.

    BREAKING A new query method getServiceByEntity that is used to query for Services by either the integrationKey or serviceId annotation values if they are defined. The integrationKey value is preferred currently over serviceId. As such, the previous getServiceByIntegrationKey method has been removed.

    BREAKING The return values for each Client query method has been changed to return an object instead of raw values. For example, the getIncidentsByServiceId query method now returns an object in the shape of { incidents: Incident[] } instead of just Incident[]. This same pattern goes for getChangeEventsByServiceId and getOnCallByPolicyId functions.

    BREAKING All public exported types that relate to entities within PagerDuty have been prefixed with PagerDuty (e.g. ServicesResponse is now PagerDutyServicesResponse and User is now PagerDutyUser)

    In addition, various enhancements/bug fixes were introduced:

    • The PagerDutyCard component now wraps error and loading messages with an InfoCard to contain errors/messages. This enforces a consistent experience on the EntityPage
    • If no service can be found for the provided integration key, a new Error Message Empty State component will be shown instead of an error alert
    • Introduces the fetchApi to replace standard window.fetch
      • ensures that Identity Authorization is respected and provided in API requests

Patch Changes

0.4.0

Minor Changes

  • b157c2eb1c: Breaking: Use identityApi to provide auth token for pagerduty API calls.

Patch Changes

0.4.0-next.2

Minor Changes

  • b157c2eb1c: Breaking: Use identityApi to provide auth token for pagerduty API calls.

Patch Changes

0.3.33-next.1

Patch Changes

0.3.33-next.0

Patch Changes

0.3.32

Patch Changes

0.3.32-next.2

Patch Changes

0.3.32-next.1

Patch Changes

0.3.32-next.0

Patch Changes

0.3.31

Patch Changes

0.3.31-next.1

Patch Changes

0.3.31-next.0

Patch Changes

0.3.30

Patch Changes

0.3.29

Patch Changes

0.3.29-next.0

Patch Changes

0.3.28

Patch Changes

0.3.27

Patch Changes

0.3.26

Patch Changes

0.3.25

Patch Changes

0.3.25-next.0

Patch Changes

0.3.24

Patch Changes

0.3.24-next.0

Patch Changes

0.3.23

Patch Changes

0.3.23-next.0

Patch Changes

0.3.22

Patch Changes

0.3.21

Patch Changes

0.3.20

Patch Changes

0.3.19

Patch Changes

0.3.18

Patch Changes

0.3.17

Patch Changes

0.3.16

Patch Changes

0.3.15

Patch Changes

0.3.14

Patch Changes

0.3.13

Patch Changes

0.3.12

Patch Changes

0.3.11

Patch Changes

0.3.10

Patch Changes

0.3.9

Patch Changes

0.3.8

Patch Changes

0.3.7

Patch Changes

0.3.6

Patch Changes

0.3.5

Patch Changes

0.3.4

Patch Changes

0.3.3

Patch Changes

  • c614ede9a: Updated README to have up-to-date install instructions.
  • Updated dependencies [9afcac5af]
  • Updated dependencies [e0c9ed759]
  • Updated dependencies [6eaecbd81]

0.3.2

Patch Changes

  • 4c049a1a1: - Adds onClick and other props to IconLinkVertical;

    • Allows TriggerButton component to render when pager duty key is missing;
    • Refactors TriggerButton and PagerDutyCard not to have shared state;

    • Removes the action prop of the IconLinkVertical component while adding onClick.

      Instead of having an action including a button with onClick, now the whole component can be clickable making it easier to implement and having a better UX.

      Before:

      const myLink: IconLinkVerticalProps = {
  label: 'Click me',
  action: <Button onClick={myAction} />,
  icon: <MyIcon onClick={myAction} />,
};

      After:

      const myLink: IconLinkVerticalProps = {
  label: 'Click me',
  onClick: myAction,
  icon: <MyIcon />,
};

  • Updated dependencies [12d8f27a6]

  • Updated dependencies [40c0fdbaa]
  • Updated dependencies [2a271d89e]
  • Updated dependencies [bece09057]
  • Updated dependencies [169f48deb]
  • Updated dependencies [8a1566719]
  • Updated dependencies [9d455f69a]
  • Updated dependencies [4c049a1a1]
  • Updated dependencies [02816ecd7]

0.3.1

Patch Changes

  • Updated dependencies [3a58084b6]
  • Updated dependencies [e799e74d4]
  • Updated dependencies [d0760ecdf]
  • Updated dependencies [1407b34c6]
  • Updated dependencies [88f1f1b60]
  • Updated dependencies [bad21a085]
  • Updated dependencies [9615e68fb]
  • Updated dependencies [49f9b7346]
  • Updated dependencies [5c2e2863f]
  • Updated dependencies [3a58084b6]
  • Updated dependencies [2c1f2a7c2]

0.3.0

Minor Changes

  • 549a859ac: Improved the UI of the pagerduty plugin, and added a standalone TriggerButton

Patch Changes

  • Updated dependencies [fd3f2a8c0]
  • Updated dependencies [d34d26125]
  • Updated dependencies [0af242b6d]
  • Updated dependencies [f4c2bcf54]
  • Updated dependencies [10a0124e0]
  • Updated dependencies [07e226872]
  • Updated dependencies [f62e7abe5]
  • Updated dependencies [96f378d10]
  • Updated dependencies [688b73110]

0.2.8

Patch Changes

  • 29a138636: Use the Luxon Date Library to follow the recommendations of ADR010.
  • b288a291e: Migrated to new composability API, exporting the plugin instance as pagerDutyPlugin, entity card as EntityPagerDutyCard, and entity conditional as isPagerDutyAvailable.
  • Updated dependencies [19d354c78]
  • Updated dependencies [b51ee6ece]

0.2.7

Patch Changes

  • Updated dependencies [12ece98cd]
  • Updated dependencies [d82246867]
  • Updated dependencies [c810082ae]
  • Updated dependencies [5fa3bdb55]
  • Updated dependencies [6e612ce25]
  • Updated dependencies [025e122c3]
  • Updated dependencies [21e624ba9]
  • Updated dependencies [da9f53c60]
  • Updated dependencies [32c95605f]
  • Updated dependencies [7881f2117]
  • Updated dependencies [54c7d02f7]
  • Updated dependencies [11cb5ef94]

0.2.6

Patch Changes

0.2.5

Patch Changes

  • b7a124883: Optimize empty state image size.

0.2.4

Patch Changes

  • 342270e4d: Create AboutCard in core and use it in pagerduty and catalog plugin
  • Updated dependencies [1dc445e89]
  • Updated dependencies [342270e4d]

0.2.3

Patch Changes

0.2.2

Patch Changes