UnboundID Metrics Engine - File Based Access Log Publisher

Metrics Engine Documentation Index
Configuration Reference Home

File Based Access Log Publisher

File Based Access Log Publishers publish access messages to the file system.

↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage

Parent Component

The File Based Access Log Publisher component inherits from the Writer Based Access Log Publisher

Relations from This Component

The following components have a direct aggregation relation from File Based Access Log Publishers:

Log Retention Policy

Log Rotation Policy

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
↓ description	↓ auto-flush
↓ enabled	↓ asynchronous
↓ suppress-internal-operations	↓ queue-size
↓ suppress-replication-operations	↓ include-thread-id
↓ log-connects	↓ max-string-length
↓ log-disconnects	↓ time-interval
↓ log-security-negotiation	↓ buffer-size
↓ log-client-certificates	↓ compression-mechanism
↓ 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
↓ include-request-details-in-result-messages
↓ include-request-details-in-search-entry-messages
↓ include-request-details-in-search-reference-messages
↓ include-request-details-in-intermediate-response-messages
↓ include-extended-search-request-details
↓ include-add-attribute-names
↓ include-modify-attribute-names
↓ include-search-entry-attribute-names
↓ include-product-name
↓ include-instance-name
↓ include-startup-id
↓ include-requester-ip-address
↓ include-requester-dn
↓ include-request-controls
↓ include-response-controls
↓ timestamp-precision
↓ log-file
↓ log-file-permissions
↓ append
↓ rotation-policy
↓ retention-policy
↓ sign-log

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

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

include-request-details-in-result-messages

Description	Indicates whether log messages for operation results should include information about both the request and the result. This option can be used to eliminate the need to log request messages, and can eliminate the need to read multiple lines in order to obtain the full set of information logged for an operation.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-request-details-in-search-entry-messages

Description	Indicates whether log messages for search result entries should include information about the associated search request. This option can be used to eliminate the need to log request messages, and can eliminate the need to read multiple lines in order to obtain the full set of information logged for an operation.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-request-details-in-search-reference-messages

Description	Indicates whether log messages for search result references should include information about the associated search request. This option can be used to eliminate the need to log request messages, and can eliminate the need to read multiple lines in order to obtain the full set of information logged for an operation.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-request-details-in-intermediate-response-messages

Description	Indicates whether log messages for intermediate responses should include information about the associated operation request. This option can be used to eliminate the need to log request messages, and can eliminate the need to read multiple lines in order to obtain the full set of information logged for an operation.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-extended-search-request-details

Description	Indicates whether log messages for search requests should include extended information from the request, including the requested size limit, time limit, alias dereferencing behavior, and types only behavior.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-add-attribute-names

Description	Indicates whether log messages for add requests should include a list of the names of the attributes included in the entry to add.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-modify-attribute-names

Description	Indicates whether log messages for modify requests should include a list of the names of the attributes to be modified.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-search-entry-attribute-names

Description	Indicates whether log messages for search result entries should include a list of the names of the attributes included in the entry that was returned.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-product-name

Description	Indicates whether log messages should include the product name for the Metrics Engine.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-instance-name

Description	Indicates whether log messages should include the instance name for the Metrics Engine.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-startup-id

Description	Indicates whether log messages should include the startup ID for the Metrics Engine, which is a value assigned to the server instance at startup and may be used to identify when the server has been restarted.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-requester-ip-address

Description	Indicates whether log messages for operation requests should include the IP address of the client that requested the operation.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-requester-dn

Description	Indicates whether log messages for operation requests should include the DN of the authenticated user for the client connection on which the operation was requested.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-request-controls

Description	Indicates whether log messages for operation requests should include a list of the OIDs of any controls included in the request.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

include-response-controls

Description	Indicates whether log messages for operation results should include a list of the OIDs of any controls included in the result.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

timestamp-precision

Description	Specifies the smallest time unit to be included in timestamps.
Default Value	milliseconds
Allowed Values	seconds - Timestamps will be precise to the nearest second. milliseconds - Timestamps will be precise to the nearest millisecond.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

log-file

Description	The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file can be specified either as relative to the server root or as an absolute path.
Default Value	None
Allowed Values	Unknown
Multi-Valued	No
Required	Yes
Admin Action Required	The File Based Access Log Publisher must be disabled and re-enabled for changes to this setting to take effect. This modification requires that you disable and then re-enable this component for the change to take effect

log-file-permissions

Description	The UNIX permissions of the log files created by this File Based Access Log Publisher.
Default Value	640
Allowed Values	A valid UNIX mode string. The mode string must contain three digits between zero and seven.
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

append

Description	Specifies whether to append to existing log files.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

rotation-policy

Description	The rotation policy to use for the File Based Access Log Publisher . 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 DN of any Log Rotation Policy.
Multi-Valued	Yes
Required	Yes
Admin Action Required	None. Modification requires no further action

retention-policy

Description	The retention policy to use for the File Based Access Log Publisher . 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 DN of any Log Retention Policy.
Multi-Valued	Yes
Required	Yes
Admin Action Required	None. Modification requires no further action

sign-log

Description	Indicates whether the log should be cryptographically signed so that the log content cannot be altered in an undetectable manner. Log file signatures can be validated using the validate-file-signature tool provided with the server. Note that when enabling signing for a logger that already exists and was enabled without signing, the first log file will not be completely verifiable because it will still contain unsigned content from before signing was enabled. Only log files whose entire content was written with signing enabled will be considered completely valid. For the same reason, if a log file is still open for writing, then signature validation will not indicate that the log is completely valid because the log will not include the necessary "end signed content" indicator at the end of the file.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	The File Based Access Log Publisher must be disabled and re-enabled for changes to this setting to take effect. This modification requires that you disable and then re-enable this component for the change to take effect

Advanced Properties

auto-flush (Advanced Property)

Description	Specifies whether to flush the writer after every log record. If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

asynchronous (Advanced Property)

Description	Indicates whether the Writer Based Access Log Publisher will publish records asynchronously.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

queue-size (Advanced Property)

Description	The maximum number of log records that can be stored in the asynchronous queue. The server will continuously flush messages from the queue to the log. That is, it does not wait for the queue to fill up before flushing to the log. Lowering this value can impact performance.
Default Value	10000
Allowed Values	An integer value. Lower limit is 1000. Upper limit is 100000 .
Multi-Valued	No
Required	No
Admin Action Required	The Writer Based Access Log Publisher must be restarted if this property is changed and the asynchronous property is set to true.

include-thread-id (Advanced Property)

Description	Indicates whether log messages should include the thread ID for the Metrics Engine in each log message. This ID can be used to correlate log messages from the same thread within a single log as well as generated by the same thread across different types of log files. More information about the thread with a specific ID can be obtained using the cn=JVM Stack Trace,cn=monitor entry.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

max-string-length (Advanced Property)

Description	Specifies the maximum number of characters that may be included in any string in a log message before that string is truncated and replaced with a placeholder indicating the number of characters that were omitted. This can help prevent extremely long log messages from being written. A value of zero indicates that no limit will be imposed.
Default Value	2000
Allowed Values	An integer value. Lower limit is 0.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

time-interval (Advanced Property)

Description	Specifies the interval at which to check whether the log files need to be rotated.
Default Value	5s
Allowed Values	A duration. Lower limit is 1 milliseconds.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

buffer-size (Advanced Property)

Description	Specifies the log file buffer size.
Default Value	64kb
Allowed Values	A positive integer representing a size. Lower limit is 1.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

compression-mechanism (Advanced Property, Read-Only)

Description	Specifies the type of compression (if any) to use for log files that are written. Note that this setting cannot be changed once the logger has been created, because of the possibility of mixing compressed and uncompressed data in the same file. Further, because it is difficult to append to a compressed file, any existing active log file will automatically be rotated when the server is started. If compressed logging is used, it may also be desirable to have another logger enabled that does not use compression. The rotation and retention policies for the uncompressed logger can be configured to minimize the amount of space it consumes, but having ready access to information about recent operations in uncompressed form may be convenient for debugging purposes. Alternately, you could consider having the uncompressed logger defined but not enabled so that it can be turned on as needed for debugging such problems.
Default Value	none
Allowed Values	none - No compression will be performed. gzip - Compress file data using gzip with the default compression level. If this compression level is specified, then files will automatically be given a ".gz" extension.
Multi-Valued	No
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 create a new File Based Access Log Publisher:

dsconfig create-log-publisher
     --publisher-name {name}
     --type {type}
     --set enabled:{propertyValue}
     --set log-file:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log Publisher:

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