## Provided Capabilities (1)

Name | Dynamic | Other provider points
--- | --- | ---
org.wildfly.logging.handler | true | /subsystem=logging/logging-profile=*/periodic-rotating-file-handler=* /subsystem=logging/periodic-size-rotating-file-handler=* /subsystem=logging/logging-profile=*/custom-handler=* /subsystem=logging/file-handler=* /subsystem=logging/custom-handler=* /subsystem=logging/logging-profile=*/syslog-handler=* /subsystem=logging/logging-profile=*/socket-handler=* /subsystem=logging/logging-profile=*/console-handler=* /subsystem=logging/logging-profile=*/size-rotating-file-handler=* /subsystem=logging/periodic-rotating-file-handler=* /subsystem=logging/socket-handler=* /subsystem=logging/logging-profile=*/file-handler=* /subsystem=logging/console-handler=* /subsystem=logging/logging-profile=*/periodic-size-rotating-file-handler=* /subsystem=logging/async-handler=* /subsystem=logging/logging-profile=*/async-handler=* /subsystem=logging/size-rotating-file-handler=*

## Attributes (9)

- app-name - The app name used when formatting the message in RFC5424 format. By default the app name is "java".

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The app name used when formatting the message in RFC5424 format. By default the app name is \"java\".",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- 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.

  Type | BOOLEAN
  Default Value | true
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- facility - Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).

  Type | STRING
  Default Value | user-level
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Allowed Values | local-use-5 line-printer network-news local-use-4 local-use-7 syslogd ftp-daemon local-use-6 local-use-1 log-alert local-use-0 kernel local-use-3 local-use-2 log-audit ntp security2 security user-level system-daemons uucp clock-daemon2 mail-system clock-daemon
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "user-level",
          "allowed" : [
              "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"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- 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.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The name of the host the messages are being sent from. For example the name of the host the application server is running on.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- level - The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

  Type | STRING
  Default Value | ALL
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Allowed Values | TRACE ALL SEVERE FINER FINEST INFO DEBUG WARNING WARN OFF CONFIG FINE ERROR FATAL
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "ALL",
          "allowed" : [
              "ALL",
              "FINEST",
              "FINER",
              "TRACE",
              "DEBUG",
              "FINE",
              "CONFIG",
              "INFO",
              "WARN",
              "WARNING",
              "ERROR",
              "SEVERE",
              "FATAL",
              "OFF"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- named-formatter - The name of the defined formatter to be used on the handler.

  Type | STRING
  Is the attribute nillable? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The name of the defined formatter to be used on the handler.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "capability-reference" : "org.wildfly.logging.formatter",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services"
      }

- port - The port the syslog server is listening on.

  Type | INT
  Default Value | 514
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Min | 0
  Max | 65535
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The port the syslog server is listening on.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : 514,
          "min" : 0,
          "max" : 65535,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- server-address - The address of the syslog server.

  Type | STRING
  Default Value | localhost
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The address of the syslog server.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "localhost",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- syslog-format - Formats the log message according to the RFC specification.

  Type | STRING
  Default Value | RFC5424
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Allowed Values | RFC3164 RFC5424
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "Formats the log message according to the RFC specification.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "RFC5424",
          "allowed" : [
              "RFC5424",
              "RFC3164"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

## 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.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Adds a new syslog handler.",
          "request-properties" : {
              "app-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The app name used when formatting the message in RFC5424 format. By default the app name is \"java\".",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "enabled" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "facility" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "user-level",
                  "allowed" : [
                      "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"
                  ],
                  "stability" : "default"
              },
              "hostname" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the host the messages are being sent from. For example the name of the host the application server is running on.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "level" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "ALL",
                  "allowed" : [
                      "ALL",
                      "FINEST",
                      "FINER",
                      "TRACE",
                      "DEBUG",
                      "FINE",
                      "CONFIG",
                      "INFO",
                      "WARN",
                      "WARNING",
                      "ERROR",
                      "SEVERE",
                      "FATAL",
                      "OFF"
                  ],
                  "stability" : "default"
              },
              "named-formatter" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the defined formatter to be used on the handler.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "capability-reference" : "org.wildfly.logging.formatter",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "port" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The port the syslog server is listening on.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : 514,
                  "min" : 0,
                  "max" : 65535,
                  "stability" : "default"
              },
              "server-address" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The address of the syslog server.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "localhost",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "syslog-format" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Formats the log message according to the RFC specification.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "RFC5424",
                  "allowed" : [
                      "RFC5424",
                      "RFC3164"
                  ],
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove - Removes the syslog handler.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Removes the syslog handler.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "restart-required" : "all-services",
          "runtime-only" : false
      }

## Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

- subsystem.logging.syslog-handler

      <feature spec="subsystem.logging.syslog-handler">
        <param name="syslog-handler" value="{resource name}"/>
        <param name="app-name" value="{value}"/>
        <param name="enabled" value="{value}"/>
        <param name="facility" value="{value}"/>
        <param name="hostname" value="{value}"/>
        <param name="level" value="{value}"/>
        <param name="named-formatter" value="{value}"/>
        <param name="port" value="{value}"/>
        <param name="server-address" value="{value}"/>
        <param name="syslog-format" value="{value}"/>
      <feature/>