Class AbstractCompositeJsonFormatter<Event extends DeferredProcessingAware>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

Type Parameters:

Event - type of event (ILoggingEvent or IAccessEvent).

All Implemented Interfaces:

ContextAware, LifeCycle

Direct Known Subclasses:

AccessEventCompositeJsonFormatter, LoggingEventCompositeJsonFormatter

public abstract class AbstractCompositeJsonFormatter<Event extends DeferredProcessingAware>
extends ContextAwareBase
implements LifeCycle

Formats logstash Events as JSON using JsonProviders.

The AbstractCompositeJsonFormatter starts the JSON object ('{'), then delegates writing the contents of the object to the JsonProviders, and then ends the JSON object ('}').

Jackson JsonGenerator are initially created with a "disconnected" output stream so they can be reused multiple times with different target output stream.

JsonGenerator instances are *not* reused after they threw an exception. This is to prevent reusing an instance whose internal state may be unpredictable.

Author:

brenuart

Field Summary

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
AbstractCompositeJsonFormatter(ContextAware declaredOrigin)

Method Summary

Modifier and Type	Method	Description
void	addDecorator(Decorator<?> decorator)	Adds the given decorator of type MapperBuilderDecorator, TokenStreamFactoryBuilderDecorator, or JsonGeneratorDecorator.
void	addJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecoratorToAdd)
void	addMapperBuilderDecorator(MapperBuilderDecorator mapperBuilderDecoratorToAdd)
void	addTokenStreamFactoryBuilderDecorator(TokenStreamFactoryBuilderDecorator tokenStreamFactoryBuilderDecoratorToAdd)
String	getDataFormat()	Gets the name of the currently configured data format.
DataFormatFactory	getDataFormatFactory()	Gets the currently configured DataFormatFactory.
String	getEncoding()
CompositeJsonGeneratorDecorator	getJsonGeneratorDecorator()	Gets a mutable CompositeJsonGeneratorDecorator containing all the currently configured JsonGeneratorDecorators.
CompositeMapperBuilderDecorator	getMapperBuilderDecorator()	Gets a mutable CompositeMapperBuilderDecorator containing all the currently configured MapperBuilderDecorators.
JsonProviders<Event>	getProviders()
CompositeTokenStreamFactoryBuilderDecorator	getTokenStreamFactoryBuilderDecorator()	Gets a mutable CompositeTokenStreamFactoryBuilderDecorator containing all the currently configured TokenStreamFactoryBuilderDecorators.
boolean	isFindAndRegisterJacksonModules()
boolean	isStarted()
protected void	prepareForDeferredProcessing(Event event)
void	setDataFormat(String dataFormat)	Sets the dataformat to one of the build-in data formats ( "json"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, "yaml"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, "cbor"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, or "smile"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>).
void	setDataFormatFactory(DataFormatFactory dataFormatFactory)	Sets the DataFormatFactory to be used for output.
void	setEncoding(String encodingName)
void	setFindAndRegisterJacksonModules(boolean findAndRegisterJacksonModules)
void	setProviders(JsonProviders<Event> jsonProviders)
void	start()
void	stop()
void	writeEvent(Event event, OutputStream outputStream)	Write an event in the given output stream.
protected void	writeEventToGenerator(JsonGenerator generator, Event event)

Methods inherited from class ContextAwareBase

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

Methods inherited from class Object

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

Constructor Details

AbstractCompositeJsonFormatter

public AbstractCompositeJsonFormatter(ContextAware declaredOrigin)

Method Details

start

public void start()

Specified by:

start in interface LifeCycle

stop

public void stop()

Specified by:

stop in interface LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

writeEvent

public void writeEvent(Event event,
 OutputStream outputStream)
                throws IOException

Write an event in the given output stream.

Parameters:

event - the event to write

outputStream - the output stream to write the event into

Throws:

IOException - thrown upon failure to write the event

