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 Property
No
Read-only
No
enabled
Description
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 Property
No
Read-only
No
filtering-policy
Description
Specifies how filtering criteria should be applied to log records.
Default Value
no-filtering
Allowed Values
exclusive - Records must not match any of the filtering criteria in order to be logged.
inclusive - Records must match at least one of the filtering criteria in order to be logged.
no-filtering - No filtering will be performed, and all records will be logged.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
log-control-oids
Description
Specifies whether control OIDs will be included in operation log records.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
log-file
Description
The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.
Default Value
None
Allowed Values
A path to an existing file that is readable by the server.
Multi-valued
No
Required
Yes
Admin Action Required
The File Based Access Log Publisher must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
log-file-permissions
Description
The UNIX permissions of the log files created by this File Based Access 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 Property
No
Read-only
No
log-format
Description
Specifies how log records should be formatted and written to the access log.
Default Value
multi-line
Allowed Values
combined - Combine log records for operation requests and responses into a single record. This format should be used when log records are to be filtered based on response criteria (e.g. result code).
multi-line - Outputs separate log records for operation requests and responses.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
log-record-time-format
Description
Specifies the format string that is used to generate log record timestamps.
Default Value
dd/MMM/yyyy:HH:mm:ss Z
Allowed Values
Any valid format string that can be used with the java.text.SimpleDateFormat class.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
retention-policy
Description
The retention policy to use for the File Based Access Log Publisher .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.
The rotation policy to use for the File Based Access Log Publisher .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.
Indicates whether the File Based Access Log Publisher will publish records asynchronously.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No
auto-flush
Description
Specifies whether to flush the writer after every log record.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 Property
Yes
Read-only
No
buffer-size
Description
Specifies the log file buffer size.
Default Value
64kb
Allowed Values
A positive integer representing a size. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
java-class
Description
The fully-qualified name of the Java class that provides the File Based Access Log Publisher implementation.
Default Value
org.opends.server.loggers.TextAccessLogPublisher
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.loggers.LogPublisher
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No
queue-size
Description
The maximum number of log records that can be stored in the asynchronous queue.
Default Value
5000
Allowed Values
An integer value. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
suppress-internal-operations
Description
Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
suppress-synchronization-operations
Description
Indicates whether access messages that are generated by synchronization operations should be suppressed.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
time-interval
Description
Specifies the interval at which to check whether the log files need to be rotated.