Management API Reference for file-handler

Defines a handler which writes to a file.

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/syslog-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 (10)

append - Specify whether to append to the target file.

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" : "Specify whether to append to the target file.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

autoflush - Automatically flush after each write.

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" : "Automatically flush after each write.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "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 }`

encoding - The character encoding used by this Handler.

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 character encoding used by this Handler.", "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 }`

file - The file description consisting of the path and optional relative to path.

Type	OBJECT
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" : "OBJECT" }, "description" : "The file description consisting of the path and optional relative to path.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "relative-to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.management.path", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The filesystem path.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "filesystem-path" : true, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

filter-spec - A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

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" : "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["filter"], "capability-reference" : "org.wildfly.logging.filter", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }

formatter - Defines a pattern for the formatter.

Type	STRING
Default Value	%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n
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" : "Defines a pattern for the formatter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" : ["named-formatter"], "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 }

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.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the handler.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "1.2.0", "reason" : "The name attribute should not be used as the handler's address contains the name." }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "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, "alternatives" : ["formatter"], "capability-reference" : "org.wildfly.logging.formatter", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

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-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.
named-formatter	STRING	false	false		The name of the defined formatter to be used on the handler.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new file handler.",
    "request-properties" : {
        "append" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specify whether to append to the target file.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "autoflush" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Automatically flush after each write.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "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"
        },
        "encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The character encoding used by this Handler.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "file" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The file description consisting of the path and optional relative to path.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "stability" : "default",
            "value-type" : {
                "relative-to" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.management.path",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "path" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The filesystem path.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "filesystem-path" : true,
                    "stability" : "default"
                }
            }
        },
        "filter-spec" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["filter"],
            "capability-reference" : "org.wildfly.logging.filter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines a pattern for the formatter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n",
            "alternatives" : ["named-formatter"],
            "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,
            "alternatives" : ["formatter"],
            "capability-reference" : "org.wildfly.logging.formatter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

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.

Raw DMR model


{
    "operation-name" : "change-file",
    "description" : "Change the file for a handler.",
    "request-properties" : {"file" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "description" : "Change the file for a handler.",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "stability" : "default",
        "value-type" : {
            "relative-to" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "capability-reference" : "org.wildfly.management.path",
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "path" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The filesystem path.",
                "expressions-allowed" : true,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "filesystem-path" : true,
                "stability" : "default"
            }
        }
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

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.

Raw DMR model


{
    "operation-name" : "change-log-level",
    "description" : "Change the logging level for a handler.",
    "request-properties" : {"level" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The new level to set.",
        "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"
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

disable - Disable a logging handler.

Deprecated Since 1.2.0

Use the write-attribute for the enabled attribute.

Raw DMR model


{
    "operation-name" : "disable",
    "description" : "Disable a logging handler.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute for the enabled attribute."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

enable - Enable a logging handler.

Deprecated Since 1.2.0

Use the write-attribute for the enabled attribute.

Raw DMR model


{
    "operation-name" : "enable",
    "description" : "Enable a logging handler.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute for the enabled attribute."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

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",
        "stability" => "default"
    },
    "creation-time" => {
        "type" => STRING,
        "description" => "The creation time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "last-modified" => {
        "type" => STRING,
        "description" => "The last modified time of a filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "resolved-path" => {
        "type" => STRING,
        "description" => "The resolved filesystem path.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "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",
        "stability" => "default"
    }
}

Raw DMR model


{
    "operation-name" : "path-info",
    "description" : "Obtain the informations for a filesystem path.",
    "request-properties" : {"unit" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "Disk space unit to display disk usage.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "default" : "BYTES",
        "min-length" : 1,
        "max-length" : 2147483647,
        "allowed" : [
            "BYTES",
            "KILOBYTES",
            "MEGABYTES",
            "GIGABYTES",
            "TERABYTES",
            "PETABYTES",
            "BITS",
            "KILOBITS",
            "MEGABITS",
            "GIGABITS",
            "TERABITS",
            "PETABITS"
        ],
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "description" : "Filesystem path for which to obtain disk usage.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "stability" : "default",
        "value-type" : {
            "used-space" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "DOUBLE"
                },
                "description" : "The total size of the contents of a filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "unit" : "BYTES",
                "stability" : "default"
            },
            "creation-time" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The creation time of a filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "last-modified" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The last modified time of a filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "resolved-path" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The resolved filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "available-space" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "DOUBLE"
                },
                "description" : "The total size of available space for the partition containing a filesystem path.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "unit" : "BYTES",
                "stability" : "default"
            }
        }
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Removes the file handler.

Raw DMR model


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

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

Raw DMR model


{
    "operation-name" : "resolve-path",
    "description" : "Resolves a relative path of a previously named paths or one of the standard paths provided by the system.",
    "request-properties" : {"relative-to-only" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "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.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The resolved path from the relative path attribute."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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.

Raw DMR model


{
    "operation-name" : "update-properties",
    "description" : "Update the properties on the existing handler.",
    "request-properties" : {
        "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"
        },
        "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"
        },
        "encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The character encoding used by this Handler.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines a pattern for the formatter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n",
            "alternatives" : ["named-formatter"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "filter-spec" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["filter"],
            "capability-reference" : "org.wildfly.logging.filter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "autoflush" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Automatically flush after each write.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "append" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specify whether to append to the target file.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "file" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The file description consisting of the path and optional relative to path.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "stability" : "default",
            "value-type" : {
                "relative-to" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.management.path",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "path" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The filesystem path.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "filesystem-path" : true,
                    "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,
            "alternatives" : ["formatter"],
            "capability-reference" : "org.wildfly.logging.formatter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

Galleon Features

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

subsystem.logging.logging-profile.file-handler

        
<feature spec="subsystem.logging.logging-profile.file-handler">
  <param name="file-handler" value="{resource name}"/>
  <param name="logging-profile" value="{resource name}"/>
  <param name="append" value="{value}"/>
  <param name="autoflush" value="{value}"/>
  <param name="enabled" value="{value}"/>
  <param name="encoding" value="{value}"/>
  <param name="file" value="{value}"/>
  <param name="filter-spec" value="{value}"/>
  <param name="formatter" value="{value}"/>
  <param name="level" value="{value}"/>
  <param name="named-formatter" value="{value}"/>
<feature/>