Uploaded image for project: 'OpenIDM'
  1. OpenIDM
  2. OPENIDM-15152

Docs: add SanitizedThreadIdLogFormatter to monitoring guide

    Details

    • Type: Story
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 7.0.0
    • Component/s: documentation
    • Labels:
      None
    • Target Version/s:
    • Verified Version/s:
    • Story Points:
      0.5
    • Sprint:
      2020.10 - IDM

      Description

      In OPENIDM-15100 the default console and file logger was changed to SanitizedThreadIdLogFormatter and we need the Monitoring Guide updated to illustrate that, and mention the alternative of using ThreadIdLogFormatter.

      The SanitizedThreadIdLogFormatter encodes all control characters (e.g., newline) in "log messages" using URL encoding. The stacktraces are not affected by this.

      conf/logging.properties :

      # Use org.forgerock.openidm.logger.ThreadIdLogFormatter to turn off log-injection sanitation
      java.util.logging.ConsoleHandler.formatter = org.forgerock.openidm.logger.SanitizedThreadIdLogFormatter
      
      ...
      
      # Use org.forgerock.openidm.logger.ThreadIdLogFormatter to turn off log-injection sanitation
      java.util.logging.FileHandler.formatter = org.forgerock.openidm.logger.SanitizedThreadIdLogFormatter
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Lana Lana Frost
                Reporter:
                travis.haagen Travis Haagen
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: