External Access Log Publisher

External Access Log Publishers publish access messages to an external handler.

Parent

The External Access Log Publisher object inherits from Common Audit Access Log Publisher.

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

Basic Properties

Advanced Properties

config-file

Synopsis	The JSON configuration file that defines the External Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.
Default Value	None
Allowed Values	A path to an existing file that is readable 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

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

Use the --advanced option to access advanced properties.

java-class

Synopsis	The fully-qualified name of the Java class that provides the External Access Log Publisher implementation.
Default Value	org.opends.server.loggers.ExternalAccessLogPublisher
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