--- title: File Based Debug Log Publisher description: File Based Debug Log Publishers publish debug messages to the file system. component: pingds version: 7.3 page_id: pingds:configref:objects-file-based-debug-log-publisher canonical_url: https://docs.pingidentity.com/pingds/7.3/configref/objects-file-based-debug-log-publisher.html section_ids: parent: Parent dependencies: Dependencies file_based_debug_log_publisher_properties: File Based Debug Log Publisher properties basic_properties: Basic properties append: append default-debug-exceptions-only: default-debug-exceptions-only default-include-throwable-cause: default-include-throwable-cause default-omit-method-entry-arguments: default-omit-method-entry-arguments default-omit-method-return-value: default-omit-method-return-value default-throwable-stack-frames: default-throwable-stack-frames enabled: enabled log-file: log-file log-file-permissions: log-file-permissions retention-policy: retention-policy rotation-policy: rotation-policy advanced_properties: Advanced properties asynchronous: asynchronous auto-flush: auto-flush buffer-size: buffer-size java-class: java-class queue-size: queue-size time-interval: time-interval --- # 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](objects-debug-log-publisher.html). ## Dependencies File Based Debug Log Publishers depend on the following objects: * [Log Retention Policy](objects-log-retention-policy.html) * [Log Rotation Policy](objects-log-rotation-policy.html) ## File Based Debug Log Publisher properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [append](#append) [default-debug-exceptions-only](#default-debug-exceptions-only) [default-include-throwable-cause](#default-include-throwable-cause) [default-omit-method-entry-arguments](#default-omit-method-entry-arguments) [default-omit-method-return-value](#default-omit-method-return-value) [default-throwable-stack-frames](#default-throwable-stack-frames) [enabled](#enabled) [log-file](#log-file) [log-file-permissions](#log-file-permissions) [retention-policy](#retention-policy) [rotation-policy](#rotation-policy) | [asynchronous](#asynchronous) [auto-flush](#auto-flush) [buffer-size](#buffer-size) [java-class](#java-class) [queue-size](#queue-size) [time-interval](#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* | truefalse | | *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* | truefalse | | *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* | truefalse | | *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* | truefalse | | *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* | truefalse | | *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* | truefalse | | *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](objects-log-retention-policy.html). | | *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](objects-log-rotation-policy.html). | | *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* | truefalse | | *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* | truefalse | | *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](size-syntax.html).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* | Uses [duration syntax](duration-syntax.html).Lower limit: 1 milliseconds. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |