Management API Reference for logger

It defines a logger category.

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=*/root-logger=ROOT

Attributes (5)

category - Specifies the category for the logger.

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" : "Specifies the category for the logger.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "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" }

handlers - The handlers associated with the 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 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 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 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 }

use-parent-handlers - Specifies whether or not this logger should send its output to its parent Logger.

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" : "Specifies whether or not this logger should send its output to its parent Logger.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (7)

add - Add a new logger category.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
category	STRING	false	false		Specifies the category for the logger.
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 logger.
level	STRING	false	true	ALL	The log level specifying which message levels will be logged by the logger. Message levels lower than this value will be discarded.
use-parent-handlers	BOOLEAN	false	true	true	Specifies whether or not this logger should send its output to its parent Logger.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new logger category.",
    "request-properties" : {
        "category" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the category for the logger.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "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"
        },
        "handlers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The handlers associated with the 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 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"
        },
        "use-parent-handlers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies whether or not this logger should send its output to its parent Logger.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "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
}

assign-handler - Assign a Handler to a 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" : "assign-handler",
    "description" : "Assign a Handler to a 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
}

change-log-level - Change the logging level for a logger category.

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 logger category.",
    "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
}

remove - Remove an existing logger category.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove an existing logger category.",
    "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
}

unassign-handler - Unassign a Handler from a 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" : "unassign-handler",
    "description" : "Unassign a Handler from a 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
}

Galleon Features

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

subsystem.logging.logging-profile.logger

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