From 41a72e0a5aaa1ce1144a968711f16e11b10d1dcd Mon Sep 17 00:00:00 2001 From: Guilherme Eric <38785079+guilhermeeric@users.noreply.github.com> Date: Tue, 26 Apr 2022 14:02:07 -0300 Subject: [PATCH 1/3] update rollbar backend readme Signed-off-by: Guilherme Eric --- plugins/rollbar-backend/README.md | 51 +++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/plugins/rollbar-backend/README.md b/plugins/rollbar-backend/README.md index 2dcf6495dd..0f6e692b24 100644 --- a/plugins/rollbar-backend/README.md +++ b/plugins/rollbar-backend/README.md @@ -4,6 +4,57 @@ Simple plugin that proxies requests to the [Rollbar](https://rollbar.com) API. ## Setup +1. Install the plugin using: + +```bash +# From your Backstage root directory +yarn add --cwd packages/backend @backstage/plugin-rollbar-backend +``` + +2. Create a `rollbar.ts` file inside `packages/backend/src/plugins/`: + +```typescript +import { createRouter } from '@backstage/plugin-rollbar-backend'; +import { Router } from 'express'; +import { PluginEnvironment } from '../types'; + +export default async function createPlugin( + env: PluginEnvironment, +): Promise { + return await createRouter({ + logger: env.logger, + config: env.config + }); +} +``` + +3. Modify your `packages/backend/src/index.ts` to include: +```diff + ... + + 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. ```yaml From ab1435dcc9184012a5e914334d32402d57b1ded4 Mon Sep 17 00:00:00 2001 From: Guilherme Eric Date: Tue, 26 Apr 2022 14:31:06 -0300 Subject: [PATCH 2/3] add changeset Signed-off-by: Guilherme Eric --- .changeset/metal-hairs-build.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/metal-hairs-build.md diff --git a/.changeset/metal-hairs-build.md b/.changeset/metal-hairs-build.md new file mode 100644 index 0000000000..6467456e0f --- /dev/null +++ b/.changeset/metal-hairs-build.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-rollbar-backend': patch +--- + +Updated rollbar-backend's README to include clearer instructions on how to install and configure. From 136bd9e16282b2ffe7294a52ccf7ecf3dfc7034a Mon Sep 17 00:00:00 2001 From: Guilherme Eric Date: Wed, 27 Apr 2022 08:36:22 -0300 Subject: [PATCH 3/3] fixes from pr review Signed-off-by: Guilherme Eric --- .changeset/metal-hairs-build.md | 2 +- plugins/rollbar-backend/README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.changeset/metal-hairs-build.md b/.changeset/metal-hairs-build.md index 6467456e0f..9ed8bba01b 100644 --- a/.changeset/metal-hairs-build.md +++ b/.changeset/metal-hairs-build.md @@ -2,4 +2,4 @@ '@backstage/plugin-rollbar-backend': patch --- -Updated rollbar-backend's README to include clearer instructions on how to install and configure. +Updated README to include clearer installation instructions on how to install and configure. diff --git a/plugins/rollbar-backend/README.md b/plugins/rollbar-backend/README.md index 0f6e692b24..d28ee60181 100644 --- a/plugins/rollbar-backend/README.md +++ b/plugins/rollbar-backend/README.md @@ -23,12 +23,13 @@ export default async function createPlugin( ): Promise { return await createRouter({ logger: env.logger, - config: env.config + config: env.config, }); } ``` 3. Modify your `packages/backend/src/index.ts` to include: + ```diff ...