Package org.jboss.logmanager.formatters
Class JsonFormatter
java.lang.Object
java.util.logging.Formatter
org.jboss.logmanager.ExtFormatter
org.jboss.logmanager.formatters.StructuredFormatter
org.jboss.logmanager.formatters.JsonFormatter
A formatter that outputs the record into JSON format optionally printing details.
Note that including details can be expensive in terms of calculating the caller.
The details include;
- Author:
- James R. Perkins
-
Nested Class Summary
Nested classes/interfaces inherited from class org.jboss.logmanager.formatters.StructuredFormatter
StructuredFormatter.ExceptionOutputType, StructuredFormatter.Generator, StructuredFormatter.Key
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new JSON formatter.JsonFormatter
(String keyOverrides) Creates a new JSON formatter.JsonFormatter
(Map<StructuredFormatter.Key, String> keyOverrides) Creates a new JSON formatter. -
Method Summary
Modifier and TypeMethodDescriptionprotected StructuredFormatter.Generator
createGenerator
(Writer writer) Creates the generator used to create the structured data.boolean
Indicates whether or not pretty printing is enabled.void
setPrettyPrint
(boolean prettyPrint) Turns on or off pretty printing.Methods inherited from class org.jboss.logmanager.formatters.StructuredFormatter
after, before, format, getDateTimeFormatter, getExceptionOutputType, getKey, getKeyOverrides, getMetaData, getRecordDelimiter, getZoneId, isCallerCalculationRequired, isDetailedExceptionOutputType, isFormattedExceptionOutputType, isPrintDetails, setDateFormat, setExceptionOutputType, setMetaData, setPrintDetails, setRecordDelimiter, setZoneId
Methods inherited from class org.jboss.logmanager.ExtFormatter
format
Methods inherited from class java.util.logging.Formatter
formatMessage, getHead, getTail
-
Constructor Details
-
JsonFormatter
public JsonFormatter()Creates a new JSON formatter. -
JsonFormatter
Creates a new JSON formatter.- Parameters:
keyOverrides
- a string representation of a map to override keys- See Also:
-
JsonFormatter
Creates a new JSON formatter.- Parameters:
keyOverrides
- a map of overrides for the default keys
-
-
Method Details
-
isPrettyPrint
public boolean isPrettyPrint()Indicates whether or not pretty printing is enabled.- Returns:
true
if pretty printing is enabled, otherwisefalse
-
setPrettyPrint
public void setPrettyPrint(boolean prettyPrint) Turns on or off pretty printing.- Parameters:
prettyPrint
-true
to turn on pretty printing orfalse
to turn it off
-
createGenerator
Description copied from class:StructuredFormatter
Creates the generator used to create the structured data.- Specified by:
createGenerator
in classStructuredFormatter
- Returns:
- the generator to use
-