README.md

Statuspage.io plugin

Welcome to the Statuspage.io plugin!

Introduction

The Statuspage plugin allows you to embedd https://statuspage.io components, component groups and dashboards in Backstage.

There is a React-card, <StatuspageEntityCard />, that is suitable for the Entity component/service overview page:

And also one card, <StatuspagePage name="myinstance"/>, for easy integration of a complete Statuspage. This component is not dependent on the useEntity()-hook, making it easy to integrate on the Home-page (or some other portal).

Note

You will need to also perform the installation instructions in Statuspage Backend in order for this plugin to work.

Getting Started

1. First, install the plugin into your app:

# From your Backstage root directory
yarn --cwd packages/app add @axis-backstage/plugin-statuspage

1. Setup the API-factory.

// packages/app/src/apis.ts:

createApiFactory({
    api: statuspageApiRef,
    deps: {
      discoveryApi: discoveryApiRef,
      fetchApi: fetchApiRef,
    },
    factory: ({ discoveryApi, fetchApi }) =>
      new StatuspageClient({ discoveryApi, fetchApi }),
  }),

1. Setup configuration

statuspage:
  - name: mystatuspageinstance
    pageid: abc123foo456
    token: ${STATUSPAGE_TOKEN}
    link: https://<your statuspage>.statuspage.io # Optional

If you have access to the Statuspage.io dashboard, your page ID is usually visible in the URL when you're logged in and managing your page. Look for a segment in the URL that appears after /manage/pages/. The format usually looks something like https://manage.statuspage.io/pages/YOUR_PAGE_ID.

1. Then, modify your entity page in EntityPage.tsx to include the StatuspageEntityComponent component and the isStatuspageAvailable function. Both are exported from the plugin. The example below show how you can add the plugin to the defaultEntityPage:

// In packages/app/src/components/catalog/EntityPage.tsx
import { StatuspageEntityComponent, isStatuspageAvailable } from '@axis-backstage/plugin-statuspage';

const defaultEntityPage = (
      <EntitySwitch>
        <EntitySwitch.Case if={isStatuspageAvailable}>
          <Grid item xs={12}>
            <StatuspageEntityCard />
          </Grid>
        </EntitySwitch.Case>
      </EntitySwitch>
  ...
);

Integration with the Catalog

To enable the StatuspageEntityCard for your entity, the entity yaml must have the following annotation:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    statuspage.io/components: instance:component_id,component_id,component_id # Jira component name separated with a comma

The instance here is the statuspage.instance.nam config value.

The component_id could be the id of either a component or a component group. This can be found in your statuspage.io management interface:

Setup a complete StatuspagePage with all components

// In packages/app/src/App.tsx:

<Route path="/statuspage" element={<StatuspagePage name="myid" />} />