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

feat: add backend.auditor.severityLogLevelMappings to map severity levels to log levels

Browse Source 
Signed-off-by: Paul Schultz <pschultz@pobox.com>
This commit is contained in:
Paul Schultz
2025-03-04 13:21:19 -06:00
parent 02981a2377
commit 175528cce3
5 changed files with 236 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/backend-system/core-services/auditor.md
+38
View File
@@ -151,3 +151,41 @@ To clarify how to utilize the Auditor feature effectively, we recommend explorin
- It illustrates how to detail various `eventId` values and their corresponding `meta` fields (e.g., `queryType`, `actionType`) for different plugin operations.
These examples provide both a code-level demonstration and a documentation guideline for effectively utilizing the `AuditorService` to manage audit events within your Backstage plugins.
## Severity Log Level Mappings
The Auditor Service provides a way for plugins to log significant events, categorized by their severity. The `severityLogLevelMappings` configuration option enables you to customize how these severity levels are mapped to actual log levels within your Backstage backend, giving you precise control over the verbosity of your audit logs.
### Configuration
The `severityLogLevelMappings` are configured under the `backend.auditor` section of your `app-config.yaml` file. This structure allows you to specify the log level for each severity level supported by the Auditor Service. You can override individual severity levels without changing the entire mapping.
Example configuration:
```yaml
backend:
auditor:
severityLogLevelMappings:
low: debug
medium: info
high: warn
critical: error
```
### Severity Levels and Default Mappings
The Auditor Service supports the following severity levels:
- `low`: Represents low-importance events, typically informational or debug-level.
- `medium`: Represents events of moderate importance, requiring some attention.
- `high`: Represents high-importance events, potentially indicating a problem or security issue.
- `critical`: Represents critical events, requiring immediate attention.
By default, these severity levels are mapped to the following log levels:
- `low`: `debug`
- `medium`: `info`
- `high`: `info`
- `critical`: `info`
As a result, medium, high, and critical events are logged as info-level events by default, while low-level events are treated as debug.