Package org.springframework.boot.logging

Enum Class LoggingSystemProperty

java.lang.Object
java.lang.Enum<LoggingSystemProperty>
org.springframework.boot.logging.LoggingSystemProperty
All Implemented Interfaces:
Serializable, Comparable<LoggingSystemProperty>, Constable
public enum LoggingSystemProperty extends Enum<LoggingSystemProperty>
Logging system properties that can later be used by log configuration files.
Since:
3.2.0
Author:
Phillip Webb
See Also:

  • Enum Constant Details

    • APPLICATION_NAME

      public static final LoggingSystemProperty APPLICATION_NAME
      Logging system property for the application name that should be logged.

    • APPLICATION_GROUP

      public static final LoggingSystemProperty APPLICATION_GROUP
      Logging system property for the application group that should be logged.
      Since:
      3.4.0

    • PID

      public static final LoggingSystemProperty PID
      Logging system property for the process ID.

    • LOG_FILE

      public static final LoggingSystemProperty LOG_FILE
      Logging system property for the log file.

    • LOG_PATH

      public static final LoggingSystemProperty LOG_PATH
      Logging system property for the log path.

    • CONSOLE_CHARSET

      public static final LoggingSystemProperty CONSOLE_CHARSET
      Logging system property for the console log charset.

    • FILE_CHARSET

      public static final LoggingSystemProperty FILE_CHARSET
      Logging system property for the file log charset.

    • CONSOLE_THRESHOLD

      public static final LoggingSystemProperty CONSOLE_THRESHOLD
      Logging system property for the console log.

    • FILE_THRESHOLD

      public static final LoggingSystemProperty FILE_THRESHOLD
      Logging system property for the file log.

    • EXCEPTION_CONVERSION_WORD

      public static final LoggingSystemProperty EXCEPTION_CONVERSION_WORD
      Logging system property for the exception conversion word.

    • CONSOLE_PATTERN

      public static final LoggingSystemProperty CONSOLE_PATTERN
      Logging system property for the console log pattern.

    • FILE_PATTERN

      public static final LoggingSystemProperty FILE_PATTERN
      Logging system property for the file log pattern.

    • CONSOLE_STRUCTURED_FORMAT

      public static final LoggingSystemProperty CONSOLE_STRUCTURED_FORMAT
      Logging system property for the console structured logging format.
      Since:
      3.4.0

    • FILE_STRUCTURED_FORMAT

      public static final LoggingSystemProperty FILE_STRUCTURED_FORMAT
      Logging system property for the file structured logging format.
      Since:
      3.4.0

    • LEVEL_PATTERN

      public static final LoggingSystemProperty LEVEL_PATTERN
      Logging system property for the log level pattern.

    • DATEFORMAT_PATTERN

      public static final LoggingSystemProperty DATEFORMAT_PATTERN
      Logging system property for the date-format pattern.

    • CORRELATION_PATTERN

      public static final LoggingSystemProperty CORRELATION_PATTERN
      Logging system property for the correlation pattern.

  • Method Details

    • values

      public static LoggingSystemProperty[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static LoggingSystemProperty valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getEnvironmentVariableName

      public String getEnvironmentVariableName()
      Return the name of environment variable that can be used to access this property.
      Returns:
      the environment variable name

    • getApplicationPropertyName

      public String getApplicationPropertyName()
      Return the name of the application property name that can be used to set this property.
      Returns:
      the application property name
      Since:
      3.4.0