java.util.logging JSON Formatter
Following settings can be used:
| Attribute Name | Description | Default |
|---|---|---|
| version | GELF Version 1.0 or 1.1 |
1.0 |
| originHost | Originating Hostname | FQDN Hostname |
| extractStackTrace | Send the Stack-Trace to the StackTrace field (true/false) |
false |
| filterStackTrace | Perform Stack-Trace filtering (true/false) |
false |
| includeLogMessageParameters | Include message parameters from the log event | true |
| includeLocation | Include source code location | true |
| facility | Name of the Facility | logstash-gelf |
| filter | Class-Name of a Log-Filter | none |
| additionalFields | Send additional static fields. The fields are specified as key-value pairs are comma-separated. Example: additionalFields=fieldName=Value,fieldName2=Value2 |
none |
| additionalFieldTypes | Type specification for additional fields. Supported types: String, long, Long, double, Double and discover (default if not specified, discover field type on parseability). Eg. field=String,field2=double |
discover for all additional fields |
| maximumMessageSize | Maximum message size (in bytes). If the message size is exceeded, the appender will submit the message in multiple chunks. | 8192 |
| timestampPattern | Date/time pattern for the Time field |
yyyy-MM-dd HH:mm:ss,SSS |
The only mandatory field is host. All other fields are optional.
If a message carries params (used to substitute resource bundle argument placeholders),
the params are exposed as individual fields prefixed with MessageParam.
Please note: The logging Jar files need to be on the boot class path, else JUL won't load the handler.
Glassfish/Payara configuration
You need to install the library with its dependencies (see download above) in Glassfish/Payara. Place it below the $GFHOME/glassfish/domains/$YOURDOMAIN/lib/ext/ path, then configure your logging.properties file.
Java Util Logging Configuration
Simple Configuration:
handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.level = INFO
java.util.logging.FileHandler.formatter=biz.paluch.logging.gelf.jul.GelfFormatter
Extended Properties:
handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.level = INFO
java.util.logging.FileHandler.formatter=biz.paluch.logging.gelf.jul.GelfFormatter
biz.paluch.logging.gelf.jul.GelfFormatter.fields=Severity, Time, LoggerName
biz.paluch.logging.gelf.jul.GelfFormatter.version=1.0
biz.paluch.logging.gelf.jul.GelfFormatter.facility=logstash-gelf
biz.paluch.logging.gelf.jul.GelfFormatter.extractStackTrace=true
biz.paluch.logging.gelf.jul.GelfFormatter.filterStackTrace=true
biz.paluch.logging.gelf.jul.GelfFormatter.includeLogMessageParameters=true
biz.paluch.logging.gelf.jul.GelfFormatter.includeLocation=true
biz.paluch.logging.gelf.jul.GelfFormatter.timestampPattern=yyyy-MM-dd HH:mm:ss,SSS
biz.paluch.logging.gelf.jul.GelfFormatter.additionalFields=fieldName1=fieldValue1,fieldName2=fieldValue2
biz.paluch.logging.gelf.jul.GelfFormatter.additionalFieldTypes=fieldName1=String,fieldName2=Double,fieldName3=Long
biz.paluch.logging.gelf.jul.GelfFormatter.linebreak=\\n