add logging module to make this easier for users but retain custom docs

Signed-off-by: Christopher Diaz <codingdiaz@icloud.com>
2024-06-07 11:56:36 -04:00
parent 21bef93e35
commit 97caf55823
3 changed files with 57 additions and 0 deletions
@@ -199,6 +199,15 @@ backend.add(import('@backstage/plugin-events-backend/alpha'));

 If you want to log catalog errors you can install the `@backstage/plugin-catalog-backend-module-logs` module.

+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-catalog-backend-module-logs'));
 ```