Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-586

Update RHDH Audit Logging Documentation for Version 1.6

XMLWordPrintable

    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide
      = {product} introduces the Backstage Audit Log Service

      {product} {product-version} introduces the Backstage Audit Log Service, which replaces the custom audit logging system. This is a significant structural and behavioral change to how audit events are generated and consumed.

      The key changes introduced by this transition include the following:

      * Audit logging is now delegated to Backstage plugins. Each plugin in Backstage is responsible for implementing and emitting its own audit events.

      * Audit event names, structure, and content may differ per plugin. Audit events are scoped and designed independently within each plugin using the standardized upstream mechanism, which automatically captures actor details and plugin context.

      * New Event Structure and Naming: Audit event names now follow Backstage’s conventions (for example, lowercase, kebab-case names), and include structured metadata such as `actionType`. Legacy {product-short} event names (for example, `ScaffolderTaskCreation`, `CatalogEntityDeletion`) are no longer used.

      * Enhanced Log Context: Each audit event includes the plugin context, making it easier to filter logs for specific functional areas. You can filter by the event IDs or metadata associated with that plugin.

      Show
      = {product} introduces the Backstage Audit Log Service {product} {product-version} introduces the Backstage Audit Log Service, which replaces the custom audit logging system. This is a significant structural and behavioral change to how audit events are generated and consumed. The key changes introduced by this transition include the following: * Audit logging is now delegated to Backstage plugins. Each plugin in Backstage is responsible for implementing and emitting its own audit events. * Audit event names, structure, and content may differ per plugin. Audit events are scoped and designed independently within each plugin using the standardized upstream mechanism, which automatically captures actor details and plugin context. * New Event Structure and Naming: Audit event names now follow Backstage’s conventions (for example, lowercase, kebab-case names), and include structured metadata such as `actionType`. Legacy {product-short} event names (for example, `ScaffolderTaskCreation`, `CatalogEntityDeletion`) are no longer used. * Enhanced Log Context: Each audit event includes the plugin context, making it easier to filter logs for specific functional areas. You can filter by the event IDs or metadata associated with that plugin.
    • Removed Functionality
    • Done

      The documentation team needs to update the Red Hat Developer Hub (RHDH) documentation to reflect significant changes introduced in audit logging starting from version 1.6.

      In previous RHDH releases, audit logs were handled through a custom, internal implementation provided by RHDH itself. However, beginning with version 1.6, RHDH has adopted the Backstage Audit Log Service as its default audit logging mechanism.

      This transition introduces important changes:

      • Audit logging is now delegated to Backstage plugins. Each plugin in Backstage is responsible for implementing and emitting its own audit events.
      • Audit event names, structure, and content may differ per plugin. Unlike the centralized audit log format previously used in RHDH, audit events are now scoped and designed independently within each plugin.
      • Administrators and users must refer to each plugin’s documentation to understand available audit events. There is no longer a single list of audit events maintained by RHDH. Instead, plugins maintain and document their own audit events as part of their upstream documentation.
      • The legacy, custom audit logging implementation has been deprecated and replaced. Any tooling, queries, or expectations built around the previous audit log format will need to be reviewed and updated according to this new auditing approach.

      The documentation should:

      1. Clearly state that starting from version 1.6, RHDH uses Backstage’s Audit Log Service as its audit logging backend.
      1. Explain that audit logs are emitted by individual plugins, and the availability and details of audit events depend on each plugin’s implementation.
      1. Guide users to consult each plugin’s upstream documentation to learn more about the audit events it generates.
      1. Highlight that the names, payload structures, and triggers for audit events may have changed compared to previous versions.
      1. Clarify that the previous centralized audit log implementation is no longer available as of version 1.6.

      This documentation update is critical to help users and administrators understand how to monitor, troubleshoot, and integrate audit logs in deployments running RHDH 1.6 and above. It will also assist in setting accurate expectations around the scope and coverage of audit events across different Backstage plugins.

              rhn-support-jmagak Judith Amondi Magak
              gustavolira Gustavo Lira Silva
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: