Management API Reference for root-logger=ROOT

Defines the root logger for this log context.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.logging.logger	true	/subsystem=logging/root-logger=ROOT /subsystem=logging/logger=* /subsystem=logging/logging-profile=/logger=

Attributes (3)

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" }

handlers - The handlers associated with the root logger.

Type	LIST
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" : "LIST" }, "description" : "The handlers associated with the root logger.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.logging.handler", "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

level - The log level specifying which message levels will be logged by the root 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 the root 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 }

Operations (9)

add - Adds the root logger.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
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.*"))
handlers	LIST	false	false		The handlers associated with the root logger.
level	STRING	false	true	ALL	The log level specifying which message levels will be logged by the root logger. Message levels lower than this value will be discarded.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the root logger.",
    "request-properties" : {
        "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"
        },
        "handlers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The handlers associated with the root logger.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.logging.handler",
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The log level specifying which message levels will be logged by the root 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"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

add-handler - Adds a handler to the logger.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to add.

Raw DMR model


{
    "operation-name" : "add-handler",
    "description" : "Adds a handler to the logger.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to add.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

change-root-log-level - Change the root logger level.

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 level to set the root logger to.

Raw DMR model


{
    "operation-name" : "change-root-log-level",
    "description" : "Change the root logger level.",
    "request-properties" : {"level" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The level to set the root logger to.",
        "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
}

remove - Remove the root logger.

Raw DMR model


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

remove-handler - Removes a handler from the logger.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the logger to remove.

Raw DMR model


{
    "operation-name" : "remove-handler",
    "description" : "Removes a handler from the logger.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the logger to remove.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove-root-logger - Remove the root logger.

Deprecated Since 1.2.0

Use the remove operation.

Raw DMR model


{
    "operation-name" : "remove-root-logger",
    "description" : "Remove the root logger.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the remove operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

root-logger-assign-handler - Assign a Handler to the root logger.

Deprecated Since 1.2.0

Use the add-handler operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to add.

Raw DMR model


{
    "operation-name" : "root-logger-assign-handler",
    "description" : "Assign a Handler to the root logger.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to add.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the add-handler operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

root-logger-unassign-handler - Unassign a Handler from the root logger.

Deprecated Since 1.2.0

Use the remove-handler operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to remove.

Raw DMR model


{
    "operation-name" : "root-logger-unassign-handler",
    "description" : "Unassign a Handler from the root logger.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to remove.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the remove-handler operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

set-root-logger - Same as add operation

Deprecated Since 1.2.0

Use the add operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
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.*"))
level	STRING	false	true	ALL	The log level specifying which message levels will be logged by the root logger. Message levels lower than this value will be discarded.
handlers	LIST	false	false		The handlers associated with the root logger.

Raw DMR model


{
    "operation-name" : "set-root-logger",
    "description" : "Same as add operation",
    "request-properties" : {
        "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"
        },
        "level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The log level specifying which message levels will be logged by the root 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"
        },
        "handlers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The handlers associated with the root logger.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.logging.handler",
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the add 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.root-logger.ROOT

        
<feature spec="subsystem.logging.logging-profile.root-logger.ROOT">
  <param name="logging-profile" value="{resource name}"/>
  <param name="filter-spec" value="{value}"/>
  <param name="handlers" value="{value}"/>
  <param name="level" value="{value}"/>
<feature/>