Uploaded image for project: 'Insights Experiences'
  1. Insights Experiences
  2. HMS-4259

DJ-IDM: logging best practices

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • Identity Management
    • None
    • DJ-IDM: Logging
    • 0% To Do, 0% In Progress, 100% Done
    • False

      Goal:

      • Update idmsvc-backend to align to ADR-013 and platform logging best practices.
      • Display request-id or other additional values in the frontend console, so we enhance the issue tracking along the different components.
      • Update ipa-hcc to show request-id or other additional values in the log, so we enhance the issue tracking along the different components.

      Acceptance Criteria:

      • Given an http action,
        When the operator see the logs for idmsvc-backend
        Then it provides the required field to accomplish logging best practices and ADR-013.
      • Given an http action,
        When the operator see the logs for the idmsvc-frontend
        Then it provides the required field to track the message at clowdwatch.
      • Given an http action,
        When the operator see the logs for the ipa-hcc,
        Then it provides the required fields to track the message at clowdwatch.
      • Given an http action,
        When the mock-rbac is invoked,
        Then it provides the required fields to track the message at idmsvc-backend.

      Open questions:

      • What context information should we include?:
        • for the backend:
          • org-id: for every log message.
          • request-id: for every log message, the other only for the middleware logger.
          • principal:
        • for the frontend: TBD
        • for ipa-hcc:
          • request-id returned ? It is returned the X-Rh-Insights-Request-ID header.

            Unassigned Unassigned
            avisiedo@redhat.com Alejandro Visiedo
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: