WildFly Full 26 Model Reference

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

Defines a handler which writes to a file.

Provided capabilities(1)

Attributes (11)

  • append Specify whether to append to the target file.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • autoflush Automatically flush after each write.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    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
  • encoding The character encoding used by this Handler.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • file The file description consisting of the path and optional relative to path.
    • Attribute Value
    Type OBJECT
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • filter Defines a simple filter type.
    • Deprecated Since 1.2.0
    Use filter-spec.
    Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • filter-spec A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • formatter Defines a pattern for the formatter.
    • Attribute Value
    Default Value %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n
    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
  • name The name of the handler.
    • Deprecated Since 1.2.0
    The name attribute should not be used as the handler's address contains the name.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • named-formatter The name of the defined formatter to be used on the handler.

Operations (9)

  • add Add a new file handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    append BOOLEAN false true true Specify whether to append to the target file.
    autoflush BOOLEAN false true true Automatically flush after each write.
    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.
    encoding STRING false true The character encoding used by this Handler.
    file OBJECT true false The file description consisting of the path and optional relative to path.
    filter OBJECT false false Defines a simple filter type.
    filter-spec STRING false true A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
    formatter STRING false true %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n Defines a pattern for the formatter.
    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.
    name STRING false false The name of the handler.
    named-formatter STRING false false The name of the defined formatter to be used on the handler.
  • change-file Change the file for a handler.
    Deprecated Since 1.2.0
    Use the write-attribute operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    file OBJECT true false Change the file for a handler.
  • change-log-level Change the logging level for a handler.
    Deprecated Since 1.2.0
    Use the write-attribute operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    level STRING false true ALL The new level to set.
  • disable Disable a logging handler.
    Deprecated Since 1.2.0
    Use the write-attribute for the enabled attribute.
  • enable Enable a logging handler.
    Deprecated Since 1.2.0
    Use the write-attribute for the enabled attribute.
  • path-info Obtain the informations for a filesystem path.
    Request Parameter Type Required Expressions Allowed Default value Description
    unit STRING false false BYTES Disk space unit to display disk usage.

    Reply properties

    Filesystem path for which to obtain disk usage.
    type
    OBJECT
    Value Type
    {
    "used-space" => {
        "type" => DOUBLE,
        "description" => "The total size of the contents of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "unit" => "BYTES"
    },
    "creation-time" => {
        "type" => STRING,
        "description" => "The creation time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "last-modified" => {
        "type" => STRING,
        "description" => "The last modified time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "resolved-path" => {
        "type" => STRING,
        "description" => "The resolved filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "available-space" => {
        "type" => DOUBLE,
        "description" => "The total size of available space for the partition containing a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "unit" => "BYTES"
    }
}
  • remove Removes the file handler.
  • resolve-path Resolves a relative path of a previously named paths or one of the standard paths provided by the system.
    Request Parameter Type Required Expressions Allowed Default value Description
    relative-to-only BOOLEAN false false Indicates whether only the relative-to attribute should be resolved or the full path should be resolved. The default is false meaning the entire path will be resolved.

    Reply properties

    The resolved path from the relative path attribute.
    type
    STRING
  • update-properties Update the properties on the existing handler.
    Deprecated Since 1.2.0
    Use the write-attribute operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    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.
    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.
    encoding STRING false true The character encoding used by this Handler.
    formatter STRING false true %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n Defines a pattern for the formatter.
    filter-spec STRING false true A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
    autoflush BOOLEAN false true true Automatically flush after each write.
    append BOOLEAN false true true Specify whether to append to the target file.
    file OBJECT true false The file description consisting of the path and optional relative to path.
    named-formatter STRING false false The name of the defined formatter to be used on the handler.
    filter OBJECT false false Defines a simple filter type.