WildFly Full 23 Model Reference

  1. home
  2. subsystem=logging
  3. syslog-handler

Defines a syslog handler.

Provided capabilities(1)

Attributes (9)

  • app-name The app name used when formatting the message in RFC5424 format. By default the app name is "java".
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • enabled If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • facility Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).
    • Attribute Value
    Default Value user-level
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values kernel
    user-level
    mail-system
    system-daemons
    security
    syslogd
    line-printer
    network-news
    uucp
    clock-daemon
    security2
    ftp-daemon
    ntp
    log-audit
    log-alert
    clock-daemon2
    local-use-0
    local-use-1
    local-use-2
    local-use-3
    local-use-4
    local-use-5
    local-use-6
    local-use-7
  • hostname The name of the host the messages are being sent from. For example the name of the host the application server is running on.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • level The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
    • Attribute Value
    Default Value ALL
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values ALL
    FINEST
    FINER
    TRACE
    DEBUG
    FINE
    CONFIG
    INFO
    WARN
    WARNING
    ERROR
    SEVERE
    FATAL
    OFF
  • named-formatter The name of the defined formatter to be used on the handler.
  • port The port the syslog server is listening on.
    • Attribute Value
    Default Value 514
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 65,535
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • server-address The address of the syslog server.
    • Attribute Value
    Default Value localhost
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • syslog-format Formats the log message according to the RFC specification.
    • Attribute Value
    Default Value RFC5424
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values RFC5424
    RFC3164

Operations (2)

  • add Adds a new syslog handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    app-name STRING false true The app name used when formatting the message in RFC5424 format. By default the app name is "java".
    enabled BOOLEAN false true true If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
    facility STRING false true user-level Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).
    hostname STRING false true The name of the host the messages are being sent from. For example the name of the host the application server is running on.
    level STRING false true ALL The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
    named-formatter STRING false false The name of the defined formatter to be used on the handler.
    port INT false true 514 The port the syslog server is listening on.
    server-address STRING false true localhost The address of the syslog server.
    syslog-format STRING false true RFC5424 Formats the log message according to the RFC specification.
  • remove Removes the syslog handler.