Debug Target
Debug Targets define the types of messages logged by the debug logPublisher.
Debug targets allow for fine-grain control of which messages are logged based on the package, class, or method that generated the message. Each debug target configuration entry resides below the entry with RDN of "cn=Debug Target" immediately below the parent ds-cfg-debug-log-publisher entry.
Debug Target Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
| Basic Properties |
|---|
debug-exceptions-only |
debug-exceptions-only
Synopsis |
Indicates whether only logs with exception should be logged. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
debug-scope
Synopsis |
Specifies the fully-qualified OpenDJ Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp). |
Default Value |
None |
Allowed Values |
The fully-qualified OpenDJ Java package, class, or method name. |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
Yes |
enabled
Synopsis |
Indicates whether the Debug Target is enabled. |
Default Value |
None |
Allowed Values |
true false |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
include-throwable-cause
Synopsis |
Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
omit-method-entry-arguments
Synopsis |
Specifies the property to indicate whether to include method arguments in debug messages. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
omit-method-return-value
Synopsis |
Specifies the property to indicate whether to include the return value in debug messages. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
throwable-stack-frames
Synopsis |
Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages. |
Default Value |
0 |
Allowed Values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |