net.logstash.logback.composite

Class LogstashVersionJsonProvider<Event extends DeferredProcessingAware>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

net.logstash.logback.composite.AbstractJsonProvider<Event>

net.logstash.logback.composite.AbstractFieldJsonProvider<Event>

net.logstash.logback.composite.LogstashVersionJsonProvider<Event>

Type Parameters:

Event - type of event (ILoggingEvent or IAccessEvent).

All Implemented Interfaces:

ContextAware, FieldNamesAware<LogstashCommonFieldNames>, JsonProvider<Event>

public class LogstashVersionJsonProvider<Event extends DeferredProcessingAware>
extends AbstractFieldJsonProvider<Event>
implements FieldNamesAware<LogstashCommonFieldNames>

Writes a version field as a string value (by default) or a numeric value (if isWriteAsInteger() is true). This is intended to be the logstash JSON format version. By default, the version is "1".

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION
static String	FIELD_VERSION

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
LogstashVersionJsonProvider()

Method Summary

Modifier and Type	Method and Description
String	getVersion()
boolean	isWriteAsInteger()
void	setFieldNames(LogstashCommonFieldNames fieldNames)
void	setVersion(String version)
void	setWriteAsInteger(boolean writeAsInteger)
void	writeTo(JsonGenerator generator, Event event) Writes information about the event, to the given generator.

Methods inherited from class net.logstash.logback.composite.AbstractFieldJsonProvider

getFieldName, setFieldName

Methods inherited from class net.logstash.logback.composite.AbstractJsonProvider

isStarted, prepareForDeferredProcessing, start, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

FIELD_VERSION

public static final String FIELD_VERSION

See Also:

Constant Field Values

DEFAULT_VERSION

public static final String DEFAULT_VERSION

See Also:

Constant Field Values

Constructor Detail

LogstashVersionJsonProvider

public LogstashVersionJsonProvider()

Method Detail

writeTo

public void writeTo(JsonGenerator generator,
                    Event event)
             throws IOException

Description copied from interface: JsonProvider

Writes information about the event, to the given generator.

When called, the generator is assumed to be within a JSON object context (i.e. this provider should write fields and their values to the generator). Upon return, the generator should be within the same JSON object context.

Specified by:

writeTo in interface JsonProvider<Event extends DeferredProcessingAware>

Parameters:

generator - the JsonGenerator to produce JSON content

event - the event to convert into JSON

Throws:

IOException - if an I/O error occurs

setFieldNames

public void setFieldNames(LogstashCommonFieldNames fieldNames)

Specified by:

setFieldNames in interface FieldNamesAware<LogstashCommonFieldNames>

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

isWriteAsInteger

public boolean isWriteAsInteger()

setWriteAsInteger

public void setWriteAsInteger(boolean writeAsInteger)