Package net.logstash.logback.fieldnames

Class LogstashCommonFieldNames

java.lang.Object

net.logstash.logback.fieldnames.LogstashCommonFieldNames

Direct Known Subclasses:

LogstashAccessFieldNames, LogstashFieldNames

public abstract class LogstashCommonFieldNames
extends Object

Common field names between the regular LogstashFormatter and the LogstashAccessFormatter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IGNORE_FIELD_INDICATOR	Field name to use in logback configuration files if you want the field to be ignored (not output).

Constructor Summary

Constructors

Constructor	Description
LogstashCommonFieldNames()

Method Summary

Modifier and Type	Method	Description
String	getContext()	The name of the context object field.
String	getMessage()
String	getThread()
String	getTimestamp()
String	getUuid()
String	getVersion()
void	setContext(String context)
void	setMessage(String message)
void	setThread(String thread)
void	setTimestamp(String timestamp)
void	setUuid(String uuid)
void	setVersion(String version)

Methods inherited from class java.lang.Object

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

Field Details

IGNORE_FIELD_INDICATOR

public static final String IGNORE_FIELD_INDICATOR

Field name to use in logback configuration files if you want the field to be ignored (not output). Unfortunately, logback does not provide a way to set a field value to null via xml config, so we have to fall back to using this magic string. Note that if you're programmatically configuring the field names, then you can just set the field name to null in the FieldNamesType.

See Also:

• Constant Field Values

Constructor Details

LogstashCommonFieldNames

public LogstashCommonFieldNames()

Method Details

getTimestamp

public String getTimestamp()

setTimestamp

public void setTimestamp(String timestamp)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getContext

public String getContext()

The name of the context object field.

If this returns null, then the context fields will be written inline at the root level of the JSON event output (e.g. as a sibling to all the other fields in this class).

If this returns non-null, then the context fields will be written inside an object with field name returned by this method.

Returns:

The name of the context object field.

setContext

public void setContext(String context)

getThread

public String getThread()

setThread

public void setThread(String thread)

getUuid

public String getUuid()

setUuid

public void setUuid(String uuid)