--- title: File Based HTTP Access Log Publisher description: File Based HTTP Access Log Publishers publish HTTP access messages to the file system. component: pingds version: 8.1 page_id: pingds:configref:objects-file-based-http-access-log-publisher canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-file-based-http-access-log-publisher.html section_ids: parent: Parent dependencies: Dependencies file_based_http_access_log_publisher_properties: File Based HTTP Access Log Publisher properties basic_properties: Basic properties append: append enabled: enabled log-file: log-file log-file-permissions: log-file-permissions log-format: log-format log-record-time-format: log-record-time-format retention-policy: retention-policy rotation-policy: rotation-policy advanced_properties: Advanced properties asynchronous: asynchronous auto-flush: auto-flush buffer-size: buffer-size java-class: java-class queue-size: queue-size time-interval: time-interval --- # File Based HTTP Access Log Publisher File Based HTTP Access Log Publishers publish HTTP access messages to the file system. ## Parent The File Based HTTP Access Log Publisher object inherits from [HTTP Access Log Publisher](objects-http-access-log-publisher.html). ## Dependencies File Based 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) ## File Based 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 | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [append](#append) [enabled](#enabled) [log-file](#log-file) [log-file-permissions](#log-file-permissions) [log-format](#log-format) [log-record-time-format](#log-record-time-format) [retention-policy](#retention-policy) [rotation-policy](#rotation-policy) | [asynchronous](#asynchronous) [auto-flush](#auto-flush) [buffer-size](#buffer-size) [java-class](#java-class) [queue-size](#queue-size) [time-interval](#time-interval) | ### Basic properties Use the `--advanced` option to access advanced properties. ### append | | | | ----------------------- | -------------------------------------------------- | | *Synopsis* | Specifies whether to append to existing log files. | | *Default value* | true | | *Allowed values* | truefalse | | *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 | ### log-file | | | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the instance directory path. | | *Default value* | None | | *Allowed values* | A path to an existing file that is readable (and/or writeable) 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 HTTP 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 HTTP access log. | | *Default value* | cs-host c-ip cs-username x-datetime cs-method cs-uri-stem cs-uri-query cs-version sc-status cs(User-Agent) x-connection-id x-etime x-transaction-id | | *Allowed values* | A space separated list of fields describing the extended log format to be used for logging HTTP accesses. Available values are listed on the W3C working draft and Microsoft website PingDS supports the following standard fields: "c-ip", "c-port", "cs-host", "cs-method", "cs-uri", "cs-uri-stem", "cs-uri-query", "cs(User-Agent)", "cs-username", "cs-version", "s-computername", "s-ip", "s-port", "sc-status". PingDS supports the following application specific field extensions: "x-connection-id" displays the internal connection ID assigned to the HTTP client connection, "x-datetime" displays the completion date and time for the logged HTTP request and its output is controlled by the "ds-cfg-log-record-time-format" property, "x-etime" displays the total execution time for the logged HTTP request, "x-transaction-id" displays the transaction id associated to a request | | *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 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 File Based 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 | ## Advanced properties Use the `--advanced` option to access advanced properties. ### asynchronous | | | | ----------------------- | ----------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether the File Based 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 | ### buffer-size | | | | ----------------------- | ---------------------------------------------------- | | *Synopsis* | Specifies the log file buffer size. | | *Default value* | 64kb | | *Allowed values* | Uses [size syntax](size-syntax.html).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 HTTP Access Log Publisher implementation. | | *Default value* | org.opends.server.loggers.TextHTTPAccessLogPublisher | | *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 | ### 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 | ### 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](duration-syntax.html).Lower limit: 1 milliseconds. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |