Giter VIP home page Giter VIP logo

backstage-plugin-opsgenie's Introduction

Opsgenie plugin for Backstage

Welcome to the Opsgenie plugin!

Alerts page: Opsgenie alerts page

Incidents page: Opsgenie incidents page

Alerts card: Opsgenie alerts card

Plugin Setup

  1. If you have standalone app (you didn't clone this repository), then do:
yarn add @k-phoen/backstage-plugin-opsgenie
  1. Configure the plugin:
proxy:
  '/opsgenie/api':
    target: https://api.eu.opsgenie.com
    headers:
      Authorization: GenieKey [[ API KEY here ]]

opsgenie:
  domain: https://my-app.app.eu.opsgenie.com/

Note: this plugin requires an API key issued from an integration. They can be retrieved from the "Settings" tab and then "Integrations" tab.

  1. Add the plugin to the list of plugins:
// packages/app/src/plugins.ts
export { plugin as PluginOpsgenie } from '@k-phoen/backstage-plugin-opsgenie';
  1. Expose the plugin to your Backstage instance:
// packages/app/src/App.tsx
import { Router as OpsgenieRouter } from '@k-phoen/backstage-plugin-opsgenie';

// ...

const AppRoutes = () => (
  <Routes>
    /// ...
    <Route path="/opsgenie/*" element={<OpsgenieRouter />} />
    // ...
  </Routes>
);
  1. Add it to the EntityPage.ts:
import {
  AlertsCard as OpsgenieAlertsCard,
  isPluginApplicableToEntity as isOpsgenieAvailable
} from '@k-phoen/backstage-plugin-opsgenie';

// add wherever you want to display the alerts card:
{
  isOpsgenieAvailable(entity) && (
    <Grid item>
      <OpsgenieAlertsCard entity={entity} />
    </Grid>
  );
}
  1. Run backstage app with yarn start and navigate to services tabs.

Components annotations

In order for this plugin to know what alerts belong to which component, a selector must be defined:

annotations:
  opsgenie.com/component-selector: 'tag:"service:my-awesome-service"'

backstage-plugin-opsgenie's People

Contributors

k-phoen avatar adamdmharvey avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.