net.logstash.logback

Class LogstashFormatter

java.lang.Object

net.logstash.logback.LogstashFormatter

All Implemented Interfaces:

ch.qos.logback.core.spi.LifeCycle

public class LogstashFormatter
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ch.qos.logback.core.spi.ContextAware	contextAware
protected FieldNamesType	fieldNames The field names to use when writing the standard event fields
static String	IGNORE_FIELD_INDICATOR Field name to use in logback configuration files if you want the field to be ignored (not output).
protected static org.apache.commons.lang.time.FastDateFormat	ISO_DATETIME_TIME_ZONE_FORMAT_WITH_MILLIS

Constructor Summary

Constructors

Constructor and Description
LogstashFormatter(ch.qos.logback.core.spi.ContextAware contextAware)
LogstashFormatter(ch.qos.logback.core.spi.ContextAware contextAware, boolean includeCallerInfo)
LogstashFormatter(ch.qos.logback.core.spi.ContextAware contextAware, boolean includeCallerInfo, com.fasterxml.jackson.databind.JsonNode customFields)

Method Summary

Methods

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getCustomFields()
FieldNamesType	getFieldNames()
com.fasterxml.jackson.core.JsonFactory	getJsonFactory()
JsonFactoryDecorator	getJsonFactoryDecorator()
JsonGeneratorDecorator	getJsonGeneratorDecorator()
int	getShortenedLoggerNameLength()
boolean	isEnableContextMap() Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.
boolean	isIncludeCallerInfo()
boolean	isIncludeContext()
boolean	isIncludeMdc()
boolean	isStarted()
void	setCustomFields(com.fasterxml.jackson.databind.JsonNode customFields)
void	setCustomFieldsFromString(String customFields)
void	setEnableContextMap(boolean enableContextMap) Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.
void	setFieldNames(FieldNamesType fieldNames)
void	setIncludeCallerInfo(boolean includeCallerInfo)
void	setIncludeContext(boolean includeContext)
void	setIncludeMdc(boolean includeMdc)
void	setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)
void	setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)
void	setShortenedLoggerNameLength(int length)
void	start()
void	stop()
protected void	writeMapEntries(com.fasterxml.jackson.core.JsonGenerator generator, Map<?,?> map)
protected void	writeNumberField(com.fasterxml.jackson.core.JsonGenerator generator, String fieldName, int fieldValue) Writes the field to the generator if and only if the fieldName is not null.
protected void	writeNumberField(com.fasterxml.jackson.core.JsonGenerator generator, String fieldName, long fieldValue) Writes the field to the generator if and only if the fieldName is not null.
protected void	writeStringField(com.fasterxml.jackson.core.JsonGenerator generator, String fieldName, String fieldValue) Writes the field to the generator if and only if the fieldName and fieldValue are not null.
byte[]	writeValueAsBytes(EventType event, ch.qos.logback.core.Context context)
String	writeValueAsString(EventType event, ch.qos.logback.core.Context context)
protected void	writeValueToGenerator(com.fasterxml.jackson.core.JsonGenerator generator, ch.qos.logback.classic.spi.ILoggingEvent event, ch.qos.logback.core.Context context)
void	writeValueToOutputStream(EventType event, ch.qos.logback.core.Context context, OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Field Detail

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

ISO_DATETIME_TIME_ZONE_FORMAT_WITH_MILLIS

protected static final org.apache.commons.lang.time.FastDateFormat ISO_DATETIME_TIME_ZONE_FORMAT_WITH_MILLIS

fieldNames

protected FieldNamesType extends LogstashCommonFieldNames fieldNames

The field names to use when writing the standard event fields

contextAware

protected final ch.qos.logback.core.spi.ContextAware contextAware

Constructor Detail

LogstashFormatter

public LogstashFormatter(ch.qos.logback.core.spi.ContextAware contextAware)

LogstashFormatter

public LogstashFormatter(ch.qos.logback.core.spi.ContextAware contextAware,
                 boolean includeCallerInfo)

LogstashFormatter

public LogstashFormatter(ch.qos.logback.core.spi.ContextAware contextAware,
                 boolean includeCallerInfo,
                 com.fasterxml.jackson.databind.JsonNode customFields)

Method Detail

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

writeValueToGenerator

protected void writeValueToGenerator(com.fasterxml.jackson.core.JsonGenerator generator,
                         ch.qos.logback.classic.spi.ILoggingEvent event,
                         ch.qos.logback.core.Context context)
                              throws IOException

Throws:

IOException

isIncludeCallerInfo

public boolean isIncludeCallerInfo()

setIncludeCallerInfo

public void setIncludeCallerInfo(boolean includeCallerInfo)

setCustomFieldsFromString

public void setCustomFieldsFromString(String customFields)

setCustomFields

public void setCustomFields(com.fasterxml.jackson.databind.JsonNode customFields)

getCustomFields

public com.fasterxml.jackson.databind.JsonNode getCustomFields()

getShortenedLoggerNameLength

public int getShortenedLoggerNameLength()

setShortenedLoggerNameLength

public void setShortenedLoggerNameLength(int length)

isIncludeMdc

public boolean isIncludeMdc()

setIncludeMdc

public void setIncludeMdc(boolean includeMdc)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

isEnableContextMap

@Deprecated
public boolean isEnableContextMap()

Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.

setEnableContextMap

@Deprecated
public void setEnableContextMap(boolean enableContextMap)

Deprecated. When logging, prefer using a Markers.appendEntries(Map) marker instead.

stop

public void stop()

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ch.qos.logback.core.spi.LifeCycle

getJsonFactory

public com.fasterxml.jackson.core.JsonFactory getJsonFactory()

writeValueAsBytes

public byte[] writeValueAsBytes(EventType event,
                       ch.qos.logback.core.Context context)
                         throws IOException

Throws:

IOException

writeValueToOutputStream

public void writeValueToOutputStream(EventType event,
                            ch.qos.logback.core.Context context,
                            OutputStream outputStream)
                              throws IOException

Throws:

IOException

writeValueAsString

public String writeValueAsString(EventType event,
                        ch.qos.logback.core.Context context)
                          throws IOException

Throws:

IOException

writeMapEntries

protected void writeMapEntries(com.fasterxml.jackson.core.JsonGenerator generator,
                   Map<?,?> map)
                        throws IOException,
                               com.fasterxml.jackson.databind.JsonMappingException

Throws:

IOException

com.fasterxml.jackson.databind.JsonMappingException

writeStringField

protected void writeStringField(com.fasterxml.jackson.core.JsonGenerator generator,
                    String fieldName,
                    String fieldValue)
                         throws IOException

Writes the field to the generator if and only if the fieldName and fieldValue are not null.

Throws:

IOException

writeNumberField

protected void writeNumberField(com.fasterxml.jackson.core.JsonGenerator generator,
                    String fieldName,
                    int fieldValue)
                         throws IOException

Writes the field to the generator if and only if the fieldName is not null.

Throws:

IOException

writeNumberField

protected void writeNumberField(com.fasterxml.jackson.core.JsonGenerator generator,
                    String fieldName,
                    long fieldValue)
                         throws IOException

Writes the field to the generator if and only if the fieldName is not null.

Throws:

IOException

getFieldNames

public FieldNamesType getFieldNames()

setFieldNames

public void setFieldNames(FieldNamesType fieldNames)

getJsonFactoryDecorator

public JsonFactoryDecorator getJsonFactoryDecorator()

setJsonFactoryDecorator

public void setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)

getJsonGeneratorDecorator

public JsonGeneratorDecorator getJsonGeneratorDecorator()

setJsonGeneratorDecorator

public void setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)