Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
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.
The following components have a direct composition relation to Debug Targets:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| debug-scope | None |
| debug-level | |
| debug-category | |
| omit-method-entry-arguments | |
| omit-method-return-value | |
| include-throwable-cause | |
| throwable-stack-frames | |
| description |
| Description | Specifies the fully-qualified 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, com.unboundid.directory.server.core.DirectoryServer#startUp). |
| Default Value | None |
| Allowed Values | The fully-qualified Java package, class, or method name. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the lowest severity level of debug messages to log. |
| Default Value | None |
| Allowed Values | disabled - No messages are logged. error - Messages with severity level of ERROR or higher are logged. warning - Messages with severity level of WARNING 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. all - Messages with any severity level are logged. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| 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. Modification requires no further action |
| 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. Modification requires no further action |
| 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. Modification requires no further action |
| Description | Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| 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 limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | A description for this Debug Target |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Debug Targets:
dsconfig list-debug-targets
[--property {propertyName}] ...
To view the configuration for an existing Debug Target:
dsconfig get-debug-target-prop
--target-name {name}
--publisher-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Debug Target:
dsconfig set-debug-target-prop
--target-name {name}
--publisher-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Debug Target:
dsconfig create-debug-target
--target-name {name}
--publisher-name {name}
--set debug-level:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Debug Target:
dsconfig delete-debug-target
--target-name {name}
--publisher-name {name}