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

remove duplicate module docs and point to backstage docs

Browse Source 
Signed-off-by: Christopher Diaz <codingdiaz@icloud.com>
This commit is contained in:
Christopher Diaz
2024-06-19 11:12:30 -04:00
committed by Fredrik Adelöw
parent 066cc7143e
commit 16589947aa
1 changed files with 3 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/catalog-backend-module-logs/README.md
+3 -34
View File
@@ -2,38 +2,7 @@
A module that subscribes to catalog related events and logs them.
Catalog errors are published to the [events plugin](https://github.com/backstage/backstage/tree/master/plugins/events-node): `@backstage/plugin-events-node`. You can subscribe to events and respond to errors, for example you may wish to log them.
## Getting started
The first step is to add the events backend plugin to your Backstage application. Navigate to your Backstage application directory and add the plugin package.
```ts
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-events-node
```
Now you can install the events backend plugin in your backend.
Install the catalog logs module.
```ts
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-logs
```
Add the module to your backend.
```ts title="packages/backend/src/index.ts"
backend.add(import('@backstage/plugin-events-backend/alpha'));
```
Now install the catalog logs module.
```ts title="packages/backend/src/index.ts"
backend.add(import('@backstage/plugin-catalog-backend-module-logs'));
```
You should now see logs as the catalog emits events. Example:
```
[1] 2024-06-07T00:00:28.787Z events warn Policy check failed for user:default/guest; caused by Error: Malformed envelope, /metadata/tags must be array entity=user:default/guest location=file:/Users/foobar/code/backstage-demo-instance/examples/org.yaml
```
See [Backstage documentation](https://backstage.io/docs/features/software-catalog/configuration#subscribing-to-catalog-errors) for details on how to install
and configure the plugin.