net.logstash.logback

Class LogstashAccessFormatter

java.lang.Object

net.logstash.logback.LogstashAccessFormatter

All Implemented Interfaces:

ch.qos.logback.core.spi.LifeCycle

public class LogstashAccessFormatter
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
protected org.apache.commons.lang.time.FastDateFormat	isoDateTimeTimeZoneFormatWithMillis Used to format timestamps.

Constructor Summary

Constructors

Constructor and Description
LogstashAccessFormatter(ch.qos.logback.core.spi.ContextAware contextAware)

Method Summary

Methods

Modifier and Type	Method and Description
FieldNamesType	getFieldNames()
com.fasterxml.jackson.core.JsonFactory	getJsonFactory()
JsonFactoryDecorator	getJsonFactoryDecorator()
JsonGeneratorDecorator	getJsonGeneratorDecorator()
String	getTimeZone()
boolean	isStarted()
void	setFieldNames(FieldNamesType fieldNames)
void	setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)
void	setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)
void	setTimeZone(String timeZoneId)
void	start()
void	stop()
protected void	writeMapEntries(com.fasterxml.jackson.core.JsonGenerator generator, Map<?,?> map)
protected void	writeMapStringFields(com.fasterxml.jackson.core.JsonGenerator generator, String fieldName, Map<String,String> map) Writes a map as String fields to the generator if and only if the fieldName and values are not null.
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.access.spi.IAccessEvent 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

fieldNames

protected FieldNamesType extends LogstashCommonFieldNames fieldNames

The field names to use when writing the standard event fields

isoDateTimeTimeZoneFormatWithMillis

protected org.apache.commons.lang.time.FastDateFormat isoDateTimeTimeZoneFormatWithMillis

Used to format timestamps.

contextAware

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

Constructor Detail

LogstashAccessFormatter

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

Method Detail

writeValueToGenerator

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

Throws:

IOException

start

public void start()

Specified by:

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

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

writeMapStringFields

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

Writes a map as String fields to the generator if and only if the fieldName and values are not null.

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)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)