Note: this is an abstract component, that cannot be instantiated.
Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.
Debug log messages provide information that can be used for debugging or troubleshooting problems in the server, or for providing more detailed information about the processing that the server performs.
The following Debug Log Publishers are available in the server :
These Debug Log Publishers inherit from the properties described below.
The Debug Log Publisher component inherits from the Log Publisher
The following components have a direct COMPOSITION relation FROM Debug Log Publishers :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ default-debug-category | None |
| ↓ default-debug-level | |
| ↓ default-include-throwable-cause | |
| ↓ default-omit-method-entry-arguments | |
| ↓ default-omit-method-return-value | |
| ↓ default-throwable-stack-frames | |
| ↓ enabled | |
| ↓ java-class |
| 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. 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 fully-qualified name of the Java class that provides the Debug Log Publisher implementation. |
|---|---|
| Default Value | None |
| 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 | No |
| Read-only | No |