Configuration Reference Home
Oracle Unified Directory - 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-category  None
↓ debug-level
↓ debug-scope
↓ include-throwable-cause
↓ omit-method-entry-arguments
↓ omit-method-return-value
↓ throwable-stack-frames

Basic Properties

debug-category

Description
Specifies the debug message categories to be logged.
Default Value
Messages with any category are 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 thrown from method


Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

debug-level

Description
Specifies the lowest severity level of debug messages to log.
Default Value
None
Allowed Values
all - Messages with any severity level are logged.

disabled - No messages are logged.

error - Messages with severity level of ERROR or higher are logged.

info - Messages with severity level of INFO or higher are logged.

verbose - Messages with severity level of VERBOSE or higher are logged.

warning - Messages with severity level of WARNING or higher are logged.


Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

debug-scope

Description
Specifies the fully-qualified Oracle Unified Directory 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 Oracle Unified Directory Java package, class, or method name.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes

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


Copyright © 2011,2012, Oracle and/or its affiliates. All rights reserved.