Class StructuredFormatter
- Direct Known Subclasses:
JsonFormatter
,XmlFormatter
record
.
Note that including details can be expensive in terms of calculating the caller.
By default the record delimiter is set to \n
.
- Author:
- James R. Perkins
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Defines the way a cause will be formatted.protected static interface
A generator used to create the structured output.static enum
The key used for the structured log record data. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
protected
StructuredFormatter
(String keyOverrides) protected
StructuredFormatter
(Map<StructuredFormatter.Key, String> keyOverrides) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
after
(StructuredFormatter.Generator generator, ExtLogRecord record) Invoked after the structured data has been added to the generator.protected void
before
(StructuredFormatter.Generator generator, ExtLogRecord record) Invoked before the structured data is added to the generator.protected abstract StructuredFormatter.Generator
createGenerator
(Writer writer) Creates the generator used to create the structured data.final String
format
(ExtLogRecord record) Format a message using an extended log record.Returns the current formatter used to format a records date and time.Get the current output type for exceptions.protected final String
getKey
(StructuredFormatter.Key defaultKey) Checks to see if the key should be overridden.A string representation of the key overrides.Returns the value set for meta data.Returns the character used to indicate the record has is complete.Returns the current zone id used for the date and time formatter.boolean
Determines whether or not this formatter will require caller, source level, information when a log record is formatted.protected boolean
Checks the exception output type and determines if detailed output should be written.protected boolean
Checks the exception output type and determines if formatted output should be written.boolean
Indicates whether or not details should be printed.void
setDateFormat
(String pattern) Sets the pattern to use when formatting the date.void
setExceptionOutputType
(StructuredFormatter.ExceptionOutputType exceptionOutputType) Set the output type for exceptions.void
setMetaData
(String metaData) Sets the meta data to use in the structured format.void
setPrintDetails
(boolean printDetails) Sets whether or not details should be printed.void
setRecordDelimiter
(String eorDelimiter) Sets the value to be used to indicate the end of a record.void
Methods inherited from class org.jboss.logmanager.ExtFormatter
format
Methods inherited from class java.util.logging.Formatter
formatMessage, getHead, getTail
-
Constructor Details
-
StructuredFormatter
protected StructuredFormatter() -
StructuredFormatter
-
StructuredFormatter
-
-
Method Details
-
createGenerator
Creates the generator used to create the structured data.- Returns:
- the generator to use
- Throws:
Exception
- if an error occurs creating the generator
-
before
protected void before(StructuredFormatter.Generator generator, ExtLogRecord record) throws Exception Invoked before the structured data is added to the generator.- Parameters:
generator
- the generator to userecord
- the log record- Throws:
Exception
-
after
Invoked after the structured data has been added to the generator.- Parameters:
generator
- the generator to userecord
- the log record- Throws:
Exception
-
getKey
Checks to see if the key should be overridden.- Parameters:
defaultKey
- the default key- Returns:
- the overridden key or the default key if no override exists
-
format
Description copied from class:ExtFormatter
Format a message using an extended log record.- Specified by:
format
in classExtFormatter
- Parameters:
record
- the log record- Returns:
- the formatted message
-
isCallerCalculationRequired
public boolean isCallerCalculationRequired()Description copied from class:ExtFormatter
Determines whether or not this formatter will require caller, source level, information when a log record is formatted.- Overrides:
isCallerCalculationRequired
in classExtFormatter
- Returns:
true
if the formatter will need caller information, otherwisefalse
- See Also:
-
getKeyOverrides
A string representation of the key overrides. The default isnull
.- Returns:
- a string representation of the key overrides or
null
if no overrides were configured
-
getRecordDelimiter
Returns the character used to indicate the record has is complete. This defaults to\n
and may benull
if no end of record character is desired.- Returns:
- the end of record delimiter or
null
if no delimiter is desired
-
setRecordDelimiter
Sets the value to be used to indicate the end of a record. If set tonull
no delimiter will be used at the end of the record.- Parameters:
eorDelimiter
- the delimiter to be used ornull
to not use a delimiter
-
getMetaData
Returns the value set for meta data.The value is a string where key/value pairs are separated by commas. The key and value are separated by an equal sign.
- Returns:
- the meta data string or
null
if one was not set - See Also:
-
setMetaData
Sets the meta data to use in the structured format.The value is a string where key/value pairs are separated by commas. The key and value are separated by an equal sign.
- Parameters:
metaData
- the meta data to set ornull
to not format any meta data- See Also:
-
getDateTimeFormatter
Returns the current formatter used to format a records date and time.- Returns:
- the current formatter
-
setDateFormat
Sets the pattern to use when formatting the date. The pattern must be a validDateTimeFormatter.ofPattern(String)
pattern.If the pattern is
null
a default formatter will be used. The zone id will always be appended to the formatter. By default the zone id will default to the systems zone id.- Parameters:
pattern
- the pattern to use ornull
to use a default pattern
-
getZoneId
Returns the current zone id used for the date and time formatter.- Returns:
- the current zone id
-
setZoneId
Sets theZoneId
to use when formatting the date and time from theLogRecord
.The rules of the id must conform to the rules specified on
ZoneId.of(String)
.- Parameters:
zoneId
- the zone id ornull
to use the system default- See Also:
-
isPrintDetails
public boolean isPrintDetails()Indicates whether or not details should be printed.- Returns:
true
if details should be printed, otherwisefalse
-
setPrintDetails
public void setPrintDetails(boolean printDetails) Sets whether or not details should be printed.Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number.
- Parameters:
printDetails
-true
if details should be printed
-
getExceptionOutputType
Get the current output type for exceptions.- Returns:
- the output type for exceptions
-
setExceptionOutputType
Set the output type for exceptions. The default isDETAILED
.- Parameters:
exceptionOutputType
- the desired output type, ifnull
StructuredFormatter.ExceptionOutputType.DETAILED
is used
-
isDetailedExceptionOutputType
protected boolean isDetailedExceptionOutputType()Checks the exception output type and determines if detailed output should be written.- Returns:
true
if detailed output should be written, otherwisefalse
-
isFormattedExceptionOutputType
protected boolean isFormattedExceptionOutputType()Checks the exception output type and determines if formatted output should be written. The formatted output is equivalent toThrowable.printStackTrace()
.- Returns:
true
if formatted exception output should be written, otherwisefalse
-