File Based Access Log Publishers publish access messages to the file system.
The File Based Access Log Publisher component inherits from the Access Log Publisher
The following components have a direct AGGREGATION relation FROM File Based Access Log Publishers :
A description of each property follows.
Basic Properties: | Advanced Properties: |
---|---|
↓ append | ↓ asynchronous |
↓ enabled | ↓ auto-flush |
↓ log-file | ↓ buffer-size |
↓ log-file-permissions | ↓ java-class |
↓ operations-to-log | ↓ log-controls |
↓ retention-policy | ↓ queue-size |
↓ rotation-policy | ↓ time-interval |
Description | 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 |
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 |
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 |
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 |
Description | Indicates which operations has to be logged. |
---|---|
Default Value | administration user adminbrowsing synchronization |
Allowed Values | adminbrowsing - operations which are performed with the "Network group selection" control (no Network group dependency). administration - operations performed on the admin network group, excluding operation with "Network group selection" control. all - All of the above (if specified, any other value specified for the attribute is ignored). internal - internal operations (for example, operations that are initiated by plugins). synchronization - synchronization operations. user - operations performed on any user network group should be logged, excluding operation with "Network group selection" control. |
Multi-valued | Yes |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
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. |
Allowed Values | The DN of any Log Retention Policy. |
Multi-valued | Yes |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | 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. |
Allowed Values | The DN of any Log Rotation Policy. |
Multi-valued | Yes |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | 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 |
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 |
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 |
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.api.AccessLogPublisher |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. |
---|---|
Default Value | false |
Allowed Values | true false |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | The maximum number of log records that can be stored in the asynchronous queue. Setting the queue size to zero activates parallel log writer implementation which has no queue size limit and as such the parallel log writer should only be used on a very well tuned server configuration to avoid potential out of memory errors. |
---|---|
Default Value | 5000 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | The File Based Access Log Publisher must be restarted if this property is changed and the asynchronous property is set to true. |
Advanced Property | Yes |
Read-only | No |
Description | Specifies the interval at which to check whether the log files need to be rotated. |
---|---|
Default Value | 5s |
Allowed Values | A duration Syntax. Lower limit is 1 milliseconds. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |