net.logstash.logback.composite

Class AbstractFormattedTimestampJsonProvider<Event extends DeferredProcessingAware,FieldNames extends LogstashCommonFieldNames>

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.AbstractFormattedTimestampJsonProvider<Event,FieldNames>

All Implemented Interfaces:

ContextAware, FieldNamesAware<FieldNames>, JsonProvider<Event>

Direct Known Subclasses:

AccessEventFormattedTimestampJsonProvider, FormattedTimestampJsonProvider, LoggingEventFormattedTimestampJsonProvider

public abstract class AbstractFormattedTimestampJsonProvider<Event extends DeferredProcessingAware,FieldNames extends LogstashCommonFieldNames>
extends AbstractFieldJsonProvider<Event>
implements FieldNamesAware<FieldNames>

Writes the timestamp field as either:

• A string value formatted by a DateTimeFormatter pattern
• A string value representing the number of milliseconds since unix epoch (designated by specifying the pattern value as "[UNIX_TIMESTAMP_AS_STRING]")
• A number value of the milliseconds since unix epoch (designated by specifying the pattern value as "[UNIX_TIMESTAMP_AS_NUMBER]")

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TIMEZONE_KEYWORD Keyword used by setTimeZone(String) to denote the system default time zone.
static String	FIELD_TIMESTAMP
static String	UNIX_TIMESTAMP_AS_NUMBER Setting the pattern as this value will make it so that the timestamp is written as a number value of the milliseconds since unix epoch.
static String	UNIX_TIMESTAMP_AS_STRING Setting the pattern as this value will make it so that the timestamp is written as a string value representing the number of milliseconds since unix epoch

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

context

Constructor Summary

Constructors

Constructor and Description
AbstractFormattedTimestampJsonProvider()

Method Summary

Modifier and Type	Method and Description
protected String	getFormattedTimestamp(Event event)
String	getPattern()
protected abstract long	getTimestampAsMillis(Event event)
String	getTimeZone() Get the time zone used to write the timestamp.
void	setFieldNames(FieldNames fieldNames)
void	setPattern(String pattern)
void	setTimeZone(String timeZone) Set the timezone for which to write the timestamp.
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_TIMESTAMP

public static final String FIELD_TIMESTAMP

See Also:

Constant Field Values

UNIX_TIMESTAMP_AS_NUMBER

public static final String UNIX_TIMESTAMP_AS_NUMBER

Setting the pattern as this value will make it so that the timestamp is written as a number value of the milliseconds since unix epoch.

See Also:

Constant Field Values

UNIX_TIMESTAMP_AS_STRING

public static final String UNIX_TIMESTAMP_AS_STRING

Setting the pattern as this value will make it so that the timestamp is written as a string value representing the number of milliseconds since unix epoch

See Also:

Constant Field Values

DEFAULT_TIMEZONE_KEYWORD

public static final String DEFAULT_TIMEZONE_KEYWORD

Keyword used by setTimeZone(String) to denote the system default time zone.

See Also:

Constant Field Values

Constructor Detail

AbstractFormattedTimestampJsonProvider

public AbstractFormattedTimestampJsonProvider()

Method Detail

setFieldNames

public void setFieldNames(FieldNames fieldNames)

Specified by:

setFieldNames in interface FieldNamesAware<FieldNames extends LogstashCommonFieldNames>

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

getFormattedTimestamp

protected String getFormattedTimestamp(Event event)

getTimestampAsMillis

protected abstract long getTimestampAsMillis(Event event)

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

getTimeZone

public String getTimeZone()

Get the time zone used to write the timestamp.

Returns:

the time zone used to write the timestamp

setTimeZone

public void setTimeZone(String timeZone)

Set the timezone for which to write the timestamp. Only applicable if the pattern is not "[UNIX_TIMESTAMP_AS_NUMBER]" or "[UNIX_TIMESTAMP_AS_STRING]".

The value of the timeZone can be any string accepted by java's TimeZone.getTimeZone(String) method. For example "America/Los_Angeles" or "GMT+10".

Use a blank string, null or the value "[DEFAULT]" to use the default TimeZone of the system.

Parameters:

timeZone - the textual representation of the desired time zone

Throws:

IllegalArgumentException - if the input string is not a valid TimeZone representation