Uploaded image for project: 'Identity Gateway'
  1. Identity Gateway
  2. OPENIG-4895

Improve documentation to include warnings for excess logging in production

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 6.5.2, 7.0.0
    • Fix Version/s: 6.5.3, 7.0.0, 7.1.0
    • Component/s: Decorator, Doc
    • Labels:
    • Sprint:
      2020.12 - IG / Microservices
    • Story Points:
      1

      Description

      The documentation provides instructions to increase logging levels for example

       

      https://backstage.forgerock.com/docs/ig/6.5/gateway-guide/index.html#chap-logging

      https://backstage.forgerock.com/docs/ig/6.5/reference/index.html#CaptureDecorator

       

      increases in logging levels can prove helpful for debugging, however leaving log levels high in production can cause performance issues as well as consuming resources i.e. disk space.

      An example is that some customers still have this in production:

       
      {
      "name":"capture",
      "type":"CaptureDecorator",
      "config":

      { *"captureEntity":true,* *"captureContext":true* }

      }
       
      This request is to provide "production warnings" of the consequences of leaving certain flags enabled i.e. captureEntity=true.
       

       

        Attachments

          Activity

            People

            • Assignee:
              joanne.henry Joanne Henry
              Reporter:
              mark.nienaber@forgerock.com Mark Nienaber
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: