https://github.com/sammbetts/backstage-plugin-service-health

A plugin for Backstage to display and notify of third party service incidents
https://github.com/sammbetts/backstage-plugin-service-health

Last synced: 8 days ago
JSON representation

A plugin for Backstage to display and notify of third party service incidents

• Host: GitHub
• URL: https://github.com/sammbetts/backstage-plugin-service-health
• Owner: sammbetts
• Created: 2023-10-23T08:18:16.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-06T12:34:01.000Z (9 months ago)
• Last Synced: 2024-08-02T15:11:14.027Z (3 months ago)
• Language: TypeScript
• Size: 2.51 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md

Awesome Lists containing this project

README

        
# Backstage Plugin: service-health

Welcome to the service health plugin for [Backstage!](https://backstage.io/)

This plugin displays the status and active incidents of third party services directly in Backstage.

### Plugin Features:

- This plugin uses the third party services public status API.

- Real time display of services current status.

- If an active incident is happening the drop down will appear to display more details.

- Only the most recent incident update message is displayed.

- Links to the services full public dashboards and to the specific ongoing incident.

- A Card component to display an overview of the status's on the homepage.

- Ability to enable slack notifications for alerting of new incidents.




Service Health page default display:

![img](docs/assets/2.png)

Dark mode:

![img](docs/assets/5.png)

When an ongoing incident is happening, the drop down tables become available to open for more information:

![img](docs/assets/1.png)

Home page card:

![img](docs/assets/4.png)

Dark mode:

![img](docs/assets/3.png)

## Getting started

- [Frontend installation instructions](docs/frontend-installation.md)

- [Backend installation instructions](docs/backend-installation.md)

- [Contributing guide](docs/contributing.md)