LoggingSystemProperties (Spring Boot 2.3.12.RELEASE API)

java.lang.Object
- org.springframework.boot.logging.LoggingSystemProperties

```
public class LoggingSystemProperties
extends Object
```
Utility to set system properties that can later be used by log configuration files.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb, Madhura Bhave, Vedran Pavic, Robert Thornton, Eddú Meléndez

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONSOLE_LOG_PATTERN` The name of the System property that contains the console log pattern.
`static String`	`EXCEPTION_CONVERSION_WORD` The name of the System property that contains the exception conversion word.
`static String`	`FILE_CLEAN_HISTORY_ON_START` The name of the System property that contains the clean history on start flag.
`static String`	`FILE_LOG_PATTERN` The name of the System property that contains the file log pattern.
`static String`	`FILE_MAX_HISTORY` The name of the System property that contains the file log max history.
`static String`	`FILE_MAX_SIZE` The name of the System property that contains the file log max size.
`static String`	`FILE_TOTAL_SIZE_CAP` The name of the System property that contains the file total size cap.
`static String`	`LOG_DATEFORMAT_PATTERN` The name of the System property that contains the log date-format pattern.
`static String`	`LOG_FILE` The name of the System property that contains the log file.
`static String`	`LOG_LEVEL_PATTERN` The name of the System property that contains the log level pattern.
`static String`	`LOG_PATH` The name of the System property that contains the log path.
`static String`	`PID_KEY` The name of the System property that contains the process ID.
`static String`	`ROLLING_FILE_NAME_PATTERN` The name of the System property that contains the rolled-over log file name pattern.

Constructor Summary

Constructors
Constructor and Description

LoggingSystemProperties(Environment environment)
Create a new LoggingSystemProperties instance.

Constructors
Constructor and Description
`LoggingSystemProperties(Environment environment)` Create a new `LoggingSystemProperties` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

void apply()

void apply(LogFile logFile)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply()`
`void`	`apply(LogFile logFile)`

- Field Detail
  - PID_KEY
```
public static final String PID_KEY
```
    The name of the System property that contains the process ID.
    
    See Also:
    
    Constant Field Values
  - EXCEPTION_CONVERSION_WORD
```
public static final String EXCEPTION_CONVERSION_WORD
```
    The name of the System property that contains the exception conversion word.
    
    See Also:
    
    Constant Field Values
  - LOG_FILE
```
public static final String LOG_FILE
```
    The name of the System property that contains the log file.
    
    See Also:
    
    Constant Field Values
  - LOG_PATH
```
public static final String LOG_PATH
```
    The name of the System property that contains the log path.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_LOG_PATTERN
```
public static final String CONSOLE_LOG_PATTERN
```
    The name of the System property that contains the console log pattern.
    
    See Also:
    
    Constant Field Values
  - FILE_CLEAN_HISTORY_ON_START
```
public static final String FILE_CLEAN_HISTORY_ON_START
```
    The name of the System property that contains the clean history on start flag.
    
    See Also:
    
    Constant Field Values
  - FILE_LOG_PATTERN
```
public static final String FILE_LOG_PATTERN
```
    The name of the System property that contains the file log pattern.
    
    See Also:
    
    Constant Field Values
  - FILE_MAX_HISTORY
```
public static final String FILE_MAX_HISTORY
```
    The name of the System property that contains the file log max history.
    
    See Also:
    
    Constant Field Values
  - FILE_MAX_SIZE
```
public static final String FILE_MAX_SIZE
```
    The name of the System property that contains the file log max size.
    
    See Also:
    
    Constant Field Values
  - FILE_TOTAL_SIZE_CAP
```
public static final String FILE_TOTAL_SIZE_CAP
```
    The name of the System property that contains the file total size cap.
    
    See Also:
    
    Constant Field Values
  - LOG_LEVEL_PATTERN
```
public static final String LOG_LEVEL_PATTERN
```
    The name of the System property that contains the log level pattern.
    
    See Also:
    
    Constant Field Values
  - LOG_DATEFORMAT_PATTERN
```
public static final String LOG_DATEFORMAT_PATTERN
```
    The name of the System property that contains the log date-format pattern.
    
    See Also:
    
    Constant Field Values
  - ROLLING_FILE_NAME_PATTERN
```
public static final String ROLLING_FILE_NAME_PATTERN
```
    The name of the System property that contains the rolled-over log file name pattern.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LoggingSystemProperties
```
public LoggingSystemProperties(Environment environment)
```
    Create a new LoggingSystemProperties instance.
    
    Parameters:
    
    environment - the source environment
- Method Detail
  - apply
```
public void apply()
```
  - apply
```
public void apply(LogFile logFile)
```

Class LoggingSystemProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PID_KEY

EXCEPTION_CONVERSION_WORD

LOG_FILE

LOG_PATH

CONSOLE_LOG_PATTERN

FILE_CLEAN_HISTORY_ON_START

FILE_LOG_PATTERN

FILE_MAX_HISTORY

FILE_MAX_SIZE

FILE_TOTAL_SIZE_CAP

LOG_LEVEL_PATTERN

LOG_DATEFORMAT_PATTERN

ROLLING_FILE_NAME_PATTERN

Constructor Detail

LoggingSystemProperties

Method Detail

apply

apply