Management API Reference for json-formatter

A formatter that formats log messages in JSON.

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/logging-profile=/xml-formatter= /subsystem=logging/xml-formatter=* /subsystem=logging/logging-profile=/pattern-formatter= /subsystem=logging/pattern-formatter=*

Attributes (8)

date-format - The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.

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 date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.", "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 }

exception-output-type - Indicates how the cause of the logged message, if one is available, will be added to the JSON output.

Type	STRING
Default Value	detailed
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	detailed-and-formatted detailed formatted
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates how the cause of the logged message, if one is available, will be added to the JSON output.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "detailed", "allowed" : [ "detailed", "formatted", "detailed-and-formatted" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

key-overrides - Allows the names of the keys for the JSON properties to be overridden.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Allows the names of the keys for the JSON properties to be overridden.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "exception" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of exception to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-caused-by" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of causedBy to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-circular-reference" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of circularReference to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-frame" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of frame to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-frame-class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of class to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-frame-line" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of line to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-frame-method" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of method to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-frames" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of frames to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-message" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of message to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-reference-id" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of refId to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-suppressed" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of suppressed to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "exception-type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of exceptionType to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "host-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of hostName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "level" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of level to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "logger-class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of loggerClassName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "logger-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of loggerName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "mdc" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of mdc to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "message" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of message to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "ndc" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of ndc to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "process-id" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of processId to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "process-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of processName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "record" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of record to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "sequence" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sequence to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sourceClassName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-file-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sourceFileName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-line-number" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sourceLineNumber to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-method-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sourceMethodName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-module-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sourceModuleName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "source-module-version" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of sourceModuleVersion to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "stack-trace" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of stackTrace to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "thread-id" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of threadId to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "thread-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of threadName to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "timestamp" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Allows the default key of timestamp to be overridden to the value provided.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

meta-data - Sets the meta data to use in the JSON format. Properties will be added to each log message.

Type	OBJECT
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" : "OBJECT" }, "description" : "Sets the meta data to use in the JSON format. Properties will be added to each log message.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

pretty-print - Indicates whether or not pretty printing should be used when formatting.

Type	BOOLEAN
Default Value	false
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" : "Indicates whether or not pretty printing should be used when formatting.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

print-details - Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, source module name, source module version and source line number.

Type	BOOLEAN
Default Value	false
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" : "Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, source module name, source module version and source line number.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

record-delimiter - The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.

Type	STRING
Default Value
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 value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "\n", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

zone-id - The zone ID for formatting the date and time. The system default is used if left undefined.

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 zone ID for formatting the date and time. The system default is used if left undefined.", "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 }`

Operations (2)

add - Adds a new JSON formatter.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
date-format	STRING	false	true		The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.
exception-output-type	STRING	false	true	detailed	Indicates how the cause of the logged message, if one is available, will be added to the JSON output.
key-overrides	OBJECT	false	false		Allows the names of the keys for the JSON properties to be overridden.
meta-data	OBJECT	false	false		Sets the meta data to use in the JSON format. Properties will be added to each log message.
pretty-print	BOOLEAN	false	true	false	Indicates whether or not pretty printing should be used when formatting.
print-details	BOOLEAN	false	true	false	Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, source module name, source module version and source line number.
record-delimiter	STRING	false	true		The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.
zone-id	STRING	false	true		The zone ID for formatting the date and time. The system default is used if left undefined.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a new JSON formatter.",
    "request-properties" : {
        "date-format" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "exception-output-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Indicates how the cause of the logged message, if one is available, will be added to the JSON output.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "detailed",
            "allowed" : [
                "detailed",
                "formatted",
                "detailed-and-formatted"
            ],
            "stability" : "default"
        },
        "key-overrides" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Allows the names of the keys for the JSON properties to be overridden.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "exception" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of exception to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-caused-by" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of causedBy to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-circular-reference" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of circularReference to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-frame" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of frame to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-frame-class" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of class to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-frame-line" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of line to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-frame-method" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of method to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-frames" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of frames to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-message" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of message to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-reference-id" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of refId to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-suppressed" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of suppressed to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "exception-type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of exceptionType to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "host-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of hostName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "level" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of level to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "logger-class-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of loggerClassName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "logger-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of loggerName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "mdc" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of mdc to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "message" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of message to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "ndc" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of ndc to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "process-id" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of processId to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "process-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of processName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "record" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of record to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "sequence" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sequence to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "source-class-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sourceClassName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "source-file-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sourceFileName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "source-line-number" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sourceLineNumber to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "source-method-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sourceMethodName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "source-module-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sourceModuleName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "source-module-version" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of sourceModuleVersion to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "stack-trace" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of stackTrace to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "thread-id" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of threadId to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "thread-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of threadName to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "timestamp" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Allows the default key of timestamp to be overridden to the value provided.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "meta-data" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Sets the meta data to use in the JSON format. Properties will be added to each log message.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "pretty-print" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether or not pretty printing should be used when formatting.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "print-details" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, source module name, source module version and source line number.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "record-delimiter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "\n",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "zone-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The zone ID for formatting the date and time. The system default is used if left undefined.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the JSON formatter.

Raw DMR model


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

        
<feature spec="subsystem.logging.json-formatter">
  <param name="json-formatter" value="{resource name}"/>
  <param name="date-format" value="{value}"/>
  <param name="exception-output-type" value="{value}"/>
  <param name="key-overrides" value="{value}"/>
  <param name="meta-data" value="{value}"/>
  <param name="pretty-print" value="{value}"/>
  <param name="print-details" value="{value}"/>
  <param name="record-delimiter" value="{value}"/>
  <param name="zone-id" value="{value}"/>
<feature/>