Csv File HTTP Access Log Publishers publish HTTP access messages to CSV files.
The Csv File HTTP Access Log Publisher component inherits from the HTTP Access Log Publisher
The following components have a direct AGGREGATION relation FROM Csv File HTTP Access Log Publishers :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ csv-delimiter-char | ↓ asynchronous |
| ↓ enabled | ↓ auto-flush |
| ↓ key-store-file | ↓ csv-eol-symbols |
| ↓ key-store-pin-file | ↓ csv-quote-char |
| ↓ log-directory | ↓ java-class |
| ↓ retention-policy | ↓ signature-time-interval |
| ↓ rotation-policy | |
| ↓ tamper-evident |
| Description | The delimiter character to use when writing in CSV format. |
| Default Value | , |
| Allowed Values | The delimiter character to use when writing in CSV format. |
| 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 | Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.Changes to this property will take effect the next time that the key store is accessed. |
| Default Value | None |
| Allowed Values | A path to an existing file that is readable by the server. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Csv File HTTP Access Log Publisher . |
| Default Value | None |
| Allowed Values | A path to an existing file that is readable by the server. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None. Changes to this property will take effect the next time that the Csv File HTTP Access Log Publisher is accessed. |
| Advanced Property | No |
| Read-only | No |
| Description | The directory to use for the log files generated by the Csv File HTTP Access Log Publisher. The path to the directory is relative to the server root. |
| Default Value | logs |
| Allowed Values | A path to an existing directory that is readable and writable by the server. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | The Csv File HTTP 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 retention policy to use for the Csv File HTTP 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 Csv File HTTP 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 | Specifies whether the log should be signed in order to detect tampering.Every log record will be signed, making it possible to verify that the log has not been tampered with. This feature has a significative impact on performance of the server. |
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates whether the Csv File HTTP 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 | The string that marks the end of a line. |
| Default Value | Use the platform specific end of line character sequence. |
| Allowed Values | The string that marks the end of a line. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |
| Description | The character to append and prepend to a CSV field when writing in CSV format. |
| Default Value | " |
| Allowed Values | The quote character to use when writing in CSV format. |
| 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 Csv File HTTP Access Log Publisher implementation. |
| Default Value | org.opends.server.loggers.CommonAuditHTTPAccessLogPublisher |
| 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 |
| Description | Specifies the interval at which to sign the log file when secure option is enabled. |
| Default Value | 3s |
| 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 |