writeEventToGenerator

protected void writeEventToGenerator(JsonGenerator generator,
 Event event)
                              throws IOException

Throws:

IOException

prepareForDeferredProcessing

protected void prepareForDeferredProcessing(Event event)

getDataFormat

public String getDataFormat()

Gets the name of the currently configured data format.

Returns:

the name of the currently configured data format.

setDataFormat

public void setDataFormat(String dataFormat)

Sets the dataformat to one of the build-in data formats ( "json"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, "yaml"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, "cbor"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, or "smile"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>).

For non-JSON data formats, the appropriate Jackson data format module must be on the classpath.

To set a custom (non-builtin) data format, use setDataFormatFactory(DataFormatFactory)

Parameters:

dataFormat - "json"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, "yaml"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, "cbor"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>, or "smile"<F extends TokenStreamFactory, FB extends TSFBuilder<F,FB>, M extends ObjectMapper, MB extends MapperBuilder<M,MB>>

See Also:

• setDataFormatFactory(DataFormatFactory)

getDataFormatFactory

public DataFormatFactory getDataFormatFactory()

Gets the currently configured DataFormatFactory.

Returns:

the currently configured DataFormatFactory.

setDataFormatFactory

public void setDataFormatFactory(DataFormatFactory dataFormatFactory)

Sets the DataFormatFactory to be used for output.

For built-in formats, prefer using setDataFormat(String)

Parameters:

dataFormatFactory - the DataFormatFactory to be used for output.

addDecorator

public void addDecorator(Decorator<?> decorator)

Adds the given decorator of type MapperBuilderDecorator, TokenStreamFactoryBuilderDecorator, or JsonGeneratorDecorator.

These decorators decorate Jackson objects.

Parameters:

decorator - the decorator to add (of type MapperBuilderDecorator, TokenStreamFactoryBuilderDecorator, or JsonGeneratorDecorator)

Throws:

IllegalArgumentException - if an unsupported decorator is added

addJsonGeneratorDecorator

public void addJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecoratorToAdd)

addTokenStreamFactoryBuilderDecorator

public void addTokenStreamFactoryBuilderDecorator(TokenStreamFactoryBuilderDecorator tokenStreamFactoryBuilderDecoratorToAdd)

addMapperBuilderDecorator

public void addMapperBuilderDecorator(MapperBuilderDecorator mapperBuilderDecoratorToAdd)

getTokenStreamFactoryBuilderDecorator

public CompositeTokenStreamFactoryBuilderDecorator getTokenStreamFactoryBuilderDecorator()

Gets a mutable CompositeTokenStreamFactoryBuilderDecorator containing all the currently configured TokenStreamFactoryBuilderDecorators.

Returns:

a mutable CompositeTokenStreamFactoryBuilderDecorator containing all the currently configured TokenStreamFactoryBuilderDecorators.

getMapperBuilderDecorator

public CompositeMapperBuilderDecorator getMapperBuilderDecorator()

Gets a mutable CompositeMapperBuilderDecorator containing all the currently configured MapperBuilderDecorators.

Returns:

a mutable CompositeMapperBuilderDecorator containing all the currently configured MapperBuilderDecorators.

getJsonGeneratorDecorator

public CompositeJsonGeneratorDecorator getJsonGeneratorDecorator()

Gets a mutable CompositeJsonGeneratorDecorator containing all the currently configured JsonGeneratorDecorators.

Returns:

a mutable CompositeJsonGeneratorDecorator containing all the currently configured JsonGeneratorDecorators.

getProviders

public JsonProviders<Event> getProviders()

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encodingName)

setProviders

public void setProviders(JsonProviders<Event> jsonProviders)

isFindAndRegisterJacksonModules

public boolean isFindAndRegisterJacksonModules()

setFindAndRegisterJacksonModules

public void setFindAndRegisterJacksonModules(boolean findAndRegisterJacksonModules)