net.logstash.logback.composite

Interface JsonProvider<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>

Type Parameters:

Event - type of event (ILoggingEvent or IAccessEvent).

All Superinterfaces:

ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

All Known Implementing Classes:

AbstractFieldJsonProvider, AbstractJsonProvider, AbstractNestedJsonProvider, AbstractPatternJsonProvider, AccessEventFormattedTimestampJsonProvider, AccessEventNestedJsonProvider, AccessEventPatternJsonProvider, AccessMessageJsonProvider, ArgumentsJsonProvider, CallerDataJsonProvider, ContentLengthJsonProvider, ContextJsonProvider, ContextMapJsonProvider, ContextNameJsonProvider, ElapsedTimeJsonProvider, FormattedTimestampJsonProvider, GlobalCustomFieldsJsonProvider, HostnameJsonProvider, JsonMessageJsonProvider, LoggerNameJsonProvider, LoggingEventFormattedTimestampJsonProvider, LoggingEventNestedJsonProvider, LoggingEventPatternJsonProvider, LogLevelJsonProvider, LogLevelValueJsonProvider, LogstashMarkersJsonProvider, LogstashVersionJsonProvider, MdcJsonProvider, MessageJsonProvider, MethodJsonProvider, ProtocolJsonProvider, RawMessageJsonProvider, RemoteHostJsonProvider, RemoteUserJsonProvider, RequestedUriJsonProvider, RequestedUrlJsonProvider, RequestHeadersJsonProvider, ResponseHeadersJsonProvider, StackTraceJsonProvider, StatusCodeJsonProvider, TagsJsonProvider, ThreadNameJsonProvider

public interface JsonProvider<Event extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends ch.qos.logback.core.spi.LifeCycle, ch.qos.logback.core.spi.ContextAware

Contributes to the JSON output being written for the given Event.

Method Summary

Methods

Modifier and Type	Method and Description
void	prepareForDeferredProcessing(Event event) Gives the provider a chance to perform more deferred processing (in addition to what is already provided by DeferredProcessingAware.prepareForDeferredProcessing()).
void	writeTo(com.fasterxml.jackson.core.JsonGenerator generator, Event event) Writes information about the event, to the given generator.

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

isStarted, start, stop

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

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

Method Detail

writeTo

void writeTo(com.fasterxml.jackson.core.JsonGenerator generator,
           Event event)
             throws IOException

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.

Throws:

IOException

prepareForDeferredProcessing

void prepareForDeferredProcessing(Event event)

Gives the provider a chance to perform more deferred processing (in addition to what is already provided by DeferredProcessingAware.prepareForDeferredProcessing()).