---
title: Debug Target
description: Debug Targets define the types of messages logged by the debug logPublisher.
component: pingds
version: 7.3
page_id: pingds:configref:objects-debug-target
canonical_url: https://docs.pingidentity.com/pingds/7.3/configref/objects-debug-target.html
section_ids:
  dependencies: Dependencies
  debug_target_properties: Debug Target properties
  basic_properties: Basic properties
  debug-exceptions-only: debug-exceptions-only
  debug-scope: debug-scope
  enabled: enabled
  include-throwable-cause: include-throwable-cause
  omit-method-entry-arguments: omit-method-entry-arguments
  omit-method-return-value: omit-method-return-value
  throwable-stack-frames: throwable-stack-frames
---

# 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:

* [Debug Log Publisher](objects-debug-log-publisher.html)

## Debug Target properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                                                                                                                                                                                                                                                                                                        |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [debug-exceptions-only](#debug-exceptions-only) [debug-scope](#debug-scope) [enabled](#enabled) [include-throwable-cause](#include-throwable-cause) [omit-method-entry-arguments](#omit-method-entry-arguments) [omit-method-return-value](#omit-method-return-value) [throwable-stack-frames](#throwable-stack-frames) |

### Basic properties

Use the `--advanced` option to access advanced properties.

### debug-exceptions-only

|                         |                                                              |
| ----------------------- | ------------------------------------------------------------ |
| *Synopsis*              | Indicates whether only logs with exception should be logged. |
| *Default value*         | false                                                        |
| *Allowed values*        | truefalse                                                    |
| *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*        | truefalse                                      |
| *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*        | truefalse                                                                                                              |
| *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*        | truefalse                                                                                 |
| *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*        | truefalse                                                                                 |
| *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                                                                                                                                          |