Package org.springframework.ai.util

Class LoggingMarkers

java.lang.Object
org.springframework.ai.util.LoggingMarkers
public class LoggingMarkers extends Object
Utility class that provides predefined SLF4J Marker instances used in logging operations within the application.
This class is not intended to be instantiated, but is open for extension.
Author:
Konstantin Pavlov

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.slf4j.Marker
    PUBLIC_DATA_MARKER
    Marker used to identify log statements associated with public data, such as: Public documentation Marketing materials etc. There are no restriction for logging such information.
    static final org.slf4j.Marker
    REGULATED_DATA_MARKER
    Marker used to identify log statements associated with regulated data, such as: PCI (credit card data) PHI (health information) PII (personally identifiable info) Financial records Compliance-controlled data etc. Logging of such information should be avoided.
    static final org.slf4j.Marker
    RESTRICTED_DATA_MARKER
    Marker used to identify log statements associated with restricted data, such as: Authentication credentials Keys and secrets Core intellectual property Critical security configs Trade secrets etc. Logging of such information is usually prohibited in any circumstances.
    static final org.slf4j.Marker
    SENSITIVE_DATA_MARKER
    Marker used to identify log statements associated with sensitive data, such as: Internal business information Employee data Customer non-regulated data Business processes and logic etc. Typically, logging this information should be avoided.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LoggingMarkers()
     

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SENSITIVE_DATA_MARKER

      public static final org.slf4j.Marker SENSITIVE_DATA_MARKER
      Marker used to identify log statements associated with sensitive data, such as:
      • Internal business information
      • Employee data
      • Customer non-regulated data
      • Business processes and logic
      • etc.
      Typically, logging this information should be avoided.

    • RESTRICTED_DATA_MARKER

      public static final org.slf4j.Marker RESTRICTED_DATA_MARKER
      Marker used to identify log statements associated with restricted data, such as:
      • Authentication credentials
      • Keys and secrets
      • Core intellectual property
      • Critical security configs
      • Trade secrets
      • etc.
      Logging of such information is usually prohibited in any circumstances.

    • REGULATED_DATA_MARKER

      public static final org.slf4j.Marker REGULATED_DATA_MARKER
      Marker used to identify log statements associated with regulated data, such as:
      • PCI (credit card data)
      • PHI (health information)
      • PII (personally identifiable info)
      • Financial records
      • Compliance-controlled data
      • etc.
      Logging of such information should be avoided.

    • PUBLIC_DATA_MARKER

      public static final org.slf4j.Marker PUBLIC_DATA_MARKER
      Marker used to identify log statements associated with public data, such as:
      • Public documentation
      • Marketing materials
      • etc.
      There are no restriction for logging such information.

  • Constructor Details

    • LoggingMarkers

      public LoggingMarkers()