File Based Debug Log Publishers publish debug messages to the file system.
The File Based Debug Log Publisher component inherits from the Debug Log Publisher
The following components have a direct AGGREGATION relation FROM File Based Debug Log Publishers :
A description of each property follows.
Basic Properties: | Advanced Properties: |
---|---|
↓ append | ↓ asynchronous |
↓ default-debug-category | ↓ auto-flush |
↓ default-debug-level | ↓ buffer-size |
↓ default-include-throwable-cause | ↓ java-class |
↓ default-omit-method-entry-arguments | ↓ queue-size |
↓ default-omit-method-return-value | ↓ time-interval |
↓ default-throwable-stack-frames | |
↓ enabled | |
↓ log-file | |
↓ log-file-permissions | |
↓ log-file-use-local-time | |
↓ retention-policy | |
↓ rotation-policy |
Description | Specifies whether to append to existing log files. |
---|---|
Default Value | true |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The debug message categories to be logged when none of the defined targets match the message. |
---|---|
Default Value | Messages with any category will be logged if they have a sufficient debug level. |
Allowed Values | caught - Exception caught. constructor - Constructor entry. data - Raw data dump. database-access - Access to a backend database. enter - Method entry. exit - Method exit. message - Arbitrary debug message. protocol - Protocol element dump. thrown - Exception throw from method. |
Multi-valued | Yes |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The lowest severity level of debug messages to log when none of the defined targets match the message. |
---|---|
Default Value | error |
Allowed Values | all - Messages with any severity level will be logged. disabled - No messages will be logged. error - Messages with severity level of ERROR or higher will be logged. finer - Messages with severity level of FINER or higher will be logged. info - Messages with severity level of INFO or higher will be logged. verbose - Messages with severity level of VERBOSE or higher will be logged. warning - Messages with severity level of WARNING or higher will be logged. |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
default-include-throwable-cause
Description | Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default. |
---|---|
Default Value | true |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
default-omit-method-entry-arguments
Description | Indicates whether to include method arguments in debug messages logged by default. |
---|---|
Default Value | false |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
default-omit-method-return-value
Description | Indicates whether to include the return value in debug messages logged by default. |
---|---|
Default Value | false |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
default-throwable-stack-frames
Description | Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages. |
---|---|
Default Value | 2147483647 |
Allowed Values | An integer value. Lower value is 0. Upper value is 2147483647 . |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | Indicates whether the Log Publisher is enabled for use. |
---|---|
Default Value | None |
Allowed Values | true false |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The file name to use for the log files generated by the File Based Debug Log Publisher . The path to the file is relative to the server root. |
---|---|
Default Value | None |
Allowed Values | A String |
Multi-valued | No |
Required | Yes |
Admin Action Required | The File Based Debug Log Publisher must be disabled and re-enabled for changes to this setting to take effect |
Advanced Property | No |
Read-only | No |
Description | The UNIX permissions of the log files created by this File Based Debug Log Publisher . |
---|---|
Default Value | 640 |
Allowed Values | A valid UNIX mode string. The mode string must contain three digits between zero and seven. |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | Specifies whether to use local time or GMT for the name of the rotated files. |
---|---|
Default Value | false |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The retention policy to use for the File Based Debug Log Publisher . When multiple policies are used, log files are cleaned when any of the policy's conditions are met. |
---|---|
Default Value | No retention policy is used and log files are never cleaned. |
Allowed Values | The DN of any Log Retention Policy. |
Multi-valued | Yes |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The rotation policy to use for the File Based Debug Log Publisher . When multiple policies are used, rotation will occur if any policy's conditions are met. |
---|---|
Default Value | No rotation policy is used and log rotation will not occur. |
Allowed Values | The DN of any Log Rotation Policy. |
Multi-valued | Yes |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | Indicates whether the File Based Debug Log Publisher will publish records asynchronously. |
---|---|
Default Value | false |
Allowed Values | true false |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Specifies whether to flush the writer after every log record. If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written. |
---|---|
Default Value | true |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Specifies the log file buffer size. |
---|---|
Default Value | 64kb |
Allowed Values | A positive integer representing a size. Lower value is 1. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | The fully-qualified name of the Java class that provides the File Based Debug Log Publisher implementation. |
---|---|
Default Value | org.opends.server.loggers.debug.TextDebugLogPublisher |
Allowed Values | A java class that implements or extends the class(es) : org.opends.server.api.DebugLogPublisher |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | The maximum number of log records that can be stored in the asynchronous queue. |
---|---|
Default Value | 5000 |
Allowed Values | An integer value. Lower value is 1. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Specifies the interval at which to check whether the log files need to be rotated. |
---|---|
Default Value | 5s |
Allowed Values | A duration Syntax. Lower limit is 1 milliseconds. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |