JSON File Based Access Log Publisher

JSON File Based Access Log Publishers publish access messages to JSON files.

Parent

The JSON File Based Access Log Publisher object inherits from Common Audit Access Log Publisher.

Dependencies

JSON File Based Access Log Publishers depend on the following objects:

JSON File Based Access Log Publisher Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

enabled
filtering-policy
log-control-oids
log-directory
log-field-blacklist
log-file-name-prefix
retention-policy
rotation-policy

java-class
suppress-internal-operations
suppress-synchronization-operations

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

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

filtering-policy

Synopsis

Specifies how filtering criteria should be applied to log records.

Default Value

no-filtering

Allowed Values

  • exclusive: Records must not match any of the filtering criteria in order to be logged.

  • inclusive: Records must match at least one of the filtering criteria in order to be logged.

  • no-filtering: No filtering will be performed, and all records will be logged.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

log-control-oids

Synopsis

Specifies whether control OIDs will be included in operation log records.

Default Value

false

Allowed Values

true

false

Multi-valued

No

Required

No

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 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-file-name-prefix

Synopsis

File name prefix (without extension) for CSV and JSON file based access log publishers.

Default Value

ldap-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 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.

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 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.

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 Access Log Publisher implementation.

Default Value

org.opends.server.loggers.JsonFileAccessLogPublisher

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

suppress-internal-operations

Synopsis

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Default Value

true

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

suppress-synchronization-operations

Synopsis

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Default Value

false

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No