Package io.quarkus.runtime.logging

Class SyslogConfig

java.lang.Object
io.quarkus.runtime.logging.SyslogConfig
public class SyslogConfig extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) Optional<String>
    appName
    The app name used when formatting the message in RFC5424 format
    (package private) AsyncConfig
    async
    Syslog async logging config
    (package private) boolean
    blockOnReconnect
    Enables or disables blocking when attempting to reconnect a TCP or SSL TCP protocol
    (package private) boolean
    enable
    If syslog logging should be enabled
    (package private) InetSocketAddress
    endpoint
    The IP address and port of the Syslog server
    (package private) 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
    (package private) Optional<String>
    filter
    The name of the filter to link to the file handler.
    (package private) String
    format
    The log message format
    (package private) Optional<String>
    hostname
    The name of the host the messages are being sent from
    (package private) Level
    level
    The log level specifying what message levels will be logged by the Syslog logger
    (package private) Optional<MemorySize>
    maxLength
    The maximum length, in bytes, of the message allowed to be sent.
    (package private) org.jboss.logmanager.handlers.SyslogHandler.Protocol
    protocol
    Sets the protocol used to connect to the Syslog server
    (package private) org.jboss.logmanager.handlers.SyslogHandler.SyslogType
    syslogType
    Set the syslog type this handler should use to format the message sent
    (package private) boolean
    truncate
    Set to true to truncate the message if it exceeds maximum length
    (package private) boolean
    useCountingFraming
    If enabled, the message being sent is prefixed with the size of the message

  • Constructor Summary

    Constructors
    Constructor
    Description
    SyslogConfig()
     

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • enable

      @ConfigItem boolean enable
      If syslog logging should be enabled

    • endpoint

      @ConfigItem(defaultValue="localhost:514") InetSocketAddress endpoint
      The IP address and port of the Syslog server

    • appName

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

    • hostname

      @ConfigItem Optional<String> hostname
      The name of the host the messages are being sent from

    • facility

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

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

    • protocol

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

    • useCountingFraming

      @ConfigItem boolean useCountingFraming
      If enabled, the message being sent is prefixed with the size of the message

    • truncate

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

    • blockOnReconnect

      @ConfigItem boolean blockOnReconnect
      Enables or disables blocking when attempting to reconnect a TCP or SSL TCP protocol

    • format

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

    • level

      @ConfigItem(defaultValue="ALL") Level level
      The log level specifying what message levels will be logged by the Syslog logger

    • filter

      @ConfigItem Optional<String> filter
      The name of the filter to link to the file handler.

    • maxLength

      @ConfigItem Optional<MemorySize> maxLength
      The maximum length, in bytes, of the message allowed to be sent. 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

      AsyncConfig async
      Syslog async logging config

  • Constructor Details

    • SyslogConfig

      public SyslogConfig()