backstage-plugin-grafana-catalog

The grafana-service-model backend module for the catalog plugin.

APACHE-2.0 License

Downloads
176
Stars
8
Committers
2

@grafana/backstage-plugin-grafana-catalog

The grafana-service-model backend module for the Backstage catalog.

Grafana Cloud can track your Backstage catalog and use that data to control behavior of Grafana Cloud systems.

Initially this integration will allow you to associate "Services" (Components of type: service) to objects in Grafana OnCall. In the future we will be able to use this data to track Team ownership and Service <-> Service dependencies.

The Grafana "ServiceModel" is basically a mirror of the Backstage Catalog model.

This work is very early. We are still exploring ways to utilize your Backstage Catalog. Please reach out if you have ideas!

Quick Start Guide

Follow the quick start guide to test this plugin with a new Backstage install. The instructions should carry over to your production install.

Notes for developers

To create a backstage instance, and install this plugin run the following:

> BACKSTAGE_APP_NAME=backstage npx @backstage/[email protected]
> cd backstage
> yarn add --cwd packages/backend file:<path to this repo>/backstage-plugin-grafana-catalog && LOG_LEVEL=debug yarn dev