Metrics Engine Documentation Index
Configuration Reference Home

Scripted Access Log Publisher

Note: this is an abstract component that cannot be instantiated.

Scripted Access Log Publisher provide access log publisher implementations defined in a dynamically-loaded script which implements the ScriptedAccessLogger class defined in the UnboundID server SDK.

Direct Subcomponents
Parent Component
Properties
dsconfig Usage

Direct Subcomponents

The following Scripted Access Log Publishers are available in the server :

These Scripted Access Log Publishers inherit from the properties described below.

Parent Component

The Scripted Access Log Publisher component inherits from the Log Publisher

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class
↓ suppress-internal-operations
↓ suppress-replication-operations
↓ log-connects
↓ log-disconnects
↓ log-security-negotiation
↓ log-client-certificates
↓ log-requests
↓ log-results
↓ log-search-entries
↓ log-search-references
↓ log-intermediate-responses
↓ connection-criteria
↓ request-criteria
↓ result-criteria
↓ search-entry-criteria
↓ search-reference-criteria
↓ correlate-requests-and-results
↓ script-argument

Basic Properties

description

Description
A description for this Log Publisher
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
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. Modification requires no further action

java-class (Read-Only)

Description
The fully-qualified name of the Java class that provides the Log Publisher implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.AccessLogPublisher
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

suppress-internal-operations

Description
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. Modification requires no further action

suppress-replication-operations

Description
Indicates whether access messages that are generated by replication operations should be suppressed.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-connects

Description
Indicates whether to log information about connections established to the server.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-disconnects

Description
Indicates whether to log information about connections that have been closed by the client or terminated by the server.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-security-negotiation

Description
Indicates whether to log information about the result of any security negotiation (e.g., SSL handshake) processing that has been performed.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-client-certificates

Description
Indicates whether to log information about any client certificates presented to the server.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-requests

Description
Indicates whether to log information about requests received from clients.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-results

Description
Indicates whether to log information about the results of client requests.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-search-entries

Description
Indicates whether to log information about search result entries sent to the client.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-search-references

Description
Indicates whether to log information about search result references sent to the client.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-intermediate-responses

Description
Indicates whether to log information about intermediate responses sent to the client.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

connection-criteria

Description
Specifies a set of connection criteria that must match the associated client connection in order for a connect, disconnect, request, or result message to be logged.
Default Value
None
Allowed Values
The DN of any Connection Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

request-criteria

Description
Specifies a set of request criteria that must match the associated operation request in order for a request or result to be logged by this Log Publisher.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

result-criteria

Description
Specifies a set of result criteria that must match the associated operation result in order for that result to be logged by this Log Publisher.
Default Value
None
Allowed Values
The DN of any Result Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

search-entry-criteria

Description
Specifies a set of search entry criteria that must match the associated search result entry in order for that it to be logged by this Log Publisher.
Default Value
None
Allowed Values
The DN of any Search Entry Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

search-reference-criteria

Description
Specifies a set of search reference criteria that must match the associated search result reference in order for that it to be logged by this Log Publisher.
Default Value
None
Allowed Values
The DN of any Search Reference Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

correlate-requests-and-results

Description
Indicates whether to automatically log result messages for any operation in which the corresponding request was logged. In such cases, the result, entry, and reference criteria will be ignored, although the log-responses, log-search-entries, and log-search-references properties will be honored.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

script-argument

Description
The set of arguments used to customize the behavior for the Scripted Access Log Publisher. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Log Publishers:

dsconfig list-log-publishers
     [--property {propertyName}] ...

To view the configuration for an existing Log Publisher:

dsconfig get-log-publisher-prop
     --publisher-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Log Publisher:

dsconfig set-log-publisher-prop
     --publisher-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Log Publisher:

dsconfig delete-log-publisher
     --publisher-name {name}