Package io.quarkus.logging.gelf

Class GelfConfig

java.lang.Object
io.quarkus.logging.gelf.GelfConfig
@ConfigRoot(phase=RUN_TIME, name="log.handler.gelf") public class GelfConfig extends Object

  • Field Details

    • enabled

      @ConfigItem public boolean enabled
      Determine whether to enable the GELF logging handler

    • host

      @ConfigItem(defaultValue="localhost") public 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

      @ConfigItem(defaultValue="12201") public int port
      The port

    • version

      @ConfigItem(defaultValue="1.1") public String version
      GELF version: 1.0 or 1.1

    • extractStackTrace

      @ConfigItem(defaultValue="true") public boolean extractStackTrace
      Whether to post Stack-Trace to StackTrace field.
      See Also:

    • stackTraceThrowableReference

      @ConfigItem public 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

      @ConfigItem public boolean filterStackTrace
      Whether to perform Stack-Trace filtering

    • timestampPattern

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

    • level

      @ConfigItem(defaultValue="ALL") public Level level
      The logging-gelf log level.

    • facility

      @ConfigItem(defaultValue="jboss-logmanager") public String facility
      Name of the facility.

    • additionalField

      @ConfigItem @ConfigDocMapKey("field-name") @ConfigDocSection public 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

      @ConfigItem public boolean includeFullMdc
      Whether to include all fields from the MDC.

    • mdcFields

      @ConfigItem public 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

      @ConfigItem public 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

      @ConfigItem public 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

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

    • includeLogMessageParameters

      @ConfigItem(defaultValue="true") public boolean includeLogMessageParameters
      Include message parameters from the log event

    • includeLocation

      @ConfigItem(defaultValue="true") public boolean includeLocation
      Include source code location

    • originHost

      @ConfigItem public Optional<String> originHost
      Origin hostname

    • skipHostnameResolution

      @ConfigItem public 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

  • Constructor Details

    • GelfConfig

      public GelfConfig()