diff --git a/plugins/airbrake-backend/README.md b/plugins/airbrake-backend/README.md index c7588fdb4e..7ded50c85a 100644 --- a/plugins/airbrake-backend/README.md +++ b/plugins/airbrake-backend/README.md @@ -8,13 +8,14 @@ See the [Airbrake plugin instructions](../airbrake/README.md#how-to-use). ## Local Development -1. Set the environment variable `AIRBRAKE_API_KEY` with your API key. -2. Run this plugin in standalone mode by running `yarn start`. The configuration is already setup in the root [`app-config.yaml`](../../app-config.yaml) to pick up your API key from the environment variable above. -3. Access it from [/airbrake-backend](http://localhost:7007/airbrake-backend). Or use the Airbrake plugin which will talk to it automatically when using the real API. - -Here is an example endpoint: http://localhost:7007/airbrake-backend/health - -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development. +1. Set the environment variable `AIRBRAKE_API_KEY` with your [API key](https://airbrake.io/docs/api/#authentication). +2. Run this plugin in standalone mode by running `yarn start`. The configuration is already setup in the root [`app-config.yaml`](../../app-config.yaml) to pick up your API key from the environment variable above. + +Access it from http://localhost:7007/api/airbrake. Or use the Airbrake plugin which will talk to it automatically. + +Here are some example endpoints: + +- http://localhost:7007/api/airbrake/health +- http://localhost:7007/api/airbrake/api/v4/projects diff --git a/plugins/airbrake/README.md b/plugins/airbrake/README.md index 3a77266890..2fb5dbd2fc 100644 --- a/plugins/airbrake/README.md +++ b/plugins/airbrake/README.md @@ -63,7 +63,7 @@ The Airbrake plugin provides connectivity between Backstage and Airbrake (https: apiKey: ${AIRBRAKE_API_KEY} ``` -6. Set an environment variable `AIRBRAKE_API_KEY` with your [API Key](https://airbrake.io/docs/api/#authentication) +6. Set an environment variable `AIRBRAKE_API_KEY` with your [API key](https://airbrake.io/docs/api/#authentication) before starting Backstage backend. ## Local Development diff --git a/plugins/airbrake/dev/index.tsx b/plugins/airbrake/dev/index.tsx index d2b2d33e40..a844dfdfdc 100644 --- a/plugins/airbrake/dev/index.tsx +++ b/plugins/airbrake/dev/index.tsx @@ -54,7 +54,10 @@ createDevApp() element: ( -
+