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.
↓Direct Subcomponents
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
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:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ java-class | |
| ↓ default-debug-level | |
| ↓ default-debug-category | |
| ↓ default-omit-method-entry-arguments | |
| ↓ default-omit-method-return-value | |
| ↓ default-include-throwable-cause | |
| ↓ default-throwable-stack-frames |
| Description | A description for this Log Publisher |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| 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. Modification requires no further action |
| Description | The fully-qualified name of the Java class that provides the Debug Log Publisher implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.DebugLogPublisher |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The lowest severity level of debug messages to log when none of the defined targets match the message. |
| Default Value | error |
| Allowed Values | disabled - No messages will be logged. error - Messages with severity level of ERROR or higher will be logged. warning - Messages with severity level of WARNING 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. all - Messages with any severity level will be logged. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| 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. Modification requires no further action |
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. Modification requires no further action |
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. Modification requires no further action |
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. Modification requires no further action |
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 limit is 0. Upper limit is 2147483647 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Log Publishers:
dsconfig list-log-publishers
[--property {propertyName}] ...
To view the configuration for an existing Log Publisher:
dsconfig get-log-publisher-prop
--publisher-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Log Publisher:
dsconfig set-log-publisher-prop
--publisher-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Log Publisher:
dsconfig delete-log-publisher
--publisher-name {name}