Quarkus Logging JSON

Quarkus logging extension outputting the log messages in JSON. It supports the following formats: default, Elastic Common Schema (ECS).

Installation

If you want to use this extension, you need to add the quarkus-logging-json extension first. In your pom.xml file, add:

<dependency>
    <groupId>io.quarkiverse.loggingjson</groupId>
    <artifactId>quarkus-logging-json</artifactId>
    <version>3.5.0</version>
</dependency>

Extension Configuration Reference

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.log.json.console.enabled

Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

Environment variable: QUARKUS_LOG_JSON_CONSOLE_ENABLED

boolean

true

quarkus.log.json.file.enabled

Determine whether to enable the JSON file formatting extension, which disables "normal" file formatting.

Environment variable: QUARKUS_LOG_JSON_FILE_ENABLED

boolean

false

quarkus.log.json.socket.enabled

Determine whether to enable the JSON socket formatting extension, which disables "normal" socket formatting.

Environment variable: QUARKUS_LOG_JSON_SOCKET_ENABLED

boolean

true

quarkus.log.json.fields.arguments.field-name

Used to wrap arguments in a json object, with this fieldName on root json.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ARGUMENTS_FIELD_NAME

string

quarkus.log.json.fields.arguments.include-structured-arguments

Enable output of structured logging arguments StructuredArgument, default is true.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ARGUMENTS_INCLUDE_STRUCTURED_ARGUMENTS

boolean

true

quarkus.log.json.fields.arguments.include-non-structured-arguments

Enable output of non-structured logging arguments, default is false.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ARGUMENTS_INCLUDE_NON_STRUCTURED_ARGUMENTS

boolean

false

quarkus.log.json.fields.arguments.non-structured-arguments-field-prefix

What prefixes to use, when outputting non-structured arguments. Default is arg, example key for the first argument will be arg0.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ARGUMENTS_NON_STRUCTURED_ARGUMENTS_FIELD_PREFIX

string

arg

quarkus.log.json.fields.timestamp.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_TIMESTAMP_FIELD_NAME

string

quarkus.log.json.fields.timestamp.date-format

The date format to use. The special string "default" indicates that the default format should be used.

Environment variable: QUARKUS_LOG_JSON_FIELDS_TIMESTAMP_DATE_FORMAT

string

default

quarkus.log.json.fields.timestamp.zone-id

The zone to use when formatting the timestamp.

Environment variable: QUARKUS_LOG_JSON_FIELDS_TIMESTAMP_ZONE_ID

string

default

quarkus.log.json.fields.timestamp.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_TIMESTAMP_ENABLED

boolean

quarkus.log.json.fields.hostname.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_HOSTNAME_FIELD_NAME

string

quarkus.log.json.fields.hostname.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_HOSTNAME_ENABLED

boolean

quarkus.log.json.fields.sequence.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_SEQUENCE_FIELD_NAME

string

quarkus.log.json.fields.sequence.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_SEQUENCE_ENABLED

boolean

quarkus.log.json.fields.logger-class-name.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_LOGGER_CLASS_NAME_FIELD_NAME

string

quarkus.log.json.fields.logger-class-name.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_LOGGER_CLASS_NAME_ENABLED

boolean

quarkus.log.json.fields.logger-name.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_LOGGER_NAME_FIELD_NAME

string

quarkus.log.json.fields.logger-name.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_LOGGER_NAME_ENABLED

boolean

quarkus.log.json.fields.level.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_LEVEL_FIELD_NAME

string

quarkus.log.json.fields.level.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_LEVEL_ENABLED

boolean

quarkus.log.json.fields.message.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_MESSAGE_FIELD_NAME

string

quarkus.log.json.fields.message.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_MESSAGE_ENABLED

boolean

quarkus.log.json.fields.thread-name.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_THREAD_NAME_FIELD_NAME

string

quarkus.log.json.fields.thread-name.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_THREAD_NAME_ENABLED

boolean

quarkus.log.json.fields.thread-id.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_THREAD_ID_FIELD_NAME

string

quarkus.log.json.fields.thread-id.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_THREAD_ID_ENABLED

boolean

quarkus.log.json.fields.mdc.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_MDC_FIELD_NAME

string

quarkus.log.json.fields.mdc.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_MDC_ENABLED

boolean

quarkus.log.json.fields.mdc.flat-fields

Will write the values at the top level of the JSON log object.

Environment variable: QUARKUS_LOG_JSON_FIELDS_MDC_FLAT_FIELDS

boolean

false

quarkus.log.json.fields.ndc.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_NDC_FIELD_NAME

string

quarkus.log.json.fields.ndc.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_NDC_ENABLED

boolean

quarkus.log.json.fields.process-name.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_PROCESS_NAME_FIELD_NAME

string

quarkus.log.json.fields.process-name.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_PROCESS_NAME_ENABLED

boolean

quarkus.log.json.fields.process-id.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_PROCESS_ID_FIELD_NAME

string

quarkus.log.json.fields.process-id.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_PROCESS_ID_ENABLED

boolean

quarkus.log.json.fields.stack-trace.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_STACK_TRACE_FIELD_NAME

string

quarkus.log.json.fields.stack-trace.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_STACK_TRACE_ENABLED

boolean

quarkus.log.json.fields.error-type.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ERROR_TYPE_FIELD_NAME

string

quarkus.log.json.fields.error-type.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ERROR_TYPE_ENABLED

boolean

quarkus.log.json.fields.error-message.field-name

Used to change the json key for the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ERROR_MESSAGE_FIELD_NAME

string

quarkus.log.json.fields.error-message.enabled

Enable or disable the field.

Environment variable: QUARKUS_LOG_JSON_FIELDS_ERROR_MESSAGE_ENABLED

boolean

quarkus.log.json.pretty-print

Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read pretty printed output.

Environment variable: QUARKUS_LOG_JSON_PRETTY_PRINT

boolean

false

quarkus.log.json.record-delimiter

The special end-of-record delimiter to be used. By default, newline delimiter is used.

Environment variable: QUARKUS_LOG_JSON_RECORD_DELIMITER

string

For adding fields to the json output directly from the config

Type

Default

quarkus.log.json.additional-field."field-name".value

Additional field value.

Environment variable: QUARKUS_LOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE

string

required

quarkus.log.json.additional-field."field-name".type

Type of the field, default is STRING. Supported types: STRING, INT, LONG, FLOAT, DOUBLE.

Environment variable: QUARKUS_LOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE

string, int, long, float, double

string

quarkus.log.json.log-format

Support changing logging format.

When set to none, configs for fields will have no effect. Instead, the output has to be defined by code using a custom JsonProvider.

Environment variable: QUARKUS_LOG_JSON_LOG_FORMAT

default, ecs, none

default