@backstage/plugin-catalog-backend-module-logs 0.0.0-nightly-20240625021714

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @backstage/plugin-catalog-backend-module-logs
+
+## 0.0.0-nightly-20240625021714
+
+### Patch Changes
+
+- 97caf55: Creates a new module to make logging catalog errors simple. This module subscribes to catalog events and logs them.
+
+  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.
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.0.0-nightly-20240625021714
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20240625021714
+  - @backstage/plugin-events-node@0.0.0-nightly-20240625021714

package/README.md

@@ -0,0 +1,8 @@
+# backstage-plugin-catalog-backend-module-logs
+
+A module that subscribes to catalog related events and logs them.
+
+## Getting started
+
+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.

package/dist/index.cjs.js

@@ -0,0 +1,39 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+
+const catalogModuleLogs = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "logs",
+  register(env) {
+    env.registerInit({
+      deps: {
+        events: pluginEventsNode.eventsServiceRef,
+        logger: backendPluginApi.coreServices.logger
+      },
+      async init({ events, logger }) {
+        events.subscribe({
+          id: "catalog",
+          topics: [pluginCatalogBackend.CATALOG_ERRORS_TOPIC],
+          async onEvent(params) {
+            const event = params;
+            const { entity, location, errors } = event.eventPayload;
+            for (const error of errors) {
+              logger.warn(error.message, {
+                entity,
+                location
+              });
+            }
+          }
+        });
+      }
+    });
+  }
+});
+
+exports.default = catalogModuleLogs;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { CATALOG_ERRORS_TOPIC } from '@backstage/plugin-catalog-backend';\nimport { eventsServiceRef, EventParams } from '@backstage/plugin-events-node';\n\ninterface EventsPayload {\n  entity: string;\n  location?: string;\n  errors: Error[];\n}\n\ninterface EventsParamsWithPayload extends EventParams {\n  eventPayload: EventsPayload;\n}\n\n/**\n * A catalog module that logs catalog errors using the logger service.\n *\n * @packageDocumentation\n * @public\n */\nexport const catalogModuleLogs = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'logs',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsServiceRef,\n        logger: coreServices.logger,\n      },\n      async init({ events, logger }) {\n        events.subscribe({\n          id: 'catalog',\n          topics: [CATALOG_ERRORS_TOPIC],\n          async onEvent(params: EventParams): Promise<void> {\n            const event = params as EventsParamsWithPayload;\n            const { entity, location, errors } = event.eventPayload;\n            for (const error of errors) {\n              logger.warn(error.message, {\n                entity,\n                location,\n              });\n            }\n          },\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","eventsServiceRef","coreServices","CATALOG_ERRORS_TOPIC"],"mappings":";;;;;;;;AAuCO,MAAM,oBAAoBA,oCAAoB,CAAA;AAAA,EACnD,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,MAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,iCAAA;AAAA,QACR,QAAQC,6BAAa,CAAA,MAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC7B,QAAA,MAAA,CAAO,SAAU,CAAA;AAAA,UACf,EAAI,EAAA,SAAA;AAAA,UACJ,MAAA,EAAQ,CAACC,yCAAoB,CAAA;AAAA,UAC7B,MAAM,QAAQ,MAAoC,EAAA;AAChD,YAAA,MAAM,KAAQ,GAAA,MAAA,CAAA;AACd,YAAA,MAAM,EAAE,MAAA,EAAQ,QAAU,EAAA,MAAA,KAAW,KAAM,CAAA,YAAA,CAAA;AAC3C,YAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AAC1B,cAAO,MAAA,CAAA,IAAA,CAAK,MAAM,OAAS,EAAA;AAAA,gBACzB,MAAA;AAAA,gBACA,QAAA;AAAA,eACD,CAAA,CAAA;AAAA,aACH;AAAA,WACF;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * A catalog module that logs catalog errors using the logger service.
+ *
+ * @packageDocumentation
+ * @public
+ */
+declare const catalogModuleLogs: _backstage_backend_plugin_api.BackendFeatureCompat;
+
+export { catalogModuleLogs as default };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-logs",
+  "version": "0.0.0-nightly-20240625021714",
+  "description": "A module that subscribes to catalog releated events and logs them.",
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "catalog",
+    "pluginPackage": "@backstage/plugin-catalog-backend"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/catalog-backend-module-logs"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20240625021714",
+    "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20240625021714",
+    "@backstage/plugin-events-node": "^0.0.0-nightly-20240625021714"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20240625021714",
+    "@backstage/cli": "^0.0.0-nightly-20240625021714",
+    "@backstage/plugin-events-backend-test-utils": "^0.0.0-nightly-20240625021714"
+  }
+}