Package org.logevents.formatters

Class JsonLogEventFormatter

java.lang.Object

org.logevents.formatters.JsonLogEventFormatter

All Implemented Interfaces:

Function<LogEvent,String>, LogEventFormatter

Direct Known Subclasses:

ConsoleJsonLogEventFormatter

public class JsonLogEventFormatter
extends Object
implements LogEventFormatter

Used to format a LogEvent as JSON for stdout or network observers. Example configuration:

 observer.foo.formatter=JsonLogEventFormatter
 observer.foo.formatter.excludedMdcKeys=secret,ipAddress
 observer.foo.formatter.properties.environment=staging
 

Author:

Johannes Brodwall

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	additionalProperties
protected ExceptionFormatter	exceptionFormatter
protected MdcFilter	mdcFilter
protected MessageFormatter	messageFormatter

Constructor Summary

Constructors

Constructor	Description
JsonLogEventFormatter()
JsonLogEventFormatter(Map<String,String> properties, String prefix)
JsonLogEventFormatter(Configuration configuration)

Method Summary

Modifier and Type	Method	Description
String	apply(LogEvent e)
void	configure(Configuration configuration)	reads applicationName, nodeName, messageFormatter, mdcFilter, dateTimeFormat and properties
static Map<String,Object>	toJsonObject(Throwable throwable, ExceptionFormatter exceptionFormatter)
protected Map<String,String>	toJsonObject(List<org.slf4j.event.KeyValuePair> keyValuePairs)
Map<String,Object>	toJsonObject(LogEvent event)
String	toString()
protected void	writeJsonObject(LogEvent event, Map<String,Object> payload)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.logevents.LogEventFormatter

getExceptionFormatter

Field Detail

messageFormatter

protected MessageFormatter messageFormatter

exceptionFormatter

protected ExceptionFormatter exceptionFormatter

mdcFilter

protected MdcFilter mdcFilter

additionalProperties

protected final Map<String,String> additionalProperties

Constructor Detail

JsonLogEventFormatter

public JsonLogEventFormatter()

JsonLogEventFormatter

public JsonLogEventFormatter(Map<String,String> properties,
                             String prefix)

JsonLogEventFormatter

public JsonLogEventFormatter(Configuration configuration)

Method Detail

configure

public void configure(Configuration configuration)

reads applicationName, nodeName, messageFormatter, mdcFilter, dateTimeFormat and properties

Specified by:

configure in interface LogEventFormatter

apply

public String apply(LogEvent e)

Specified by:

apply in interface Function<LogEvent,String>

Specified by:

apply in interface LogEventFormatter

toJsonObject

public Map<String,Object> toJsonObject(LogEvent event)

writeJsonObject

protected void writeJsonObject(LogEvent event,
                               Map<String,Object> payload)

toJsonObject

protected final Map<String,String> toJsonObject(List<org.slf4j.event.KeyValuePair> keyValuePairs)

toJsonObject

public static Map<String,Object> toJsonObject(Throwable throwable,
                                                    ExceptionFormatter exceptionFormatter)

toString

public String toString()

Overrides:

toString in class Object