--- title: CSV File HTTP Access Log Publisher (DEPRECATED) description: "DEPRECATED for removal since 7.2.0: The Audit Event Handlers are deprecated. Alternative: Convert JSON logs to CSV." component: pingds version: 7.5 page_id: pingds:configref:objects-csv-file-http-access-log-publisher canonical_url: https://docs.pingidentity.com/pingds/7.5/configref/objects-csv-file-http-access-log-publisher.html section_ids: parent: Parent dependencies: Dependencies csv_file_http_access_log_publisher_properties: CSV File HTTP Access Log Publisher properties basic_properties: Basic properties csv-delimiter-char: csv-delimiter-char enabled: enabled key-store-file: key-store-file key-store-pin: key-store-pin log-directory: log-directory log-field-blacklist: log-field-blacklist log-field-whitelist: log-field-whitelist log-file-name-prefix: log-file-name-prefix retention-policy: retention-policy rotation-policy: rotation-policy tamper-evident: tamper-evident advanced_properties: Advanced properties asynchronous: asynchronous auto-flush: auto-flush csv-eol-symbols: csv-eol-symbols csv-quote-char: csv-quote-char java-class: java-class signature-time-interval: signature-time-interval --- # CSV File HTTP Access Log Publisher (DEPRECATED) | | | | - | ------------------------------------------------------------------------------------------------------------------- | | | DEPRECATED for removal since 7.2.0: The Audit Event Handlers are deprecated. Alternative: Convert JSON logs to CSV. | CSV File HTTP Access Log Publishers publish HTTP access messages to CSV files. ## Parent The CSV File HTTP Access Log Publisher object inherits from [HTTP Access Log Publisher](objects-http-access-log-publisher.html). ## Dependencies CSV File HTTP Access Log Publishers depend on the following objects: * [Log Retention Policy](objects-log-retention-policy.html) * [Log Rotation Policy](objects-log-rotation-policy.html) ## CSV File HTTP Access Log Publisher properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [csv-delimiter-char](#csv-delimiter-char) [enabled](#enabled) [key-store-file](#key-store-file) [key-store-pin](#key-store-pin) [log-directory](#log-directory) [log-field-blacklist](#log-field-blacklist) [log-field-whitelist](#log-field-whitelist) [log-file-name-prefix](#log-file-name-prefix) [retention-policy](#retention-policy) [rotation-policy](#rotation-policy) [tamper-evident](#tamper-evident) | [asynchronous](#asynchronous) [auto-flush](#auto-flush) [csv-eol-symbols](#csv-eol-symbols) [csv-quote-char](#csv-quote-char) [java-class](#java-class) [signature-time-interval](#signature-time-interval) | ### Basic properties Use the `--advanced` option to access advanced properties. ### csv-delimiter-char | | | | ----------------------- | ---------------------------------------------------------- | | *Synopsis* | 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* | No | | *Read-only* | No | ### enabled | | | | ----------------------- | ------------------------------------------------------- | | *Synopsis* | Indicates whether the Log Publisher is enabled for use. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### key-store-file | | | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | 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. | | *Description* | 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* | No | | *Read-only* | No | ### key-store-pin | | | | ----------------------- | -------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the clear-text PIN needed to access the CSV File HTTP Access Log Publisher . | | *Default value* | None | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | NoneChanges to this property will take effect the next time that the CSV File HTTP Access Log Publisher is accessed. | | *Advanced* | No | | *Read-only* | No | ### log-directory | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | 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 object must be disabled and re-enabled for changes to take effect. | | *Advanced* | No | | *Read-only* | No | ### log-field-blacklist | | | | ----------------------- | --------------------------------------------------------------------------------- | | *Synopsis* | List of fields that the server omits from access log messages. | | *Description* | Valid values for this property are JSON paths for fields present in the log file. | | *Default value* | No message elements are blacklisted by default | | *Allowed values* | A JSON path to an existing object of the access event definition. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### log-field-whitelist | | | | ----------------------- | --------------------------------------------------------------------------------- | | *Synopsis* | List of fields that the server includes in access log messages. | | *Description* | Valid values for this property are JSON paths for fields present in the log file. | | *Default value* | Fields not containing sensitive information are whitelisted by default. | | *Allowed values* | A JSON path to an existing object of the access event definition. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### log-file-name-prefix | | | | ----------------------- | --------------------------------------------------------------------------------------- | | *Synopsis* | File name prefix (without extension) for CSV and JSON file based access log publishers. | | *Default value* | http-access | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | The object must be disabled and re-enabled for changes to take effect. | | *Advanced* | No | | *Read-only* | No | ### retention-policy | | | | ----------------------- | --------------------------------------------------------------------------------------------------- | | *Synopsis* | The retention policy to use for the CSV File HTTP 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](objects-log-retention-policy.html). | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### rotation-policy | | | | ----------------------- | ---------------------------------------------------------------------------------------- | | *Synopsis* | The rotation policy to use for the CSV File HTTP 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](objects-log-rotation-policy.html). | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### tamper-evident | | | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies whether the log should be signed in order to detect tampering. | | *Description* | Every log record will be signed, making it possible to verify that the log has not been tampered with. This feature has a significant impact on performance of the server. | | *Default value* | false | | *Allowed values* | truefalse | | *Multi-valued* | No | | *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 CSV File HTTP Access Log Publisher will publish records asynchronously. | | *Default value* | true | | *Allowed values* | truefalse | | *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* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No | ### csv-eol-symbols | | | | ----------------------- | --------------------------------------------------------- | | *Synopsis* | 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* | Yes | | *Read-only* | No | ### csv-quote-char | | | | ----------------------- | ------------------------------------------------------------------------------ | | *Synopsis* | 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* | Yes | | *Read-only* | No | ### java-class | | | | ----------------------- | --------------------------------------------------------------------------------------------------------------- | | *Synopsis* | 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 extends or implements:- org.opends.server.loggers.LogPublisher | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No | ### signature-time-interval | | | | ----------------------- | ----------------------------------------------------------------------------------- | | *Synopsis* | Specifies the interval at which to sign the log file when secure option is enabled. | | *Default value* | 3s | | *Allowed values* | Uses [duration syntax](duration-syntax.html).Lower limit: 1 milliseconds. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |