paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

Updated the README and description on the real API page

Browse Source 
Signed-off-by: Karan Shah <karan.shah@simplybusiness.co.uk>
This commit is contained in:
Karan Shah
2022-02-16 17:15:40 +00:00
parent 5116fb553b
commit 59140f62a5
3 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/airbrake-backend/README.md
+9 -8
View File
@@ -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
plugins/airbrake/README.md
+1 -1
View File
@@ -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
plugins/airbrake/dev/index.tsx
+4 -1
View File
@@ -54,7 +54,10 @@ createDevApp()
element: (
<ContextProvider>
<Page themeId="tool">
<Header title="Airbrake demo application" subtitle="Real API">
<Header
title="Airbrake demo application"
subtitle="Real API (The Airbrake backend plugin must be running for this to work)"
>
<ApiBar />
</Header>
<Content>