Package org.springframework.boot.logging.structured

Enum Class CommonStructuredLogFormat

java.lang.Object

java.lang.Enum<CommonStructuredLogFormat>

org.springframework.boot.logging.structured.CommonStructuredLogFormat

All Implemented Interfaces:

Serializable, Comparable<CommonStructuredLogFormat>, Constable

public enum CommonStructuredLogFormat
extends Enum<CommonStructuredLogFormat>

Common structured log formats supported by Spring Boot.

Since:

3.4.0

Author:

Moritz Halbritter, Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ELASTIC_COMMON_SCHEMA	Elasic Common Schema (ECS) log format.
GRAYLOG_EXTENDED_LOG_FORMAT	Graylog Extended Log Format (GELF) log format.
LOGSTASH	The Logstash log format.

Method Summary

Modifier and Type	Method	Description
static CommonStructuredLogFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommonStructuredLogFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ELASTIC_COMMON_SCHEMA

public static final CommonStructuredLogFormat ELASTIC_COMMON_SCHEMA

Elasic Common Schema (ECS) log format.

GRAYLOG_EXTENDED_LOG_FORMAT

public static final CommonStructuredLogFormat GRAYLOG_EXTENDED_LOG_FORMAT

Graylog Extended Log Format (GELF) log format.

LOGSTASH

public static final CommonStructuredLogFormat LOGSTASH

The Logstash log format.

Method Details

values

public static CommonStructuredLogFormat[] 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 CommonStructuredLogFormat 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