Management API Reference for pattern-formatter

A pattern formatter to be used with handlers.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.logging.formatter	true	/subsystem=logging/logging-profile=/custom-formatter= /subsystem=logging/custom-formatter=* /subsystem=logging/logging-profile=/json-formatter= /subsystem=logging/json-formatter=* /subsystem=logging/logging-profile=/xml-formatter= /subsystem=logging/xml-formatter=* /subsystem=logging/logging-profile=/pattern-formatter=

Attributes (2)

color-map - The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite

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 color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

pattern - 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", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Adds a new pattern formatter.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
color-map	STRING	false	true		The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite
pattern	STRING	false	true	%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n	Defines a pattern for the formatter.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a new pattern formatter.",
    "request-properties" : {
        "color-map" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "pattern" : {
            "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",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the pattern formatter.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the pattern formatter.",
    "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.pattern-formatter

        
<feature spec="subsystem.logging.pattern-formatter">
  <param name="pattern-formatter" value="{resource name}"/>
  <param name="color-map" value="{value}"/>
  <param name="pattern" value="{value}"/>
<feature/>