Management API Reference for file-handler

A file handler for use with the management audit logging service.

Deprecated Since 1.7.0

The management audit log configuration is deprecated and may be removed or moved in future versions.

Attributes (7)

disabled-due-to-failure - Whether this handler has been disabled due to logging failures.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether this handler has been disabled due to logging failures.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

failure-count - The number of logging failures since the handler was initialized.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of logging failures since the handler was initialized.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

formatter - The formatter used to format the log messages.

Type	STRING
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 formatter used to format the log messages.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

max-failure-count - The maximum number of logging failures before disabling this handler.

Type	INT
Default Value	10
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
Min	0
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of logging failures before disabling this handler.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

path - The path of the audit log file.

Type	STRING
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 path of the audit log file.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

relative-to - 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.

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

rotate-at-startup - Whether the old log file should be rotated at server startup.

Type	BOOLEAN
Default Value	true
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" : "BOOLEAN" }, "description" : "Whether the old log file should be rotated at server startup.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (3)

add - Adds an audit log file handler.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
formatter	STRING	true	false		The formatter used to format the log messages.
max-failure-count	INT	false	true	10	The maximum number of logging failures before disabling this handler.
path	STRING	true	true		The path of the audit log file.
relative-to	STRING	false	false		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.
rotate-at-startup	BOOLEAN	false	false	true	Whether the old log file should be rotated at server startup.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds an audit log file handler.",
    "request-properties" : {
        "formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The formatter used to format the log messages.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "max-failure-count" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of logging failures before disabling this handler.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "min" : 0,
            "max" : 2147483647,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The path of the audit log file.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "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,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "rotate-at-startup" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether the old log file should be rotated at server startup.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

recycle - Resets the file handler failure count, and backs up the current log file.

Raw DMR model


{
    "operation-name" : "recycle",
    "description" : "Resets the file handler failure count, and backs up the current log file.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - Removes an audit log file handler.

Raw DMR model


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

Galleon Features

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

core-service.management.access.audit.file-handler

        
<feature spec="core-service.management.access.audit.file-handler">
  <param name="file-handler" value="{resource name}"/>
  <param name="formatter" value="{value}"/>
  <param name="max-failure-count" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
  <param name="rotate-at-startup" value="{value}"/>
<feature/>