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.
External 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 |
|---|---|
config-file |
java-class |
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 |
|
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 |
Advanced properties
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:
|
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 |