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.

Dependencies

The following objects have Debug Targets:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

debug-exceptions-only

SynopsisIndicates whether only logs with exception should be logged.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

debug-scope

SynopsisSpecifies 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 ValueNone
Allowed ValuesThe fully-qualified OpenDJ Java package, class, or method name.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyYes

enabled

SynopsisIndicates whether the Debug Target is enabled.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

include-throwable-cause

SynopsisSpecifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

omit-method-entry-arguments

SynopsisSpecifies the property to indicate whether to include method arguments in debug messages.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

omit-method-return-value

SynopsisSpecifies the property to indicate whether to include the return value in debug messages.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

throwable-stack-frames

SynopsisSpecifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.
Default Value0
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo