--- title: JSON File Based HTTP Access Log Publisher description: JSON File Based HTTP Access Log Publishers Publish access messages to Json files. component: pingds version: 8.1 page_id: pingds:configref:objects-json-file-http-access-log-publisher canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-json-file-http-access-log-publisher.html section_ids: parent: Parent dependencies: Dependencies json_file_based_http_access_log_publisher_properties: JSON File Based HTTP Access Log Publisher properties basic_properties: Basic properties enabled: enabled 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 advanced_properties: Advanced properties java-class: java-class --- # JSON File Based HTTP Access Log Publisher JSON File Based HTTP Access Log Publishers Publish access messages to Json files. ## Parent The JSON File Based HTTP Access Log Publisher object inherits from [HTTP Access Log Publisher](objects-http-access-log-publisher.html). ## Dependencies JSON 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) ## JSON 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 | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [enabled](#enabled) [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) | [java-class](#java-class) | ### Basic properties Use the `--advanced` option to access advanced properties. ### 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-directory | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | The directory to use for the log files generated by the JSON File Based 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 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-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 JSON 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 JSON 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. ### java-class | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | The fully-qualified name of the Java class that provides the JSON File Based 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 |