net.logstash.logback.composite.loggingevent

Class ArgumentsJsonProvider

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

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

net.logstash.logback.composite.loggingevent.ArgumentsJsonProvider

All Implemented Interfaces:

ContextAware, FieldNamesAware<LogstashFieldNames>, JsonProvider<ILoggingEvent>

public class ArgumentsJsonProvider
extends AbstractFieldJsonProvider<ILoggingEvent>
implements FieldNamesAware<LogstashFieldNames>

Include the logging event's ILoggingEvent.getArgumentArray() in the JSON output.

Arguments that are an instance of StructuredArgument will be output as specified by StructuredArgument.writeTo(JsonGenerator).

Non-StructuredArguments will be omitted unless includeNonStructuredArguments is true. When true, they will be included in the JSON output as separate fields whose names are nonStructuredArgumentsFieldPrefix plus the argument index. (For example, "arg0").

If the fieldName is non-null, then the arguments will be written to that field as a subobject. Otherwise, the arguments are written inline.

Field Summary

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

context

Constructor Summary

Constructors

Constructor and Description
ArgumentsJsonProvider()

Method Summary

Modifier and Type	Method and Description
String	getNonStructuredArgumentsFieldPrefix()
boolean	isIncludeNonStructuredArguments()
boolean	isIncludeStructuredArguments()
void	setFieldNames(LogstashFieldNames fieldNames)
void	setIncludeNonStructuredArguments(boolean includeNonStructuredArguments)
void	setIncludeStructuredArguments(boolean includeStructuredArguments)
void	setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix)
void	writeTo(JsonGenerator generator, ILoggingEvent 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

Constructor Detail

ArgumentsJsonProvider

public ArgumentsJsonProvider()

Method Detail

writeTo

public void writeTo(JsonGenerator generator,
                    ILoggingEvent 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<ILoggingEvent>

Parameters:

generator - the JsonGenerator to produce JSON content

event - the event to convert into JSON

Throws:

IOException - if an I/O error occurs

isIncludeStructuredArguments

public boolean isIncludeStructuredArguments()

setIncludeStructuredArguments

public void setIncludeStructuredArguments(boolean includeStructuredArguments)

isIncludeNonStructuredArguments

public boolean isIncludeNonStructuredArguments()

setIncludeNonStructuredArguments

public void setIncludeNonStructuredArguments(boolean includeNonStructuredArguments)

getNonStructuredArgumentsFieldPrefix

public String getNonStructuredArgumentsFieldPrefix()

setNonStructuredArgumentsFieldPrefix

public void setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix)

setFieldNames

public void setFieldNames(LogstashFieldNames fieldNames)

Specified by:

setFieldNames in interface FieldNamesAware<LogstashFieldNames>