File Based Error Log Publisher

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-severity

Synopsis	Specifies the default severity levels for the logger.
Default Value	error warning
Allowed Values	all: Messages of all severity levels are logged. 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	Yes
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 Error 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 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 levels for the logger based on the category of the messages.
Description	Each override severity level should include the category and the severity levels to log for that category, for example, core=error,info,warning. 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: all, error, info, warning, notice, debug.
Default Value	All messages with the default severity levels are logged.
Allowed Values	A string in the form category=severity1,severity2...
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 .
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 .
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	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 will be 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 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 . Lower limit: 1 milliseconds.
Multi-valued	No
Required	No
Admin Action Required	None
Advanced	Yes
Read-Only	No