Files
backstage/plugins/rollbar-backend
github-actions[bot] f95345c845 Version Packages (next)
2023-10-03 10:49:45 +00:00
..
2023-10-03 10:49:45 +00:00
2023-10-03 10:49:45 +00:00

Rollbar Backend

Simple plugin that proxies requests to the Rollbar API.

Setup

  1. Install the plugin using:
# From your Backstage root directory
yarn add --cwd packages/backend @backstage/plugin-rollbar-backend
  1. Create a rollbar.ts file inside packages/backend/src/plugins/:
import { createRouter } from '@backstage/plugin-rollbar-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';

export default async function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  return await createRouter({
    logger: env.logger,
    config: env.config,
  });
}
  1. Modify your packages/backend/src/index.ts to include:
 ...

 import { Config } from '@backstage/config';
 import app from './plugins/app';
+import rollbar from './plugins/rollbar';
 import scaffolder from './plugins/scaffolder';

 ...

 async function main() {

   ...

   const authEnv = useHotMemoize(module, () => createEnv('auth'));
+  const rollbarEnv = useHotMemoize(module, () => createEnv('rollbar'));
   const proxyEnv = useHotMemoize(module, () => createEnv('proxy'));

   ...

   const apiRouter = Router();
   apiRouter.use('/catalog', await catalog(catalogEnv));
+  apiRouter.use('/rollbar', await rollbar(rollbarEnv));
   apiRouter.use('/scaffolder', await scaffolder(scaffolderEnv));

The following values are read from the configuration file.

rollbar:
  accountToken: ${ROLLBAR_ACCOUNT_TOKEN}

NOTE: The ROLLBAR_ACCOUNT_TOKEN environment variable must be set to a read access account token.