External HTTP Access Log Publisher

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

Parent

The External HTTP Access Log Publisher object inherits from HTTP Access Log Publisher.

External HTTP 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
enabled
log-field-blacklist
log-field-whitelist

java-class

Basic Properties

Use the --advanced option to access advanced properties.

config-file

Synopsis

The JSON configuration file that defines the External HTTP 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

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

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