Defines a handler which writes to a file.
Attribute | Value |
---|---|
Default Value | true |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | true |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | true |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | OBJECT |
Nillable | false |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Capability reference | |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | ALL |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Allowed Values | ALL FINEST FINER TRACE DEBUG FINE CONFIG INFO WARN WARNING ERROR SEVERE FATAL OFF |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-only |
Attribute | Value |
---|---|
Capability reference | |
Type | STRING |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
append | BOOLEAN | false | true | true | Specify whether to append to the target file. |
autoflush | BOOLEAN | false | true | true | Automatically flush after each write. |
enabled | BOOLEAN | false | true | true | If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages. |
encoding | STRING | false | true | The character encoding used by this Handler. | |
file | OBJECT | true | false | The file description consisting of the path and optional relative to path. | |
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.*")) | |
formatter | STRING | false | true | %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n | Defines a pattern for the formatter. |
level | STRING | false | true | ALL | The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded. |
name | STRING | false | false | The name of the handler. | |
named-formatter | STRING | false | false | The name of the defined formatter to be used on the handler. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
file | OBJECT | true | false | Change the file for a handler. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
level | STRING | false | true | ALL | The new level to set. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
unit | STRING | false | false | BYTES | Disk space unit to display disk usage. |
{
"used-space" => {
"type" => DOUBLE,
"description" => "The total size of the contents of a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"unit" => "BYTES"
},
"creation-time" => {
"type" => STRING,
"description" => "The creation time of a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"last-modified" => {
"type" => STRING,
"description" => "The last modified time of a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"resolved-path" => {
"type" => STRING,
"description" => "The resolved filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"available-space" => {
"type" => DOUBLE,
"description" => "The total size of available space for the partition containing a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"unit" => "BYTES"
}
}
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
relative-to-only | BOOLEAN | false | false | Indicates whether only the relative-to attribute should be resolved or the full path should be resolved. The default is false meaning the entire path will be resolved. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
level | STRING | false | true | ALL | The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded. |
enabled | BOOLEAN | false | true | true | If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages. |
encoding | STRING | false | true | The character encoding used by this Handler. | |
formatter | STRING | false | true | %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n | Defines a pattern for the formatter. |
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.*")) | |
autoflush | BOOLEAN | false | true | true | Automatically flush after each write. |
append | BOOLEAN | false | true | true | Specify whether to append to the target file. |
file | OBJECT | true | false | The file description consisting of the path and optional relative to path. | |
named-formatter | STRING | false | false | The name of the defined formatter to be used on the handler. |