Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-3125

Surfacing Catalog Processing Errors to Users

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • Surface Catalog Processing Errors
    • False
    • Hide

      None

      Show
      None
    • False
    • RHIDP-3123Improve RHDH serviceability
    • To Do
    • RHIDP-3123 - Improve RHDH serviceability
    • QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
    • 0% To Do, 0% In Progress, 100% Done
    • With this update, the `@backstage/plugin-catalog-backend-module-logs` plugin has been made available as a dynamic plugin to help surface catalog errors into the logs. This dynamic plugin is disabled by default.
    • Enhancement
    • Done

      EPIC Goal

      We want to surface catalog ingestion/processing/stitching errors to end users so they can self-service their RHDH instances

      Background/Feature Origin

      Why is this important?

      Currently all catalog ingesting/processing/stitching are not surfaced to the user outside of expected catalog entities not appearing in the catalog which makes self service/debugging difficult for both the users and support team.

      User Scenarios

      User registers a catalog entity into the catalog, but it does not appear. Users would not know why it's not appearing in the catalog. 

      At the current moment in RHDH 1.2.1, the users would only see failures in the application logs for stitching if they enable the `LOG_LEVEL=debug` (which would require a pod restart if it was not already set). However, these failures are generic logs mentioning that the stitching failed and does not disclose the cause of the failure.

      Users would need to directly query the RHDH database for this information.

      Dependencies (internal and external)

      Acceptance Criteria

      • Catalog ingestion/processing/stitching related errors are surfaced to the user via an endpoint and in the UI in RHDH

      Release Enablement/Demo - Provide necessary release enablement details
      and documents

      DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Upstream documentation merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Downstream build attached to advisory: <link to errata>

      QE - Test plans in Playwright: <link or reference to playwright>

      QE - Automated tests merged: <link or reference to automated tests>

      DOC - Downstream documentation merged: <link to meaningful PR>

              rh-ee-frkong Frank Kong (Inactive)
              rh-ee-frkong Frank Kong (Inactive)
              RHIDP - Core Platform
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: