Package io.quarkus.logging.gelf

Interface GelfConfig

@ConfigMapping(prefix="quarkus.log.handler.gelf") @ConfigRoot(phase=RUN_TIME) public interface GelfConfig

  • Method Details

    • enabled

      @WithDefault("false") boolean enabled()
      Determine whether to enable the GELF logging handler

    • host

      @WithDefault("localhost") String host()
      Hostname/IP-Address of the Logstash/Graylog Host By default it uses UDP, prepend tcp: to the hostname to switch to TCP, example: "tcp:localhost"

    • port

      @WithDefault("12201") int port()
      The port

    • version

      @WithDefault("1.1") String version()
      GELF version: 1.0 or 1.1

    • extractStackTrace

      @WithDefault("true") boolean extractStackTrace()
      Whether to post Stack-Trace to StackTrace field.
      See Also:

    • stackTraceThrowableReference

      @WithDefault("0") int stackTraceThrowableReference()
      Only used when `extractStackTrace` is `true`. A value of 0 will extract the whole stack trace. Any positive value will walk the cause chain: 1 corresponds with exception.getCause(), 2 with exception.getCause().getCause(), ... Negative throwable reference walk the exception chain from the root cause side: -1 will extract the root cause, -2 the exception wrapping the root cause, ...

    • filterStackTrace

      @WithDefault("false") boolean filterStackTrace()
      Whether to perform Stack-Trace filtering

    • timestampPattern

      @WithDefault("yyyy-MM-dd HH:mm:ss,SSS") String timestampPattern()
      Java date pattern, see SimpleDateFormat

    • level

      @WithDefault("ALL") Level level()
      The logging-gelf log level.

    • facility

      @WithDefault("jboss-logmanager") String facility()
      Name of the facility.

    • additionalField

      @ConfigDocSection @ConfigDocMapKey("field-name") Map<String,AdditionalFieldConfig> additionalField()
      Post additional fields. You can add static fields to each log event in the following form: 
       quarkus.log.handler.gelf.additional-field.field1.value=value1
 quarkus.log.handler.gelf.additional-field.field1.type=String

    • includeFullMdc

      @WithDefault("false") boolean includeFullMdc()
      Whether to include all fields from the MDC.

    • mdcFields

      Optional<String> mdcFields()
      Send additional fields whose values are obtained from MDC. Name of the Fields are comma-separated. Example: mdcFields=Application,Version,SomeOtherFieldName

    • dynamicMdcFields

      Optional<String> dynamicMdcFields()
      Dynamic MDC Fields allows you to extract MDC values based on one or more regular expressions. Multiple regexes are comma-separated. The name of the MDC entry is used as GELF field name.

    • dynamicMdcFieldTypes

      Optional<String> dynamicMdcFieldTypes()
      Pattern-based type specification for additional and MDC fields. Key-value pairs are comma-separated. Example: my_field.*=String,business\..*\.field=double

    • maximumMessageSize

      @WithDefault("8192") int maximumMessageSize()
      Maximum message size (in bytes). If the message size is exceeded, the appender will submit the message in multiple chunks.

    • includeLogMessageParameters

      @WithDefault("true") boolean includeLogMessageParameters()
      Include message parameters from the log event

    • includeLocation

      @WithDefault("true") boolean includeLocation()
      Include source code location

    • originHost

      Optional<String> originHost()
      Origin hostname

    • skipHostnameResolution

      @WithDefault("false") boolean skipHostnameResolution()
      Bypass hostname resolution. If you didn't set the originHost property, and resolution is disabled, the value “unknown” will be used as hostname