org.jboss.logmanager.ext.formatters

Class LogstashFormatter

java.lang.Object

java.util.logging.Formatter

org.jboss.logmanager.ExtFormatter

org.jboss.logmanager.ext.formatters.StructuredFormatter

org.jboss.logmanager.ext.formatters.JsonFormatter

org.jboss.logmanager.ext.formatters.LogstashFormatter

public class LogstashFormatter
extends JsonFormatter

A JSON formatter which adds the @version to the generated JSON and overrides the timestamp key to @timestamp.

The default version is 1.

Author:

James R. Perkins

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.logmanager.ext.formatters.StructuredFormatter

StructuredFormatter.Generator, StructuredFormatter.Key

Field Summary

Fields inherited from class org.jboss.logmanager.ext.formatters.StructuredFormatter

DEFAULT_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
LogstashFormatter() Create the lostash formatter.
LogstashFormatter(Map<StructuredFormatter.Key,String> keyOverrides) Create the logstash formatter overriding any default keys

Method Summary

Modifier and Type	Method and Description
protected void	before(StructuredFormatter.Generator generator, org.jboss.logmanager.ExtLogRecord record) Invoked before the structured data is added to the generator.
int	getVersion() Returns the version being used for the @version property.
void	setVersion(int version) Sets the version to use for the @version property.

Methods inherited from class org.jboss.logmanager.ext.formatters.JsonFormatter

createGenerator, isPrettyPrint, setPrettyPrint

Methods inherited from class org.jboss.logmanager.ext.formatters.StructuredFormatter

after, format, getDateFormat, getKey, getMetaData, isAppendEndOfLine, isPrintDetails, setAppendEndOfLine, setDateFormat, setMetaData, setPrintDetails

Methods inherited from class org.jboss.logmanager.ExtFormatter

format

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Detail

LogstashFormatter

public LogstashFormatter()

Create the lostash formatter.

LogstashFormatter

public LogstashFormatter(Map<StructuredFormatter.Key,String> keyOverrides)

Create the logstash formatter overriding any default keys

Parameters:

keyOverrides - the keys used to override the defaults

Method Detail

before

protected void before(StructuredFormatter.Generator generator,
                      org.jboss.logmanager.ExtLogRecord record)
               throws Exception

Description copied from class: StructuredFormatter

Invoked before the structured data is added to the generator.

Overrides:

before in class StructuredFormatter

Parameters:

generator - the generator to use

record - the log record

Throws:

Exception

getVersion

public int getVersion()

Returns the version being used for the @version property.

Returns:

the version being used

setVersion

public void setVersion(int version)

Sets the version to use for the @version property.

Parameters:

version - the version to use