Package io.quarkus.runtime.logging

Interface LogRuntimeConfig.SyslogConfig

Enclosing interface:
LogRuntimeConfig
public static interface LogRuntimeConfig.SyslogConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    appName()
    The app name used when formatting the message in RFC5424 format
    LogRuntimeConfig.AsyncConfig
    async()
    Syslog async logging config
    boolean
    blockOnReconnect()
    Enables or disables blocking when attempting to reconnect a TCP or SSL TCP protocol
    boolean
    enable()
    If syslog logging should be enabled
    @WithConverter(InetSocketAddressConverter.class) InetSocketAddress
    endpoint()
    The IP address and port of the Syslog server
    org.jboss.logmanager.handlers.SyslogHandler.Facility
    facility()
    Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164
    Optional<String>
    filter()
    The name of the filter to link to the file handler.
    String
    format()
    The log message format
    Optional<String>
    hostname()
    The name of the host the messages are being sent from
    @WithConverter(LevelConverter.class) Level
    level()
    The log level specifying what message levels will be logged by the Syslog logger
    Optional<@WithConverter(MemorySizeConverter.class) MemorySize>
    maxLength()
    The maximum length, in bytes, of the message allowed to be sent, up to Integer.MAX_VALUE bytes.
    org.jboss.logmanager.handlers.SyslogHandler.Protocol
    protocol()
    Sets the protocol used to connect to the Syslog server
    org.jboss.logmanager.handlers.SyslogHandler.SyslogType
    syslogType()
    Set the syslog type this handler should use to format the message sent
    boolean
    truncate()
    Set to true to truncate the message if it exceeds maximum length
    boolean
    useCountingFraming()
    If enabled, the message being sent is prefixed with the size of the message

  • Method Details

    • enable

      @WithDefault("false") boolean enable()
      If syslog logging should be enabled

    • endpoint

      @WithDefault("localhost:514") @WithConverter(InetSocketAddressConverter.class) @WithConverter(InetSocketAddressConverter.class) InetSocketAddress endpoint()
      The IP address and port of the Syslog server

    • appName

      Optional<String> appName()
      The app name used when formatting the message in RFC5424 format

    • hostname

      Optional<String> hostname()
      The name of the host the messages are being sent from

    • facility

      @WithDefault("user-level") org.jboss.logmanager.handlers.SyslogHandler.Facility facility()
      Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164

    • syslogType

      @WithDefault("rfc5424") org.jboss.logmanager.handlers.SyslogHandler.SyslogType syslogType()
      Set the syslog type this handler should use to format the message sent

    • protocol

      @WithDefault("tcp") org.jboss.logmanager.handlers.SyslogHandler.Protocol protocol()
      Sets the protocol used to connect to the Syslog server

    • useCountingFraming

      @WithDefault("false") boolean useCountingFraming()
      If enabled, the message being sent is prefixed with the size of the message

    • truncate

      @WithDefault("true") boolean truncate()
      Set to true to truncate the message if it exceeds maximum length

    • blockOnReconnect

      @WithDefault("false") boolean blockOnReconnect()
      Enables or disables blocking when attempting to reconnect a TCP or SSL TCP protocol

    • format

      @WithDefault("%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n") String format()
      The log message format

    • level

      @WithDefault("ALL") @WithConverter(LevelConverter.class) @WithConverter(LevelConverter.class) Level level()
      The log level specifying what message levels will be logged by the Syslog logger

    • filter

      Optional<String> filter()
      The name of the filter to link to the file handler.

    • maxLength

      Optional<@WithConverter(MemorySizeConverter.class) MemorySize> maxLength()
      The maximum length, in bytes, of the message allowed to be sent, up to Integer.MAX_VALUE bytes. The length includes the header and the message.

      If not set, the default value is 2048 when sys-log-type is rfc5424 (which is the default) and 1024 when sys-log-type is rfc3164

    • async

      LogRuntimeConfig.AsyncConfig async()
      Syslog async logging config