Package io.quarkus.logging.json.runtime

Interface JsonLogConfig.JsonConfig

Enclosing interface:
JsonLogConfig
public static interface JsonLogConfig.JsonConfig

  • Method Details

    • enable

      @WithParentName @WithDefault("true") @Deprecated(forRemoval=true, since="3.19") boolean enable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

    • enabled

      Optional<Boolean> enabled()
      Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

    • prettyPrint

      @WithDefault("false") boolean prettyPrint()
      Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.

    • dateFormat

      @WithDefault("default") String dateFormat()
      The date format to use. The special string "default" indicates that the default format should be used.

    • recordDelimiter

      Optional<String> recordDelimiter()
      The special end-of-record delimiter to be used. By default, newline is used.

    • zoneId

      @WithDefault("default") String zoneId()
      The zone ID to use. The special string "default" indicates that the default zone should be used.

    • exceptionOutputType

      @WithDefault("detailed") org.jboss.logmanager.formatters.StructuredFormatter.ExceptionOutputType exceptionOutputType()
      The exception output type to specify.

    • printDetails

      @WithDefault("false") boolean printDetails()
      Enable printing of more details in the log.

      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.

    • keyOverrides

      Optional<String> keyOverrides()
      Override keys with custom values. Omitting this value indicates that no key overrides will be applied.

    • excludedKeys

      Optional<Set<String>> excludedKeys()
      Keys to be excluded from the JSON output.

    • additionalField

      @ConfigDocMapKey("field-name") Map<String,JsonLogConfig.AdditionalFieldConfig> additionalField()
      Additional fields to be appended in the JSON logs.

    • logFormat

      @WithDefault("default") JsonLogConfig.JsonConfig.LogFormat logFormat()
      Specify the format of the produced JSON