Configuration Reference Home
OpenDJ - Debug Target

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.

Relations To this Component

The following components have a direct COMPOSITION relation TO Debug Targets :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ debug-exceptions-only  None
↓ debug-scope
↓ enabled
↓ include-throwable-cause
↓ omit-method-entry-arguments
↓ omit-method-return-value
↓ throwable-stack-frames

Basic Properties

debug-exceptions-only

Description
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 Property
No
Read-only
No

debug-scope

Description
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 Property
No
Read-only
Yes

enabled

Description
Indicates whether the Debug Target is enabled.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

include-throwable-cause

Description
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 Property
No
Read-only
No

omit-method-entry-arguments

Description
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 Property
No
Read-only
No

omit-method-return-value

Description
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 Property
No
Read-only
No

throwable-stack-frames

Description
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 value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No