DX Backstage Frontend Plugin

DX Backstage frontend plugin to display DX data in your Backstage app.

Setup

1. Ensure your backstage services are annotated with the github.com/project-slug annotation.

2. Ensure DX backend plugin is installed and working @get-dx/backstage-backend-plugin.

3. Install this plugin in your backstage frontend —

yarn --cwd packages/app add @get-dx/backstage-plugin

1. We provide an "all-in-one" DX dashboard component. Install that by adding a route to your service entity page —

// packages/app/src/components/catalog/EntityPage.tsx
import { EntityDXDashboardContent } from '@get-dx/backstage-plugin';

const serviceEntityPage = (
  <EntityLayout>
    <EntityLayout.Route path="/dx" title="DX">
      <EntityDXDashboardContent />
    </EntityLayout.Route>
  </EntityLayout>
)

See the Components section below for other components offered.

Components

We export a few Dashboard pages, as well as the individual components that make up the dashboards so you can render them wherever you like.

They can be rendered on both Component and Group entity pages.

| Component | Description | | ----------------------------------- | --------------------------------------------------------------------- | | <EntityDXDashboardContent /> | Dashboard with all available DX Charts. | | <EntityDORAMetricsContent /> | Dashboard with all the DORA metric charts. | | <EntityChangeFailureRateCard /> | Line chart showing Change Failure Rate for the service. | | <EntityDeploymentFrequencyCard /> | Line chart showing Deployment Frequency for the service. | | <EntityOpenToDeployCard /> | Line chart showing Open to Deploy time for the service. | | <EntityTimeToRecoveryCard /> | Line chart showing Time to Recovery for the service. | | <EntityTopContributorsTable /> | Table showing top contributors by pull request count for the service. |

Configuration

Application Id

This plugin respects the same appId configuration as the backend plugin to distinguish multiple instances of backstage within DX. Can be any string as long as it's unique within your DX account.

# app-config.yaml
dx:
  appId: staging

Development

yarn install and yarn start will start a local dev server showing the UI of this component. See dev/index.tsx for setup.

To see real data, link to a local backstage instance and use yalc.