File Based Debug Log Publisher

File Based Debug Log Publishers publish debug messages to the file system.

Parent

The File Based Debug Log Publisher object inherits from Debug Log Publisher.

Dependencies

File Based Debug Log Publishers depend on the following objects:

File Based Debug Log Publisher Properties

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

Basic Properties Advanced Properties

append
default-debug-exceptions-only
default-include-throwable-cause
default-omit-method-entry-arguments
default-omit-method-return-value
default-throwable-stack-frames
enabled
log-file
log-file-permissions
retention-policy
rotation-policy

asynchronous
auto-flush
buffer-size
java-class
queue-size
time-interval

Basic Properties

Use the --advanced option to access advanced properties.

append

Synopsis

Specifies whether to append to existing log files.

Default Value

true

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

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

log-file

Synopsis

The file name to use for the log files generated by the File Based Debug Log Publisher .

Description

The path to the file is relative to the server root.

Default Value

None

Allowed Values

A string.

Multi-valued

No

Required

Yes

Admin Action Required

The object must be disabled and re-enabled for changes to take effect.

Advanced

No

Read-Only

No

log-file-permissions

Synopsis

The UNIX permissions of the log files created by this File Based Debug Log Publisher .

Default Value

640

Allowed Values

A valid UNIX mode string. The mode string must contain three digits between zero and seven.

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

retention-policy

Synopsis

The retention policy to use for the File Based Debug Log Publisher .

Description

When multiple policies are used, log files are cleaned when any of the policy’s conditions are met.

Default Value

No retention policy is used and log files are never cleaned.

Allowed Values

The name of an existing log-retention-policy.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

rotation-policy

Synopsis

The rotation policy to use for the File Based Debug Log Publisher .

Description

When multiple policies are used, rotation will occur if any policy’s conditions are met.

Default Value

No rotation policy is used and log rotation will not occur.

Allowed Values

The name of an existing log-rotation-policy.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

asynchronous

Synopsis

Indicates whether the File Based Debug Log Publisher will publish records asynchronously.

Default Value

false

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

Yes

Read-Only

No

auto-flush

Synopsis

Specifies whether to flush the writer after every log record.

Description

If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.

Default Value

true

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

buffer-size

Synopsis

Specifies the log file buffer size.

Default Value

64kb

Allowed Values

Uses size syntax.

Lower limit: 1.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

java-class

Synopsis

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

Default Value

org.opends.server.loggers.TextDebugLogPublisher

Allowed Values

A Java class that extends or implements:

  • org.opends.server.loggers.LogPublisher

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

Yes

Read-Only

No

queue-size

Synopsis

The maximum number of log records that can be stored in the asynchronous queue.

Default Value

5000

Allowed Values

An integer.

Lower limit: 1.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

time-interval

Synopsis

Specifies the interval at which to check whether the log files need to be rotated.

Default Value

5s

Allowed Values

Lower limit: 1 milliseconds.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No