From 8e0f15f6de97753b2b47146c53a2601e4d479ec6 Mon Sep 17 00:00:00 2001 From: Gustavo Lira Date: Mon, 28 Apr 2025 17:35:52 -0300 Subject: [PATCH 1/3] add note about visibility of entity-fetch audit events in logs add clarification about visibility of entity-fetch audit events in logs Signed-off-by: Gustavo Lira --- .changeset/every-bottles-grow.md | 5 +++++ plugins/catalog-backend/README.md | 1 + 2 files changed, 6 insertions(+) create mode 100644 .changeset/every-bottles-grow.md diff --git a/.changeset/every-bottles-grow.md b/.changeset/every-bottles-grow.md new file mode 100644 index 0000000000..a61a7b42b9 --- /dev/null +++ b/.changeset/every-bottles-grow.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend': patch +--- + +"Added a note clarifying that `entity-fetch` audit events are not visible by default in the logs and are only displayed when the log severity level is adjusted." diff --git a/plugins/catalog-backend/README.md b/plugins/catalog-backend/README.md index 680adc0bcd..0d544160d0 100644 --- a/plugins/catalog-backend/README.md +++ b/plugins/catalog-backend/README.md @@ -94,6 +94,7 @@ The Catalog backend emits audit events for various operations. Events are groupe **Entity Events:** - **`entity-fetch`**: Retrieves entities. +- **Note:** By default, `entity-fetch` audit events are not visible in the log output. This is because these events are classified with a severity level of "low", which maps to the "debug" log level. The default log level in Backstage is "info", so debug-level events (severity "low") are filtered out. To see `entity-fetch` events in the logs, adjust the Auditor Service configuration by setting `backend.auditor.severityLogLevelMappings.low` to `info` in your `app-config.yaml`. For more information, refer to the [Auditor Service documentation on severity levels and default mappings](https://backstage.io/docs/backend-system/core-services/auditor/#severity-levels-and-default-mappings). Filter on `queryType`. From b85aeefdd5c0fe543231084639d93e5c01cb49da Mon Sep 17 00:00:00 2001 From: Gustavo Lira e Silva Date: Fri, 9 May 2025 10:57:04 -0300 Subject: [PATCH 2/3] Update plugins/catalog-backend/README.md Co-authored-by: Paul Schultz Signed-off-by: Gustavo Lira e Silva --- plugins/catalog-backend/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/plugins/catalog-backend/README.md b/plugins/catalog-backend/README.md index 0d544160d0..8593ade53e 100644 --- a/plugins/catalog-backend/README.md +++ b/plugins/catalog-backend/README.md @@ -94,7 +94,8 @@ The Catalog backend emits audit events for various operations. Events are groupe **Entity Events:** - **`entity-fetch`**: Retrieves entities. -- **Note:** By default, `entity-fetch` audit events are not visible in the log output. This is because these events are classified with a severity level of "low", which maps to the "debug" log level. The default log level in Backstage is "info", so debug-level events (severity "low") are filtered out. To see `entity-fetch` events in the logs, adjust the Auditor Service configuration by setting `backend.auditor.severityLogLevelMappings.low` to `info` in your `app-config.yaml`. For more information, refer to the [Auditor Service documentation on severity levels and default mappings](https://backstage.io/docs/backend-system/core-services/auditor/#severity-levels-and-default-mappings). +- **Note:** By default, "low" severity audit events like `entity-fetch` aren't logged because they map to the "debug" level, while Backstage defaults to "info" level logging. To see `entity-fetch` events, update your `app-config.yaml` by setting `backend.auditor.severityLogLevelMappings.low: info`. See the [Auditor Service documentation](https://backstage.io/docs/backend-system/core-services/auditor/#severity-levels-and-default-mappings) for details on severity mappings. + Filter on `queryType`. From 269ce9604fab2fbcfb730ccccfaffb9d120d4dcd Mon Sep 17 00:00:00 2001 From: Gustavo Lira Date: Fri, 9 May 2025 12:56:09 -0300 Subject: [PATCH 3/3] update README to clarify logging configuration for entity-fetch audit events Signed-off-by: Gustavo Lira --- plugins/catalog-backend/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/plugins/catalog-backend/README.md b/plugins/catalog-backend/README.md index 8593ade53e..00b88cf060 100644 --- a/plugins/catalog-backend/README.md +++ b/plugins/catalog-backend/README.md @@ -96,7 +96,6 @@ The Catalog backend emits audit events for various operations. Events are groupe - **`entity-fetch`**: Retrieves entities. - **Note:** By default, "low" severity audit events like `entity-fetch` aren't logged because they map to the "debug" level, while Backstage defaults to "info" level logging. To see `entity-fetch` events, update your `app-config.yaml` by setting `backend.auditor.severityLogLevelMappings.low: info`. See the [Auditor Service documentation](https://backstage.io/docs/backend-system/core-services/auditor/#severity-levels-and-default-mappings) for details on severity mappings. - Filter on `queryType`. - **`all`**: Fetching all entities. (GET `/entities`)