--- title: File Based Error Log Publisher description: File Based Error Log Publishers publish error messages to the file system. component: pingds version: 8.1 page_id: pingds:configref:objects-file-based-error-log-publisher canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-file-based-error-log-publisher.html section_ids: parent: Parent dependencies: Dependencies file_based_error_log_publisher_properties: File Based Error Log Publisher properties basic_properties: Basic properties append: append default-severity: default-severity enabled: enabled json-output: json-output log-file: log-file log-file-permissions: log-file-permissions override-severity: override-severity 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 Error Log Publisher File Based Error Log Publishers publish error messages to the file system. ## Parent The File Based Error Log Publisher object inherits from [Error Log Publisher](objects-error-log-publisher.html). ## Dependencies File Based Error 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 Error 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-severity](#default-severity) [enabled](#enabled) [json-output](#json-output) [log-file](#log-file) [log-file-permissions](#log-file-permissions) [override-severity](#override-severity) [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-severity | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | Specifies the default severity level for the logger. | | *Default value* | notice | | *Allowed values* | * debug: The error log severity that is used for messages that provide debugging information triggered during processing. * error: The error log severity that is used for messages that provide information about errors which may force the server to shut down or operate in a significantly degraded state. * info: The error log severity that is used for messages that provide information about significant events within the server that are not warnings or errors. * none: No messages of any severity are logged by default. This value is intended to be used in conjunction with the override-severity property to define an error logger that will publish no error message beside the errors of a given category. * notice: The error log severity that is used for the most important informational messages (i.e., information that should almost always be logged but is not associated with a warning or error condition). * warning: The error log severity that is used for messages that provide information about warnings triggered during processing. | | *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 | ### json-output | | | | ----------------------- | ---------------------------------------------------------------------------------- | | *Synopsis* | Output log lines using JSON format (structured logging) instead of free form text. | | *Default value* | false | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *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 Error Log Publisher . | | *Description* | The path to the file is relative to the instance directory path. | | *Default value* | None | | *Allowed values* | A path to an existing file that is readable (and/or writeable) by the server. | | *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 Error 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 | ### override-severity | | | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the override severity level for the logger based on the category of the messages. | | *Description* | Each override severity level should include the category and the severity level to log for that category, for example, core=info. Valid categories are: core, extensions, protocol, config, log, util, schema, plugin, jeb, backend, tools, task, access-control, admin, sync, version, setup, admin-tool, dsconfig, user-defined. Valid severities are: error, warning, notice, info, debug. | | *Default value* | All messages with the default severity levels are logged. | | *Allowed values* | A string in the form category=severity | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### retention-policy | | | | ----------------------- | ------------------------------------------------------------------------------------------------------- | | *Synopsis* | The retention policy to use for the File Based Error Log Publisher . | | *Description* | When multiple policies are used, log files will be cleaned when any of the policy's conditions are met. | | *Default value* | No retention policy is used and log files will never be 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 Error 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 Error Log Publisher will publish records asynchronously. | | *Default value* | true | | *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 will be 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 Error Log Publisher implementation. | | *Default value* | org.opends.server.loggers.TextErrorLogPublisher | | *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 |