File Based Access Log Publisher
File Based Access Log Publishers publish access messages to the file system.
Parent
The File Based Access Log Publisher object inherits from Access Log Publisher.
File Based Access Log Publisher Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
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 |
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 |
filtering-policy
Synopsis |
Specifies how filtering criteria should be applied to log records. |
Default Value |
no-filtering |
Allowed Values |
|
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
log-control-oids
Synopsis |
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 |
No |
Read-Only |
No |
log-file
Synopsis |
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 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 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 |
No |
Read-Only |
No |
log-format
Synopsis |
Specifies how log records should be formatted and written to the access log. |
Default Value |
multi-line |
Allowed Values |
|
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
log-record-time-format
Synopsis |
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 |
No |
Read-Only |
No |
retention-policy
Synopsis |
The retention policy to use for the File Based Access 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 Access 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 Access Log Publisher will publish records asynchronously. |
Default Value |
true |
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 Access Log Publisher implementation. |
Default Value |
org.opends.server.loggers.TextAccessLogPublisher |
Allowed Values |
A Java class that extends or implements:
|
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 |
suppress-internal-operations
Synopsis |
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 |
Yes |
Read-Only |
No |
suppress-synchronization-operations
Synopsis |
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 |
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 |