Debug Log Publisher

This is an abstract object type that cannot be instantiated.

Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.

Debug log messages provide information that can be used for debugging or troubleshooting problems in the server, or for providing more detailed information about the processing that the server performs.

Debug Log Publishers

The following Debug Log Publishers are available:

These Debug Log Publishers inherit the properties described below.

Parent

The Debug Log Publisher object inherits from Log Publisher.

Dependencies

The following objects belong to Debug Log Publishers:

Debug Log Publisher Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties

default-debug-exceptions-only
default-include-throwable-cause
default-omit-method-entry-arguments
default-omit-method-return-value
default-throwable-stack-frames
enabled
java-class

Basic Properties

Use the --advanced option to access advanced properties.

default-debug-exceptions-only

Synopsis

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

No

Read-Only

No

default-include-throwable-cause

Synopsis

Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.

Default Value

true

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

default-omit-method-entry-arguments

Synopsis

Indicates whether to include method arguments in debug messages logged by default.

Default Value

false

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

default-omit-method-return-value

Synopsis

Indicates whether to include the return value in debug messages logged by default.

Default Value

false

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

default-throwable-stack-frames

Synopsis

Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.

Default Value

2147483647

Allowed Values

An integer.

Lower limit: 0.

Upper limit: 2147483647.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

enabled

Synopsis

Indicates whether the Log Publisher is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

java-class

Synopsis

The fully-qualified name of the Java class that provides the Debug Log Publisher implementation.

Default Value

org.opends.server.loggers.DebugLogPublisher

Allowed Values

A Java class that extends or implements:

  • org.opends.server.loggers.LogPublisher

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No