Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-6668

Enable JSON logging option for all GitOps components

XMLWordPrintable

    • Enable JSON logging option for all GitOps components
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      Before this update the logFormat field in the ArgoCD CR enabled JSON logging for a limited set of components, the API server, repo server, and application controller. Other components, such as the ApplicationSet controller and Notifications controller, did not support this option.

      With this update support for the logFormat field has been extended to the ApplicationSet controller and the Notifications controller. This allows these components to produce logs in JSON format.

      JSON logging remains disabled by default, and users must explicitly set `logFormat: json` in the ArgoCD CR for each supported component.

      Note: Redis and Dex do not support configurable JSON logging and are not affected by this change.
      Show
      Before this update the logFormat field in the ArgoCD CR enabled JSON logging for a limited set of components, the API server, repo server, and application controller. Other components, such as the ApplicationSet controller and Notifications controller, did not support this option. With this update support for the logFormat field has been extended to the ApplicationSet controller and the Notifications controller. This allows these components to produce logs in JSON format. JSON logging remains disabled by default, and users must explicitly set `logFormat: json` in the ArgoCD CR for each supported component. Note: Redis and Dex do not support configurable JSON logging and are not affected by this change.

      Epic Goal

      Parent RFE: https://issues.redhat.com/browse/RFE-4607

      As noted in the parent RFE, we currently, we have the option to enable JSON logging in the ArgoCD CR through the `logFormat` option for the following components:

      • server
      • repo
      • controller

      But this option is missing for the other controllers that are a part of Argo CD. All the pods should be able to output both formats consistently. We should add JSON logging to the ArgoCD CR for the remaining components, and ensure that the new fields are wired to enable JSON Logging

      JSON logging should remain as NOT the default for these components.

      From my quick search, it appears to be missing from at least these:

      • Application set controller
      • ArgoCD Notification controlelr
      • Redis (does this allow json logging?)
      • Dex (does this allow json logging?)
      • Any others I'm missing?

      Some investigation will be needed to verify that: A) JSON logging can be enabled for all of the above items and B) that aren't any other components we need to enable missing from the list.

      Definition of Ready

      • The epic has been broken down into stories.
      • Stories have been scoped.
      • The epic has been stack ranked.

      Definition of Done

      • Code Complete:
        • All code has been written, reviewed, and approved.
      • Tested:
        • Unit tests have been written and passed.
        • Integration tests have been completed.
        • System tests have been conducted, and all critical bugs have been fixed.
        • Tested on OpenShift either upstream or downstream on a local build.
      • Documentation:
        • User documentation or release notes have been written.
      • Build:
        • Code has been successfully built and integrated into the main repository / project.
      • Review:
        • Code has been peer-reviewed and meets coding standards.
        • All acceptance criteria defined in the user story have been met.
        • Tested by reviewer on OpenShift.
      • Deployment:
        • The feature has been deployed on OpenShift cluster for testing.
      • Acceptance:
        • Product Manager or stakeholder has reviewed and accepted the work.

              rh-ee-rnaaz Rizwana Naaz
              jgwest Jonathan West
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: