Console JSON Access Log Publishers publish JSON-formatted access log messages to the JVM's original standard output or standard error stream.
The Console JSON Access Log Publisher component inherits from the JSON Formatted Access Log Publisher
The properties supported by this managed object are as follows:
Property Group | General Configuration |
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 |
Property Group | General Configuration |
Description | Indicates whether the Console JSON Access Log Publisher is enabled for use. |
Default Value | None |
Allowed Values | true false |
Multi-Valued | No |
Required | Yes |
Admin Action Required | The Console JSON Access Log Publisher is primarily intended to be used for server instances that are run in no-detach mode (that is, instances that are started with the --nodetach argument). When the logger is used in a server that is not running in no-detach mode, it may have reduced performance and functionality. |
Property Group | General Configuration |
Description | Specifies the behavior that the server should exhibit if an error occurs during logging processing. |
Default Value | standard-error |
Allowed Values | standard-error - Write a message to standard error in the event of a logging failure. lockdown-mode - Place the server in lockdown mode in the event of a logging failure. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Log File Management |
Description | Indicates whether the JSON objects should be formatted to span multiple lines with a single element on each line. The multi-line format is potentially more user friendly (if administrators may need to look at the log files), but each message will be larger because of the additional spaces and end-of-line markers. |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Log File Management |
Description | Specifies the output stream to which JSON-formatted access log messages should be written. |
Default Value | standard-output |
Allowed Values | standard-output - Messages should be written to the JVM's original standard output stream. standard-error - Messages should be written to the JVM's original standard error stream. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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 |
Property Group | Log Messages To Include |
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
Property Group | Log Messages To Include |
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 |
correlate-requests-and-results
Property Group | Log Messages To Include |
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 |
Property Group | Filtering 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 |
Property Group | Filtering 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 Access 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 |
Property Group | Filtering 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 Access 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 |
Property Group | Filtering 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 Access 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 |
Property Group | Filtering 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 Access 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 |
Property Group | Log Message Elements To Include |
Description | Indicates whether log messages should include the product name for the Directory Server. |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Log Message Elements To Include |
Description | Indicates whether log messages should include the instance name for the Directory Server. |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Log Message Elements To Include |
Description | Indicates whether log messages should include the startup ID for the Directory Server, 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 |
Property Group | Log Message Elements To Include |
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 |
Property Group | Log Message Elements To Include |
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-request-details-in-result-messages
Property Group | Log Message Elements To Include |
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
Property Group | Log Message Elements To Include |
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
Property Group | Log Message Elements To Include |
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
Property Group | Log Message Elements To Include |
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 |
Property Group | Log Message Elements To Include |
Description | Indicates whether result log messages should include human-readable names for result codes in addition to their numeric values. |
Default Value | true |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
include-extended-search-request-details
Property Group | Log Message Elements To Include |
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 |
Property Group | Log Message Elements To Include |
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
Property Group | Log Message Elements To Include |
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
Property Group | Log Message Elements To Include |
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 |
Property Group | Log Message Elements To Include |
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 |
Property Group | Log Message Elements To Include |
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 |
Property Group | Log Message Elements To Include |
Description | Indicates whether to log information about the replication change ID. The replication change ID uniquely identifies an update operation. When enabled on all replicas in the replication topology, it can be used to trace updates from the origin replica to all other replicas. |
Default Value | true |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
generify-message-strings-when-possible
Property Group | Log Message Elements To Include |
Description | Indicates whether to use generified version of certain message strings, including diagnostic messages, additional information messages, authentication failure reasons, and disconnect messages. Generified versions of those strings may use placeholders (like %s for a string or %d for an integer) rather than the version of the string with those placeholders replaced with specific values. Using generified versions of message strings may make those messages somewhat less useful since context-specific detail will not be included in the log message, but they may improve privacy and security because any potentially sensitive information will have been redacted. Note that in some cases, it may not be possible to completely generify message strings. For example, it is not possible to generify messages that originate outside the server codebase (like messages generated by a third-party library or received from an external service). |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Other Configuration |
Description | The behavior to use for determining which fields to log and whether to transform the values of those fields in any way. |
Default Value | None |
Allowed Values | The DN of any JSON Formatted Access Log Field Behavior. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
include-thread-id (Advanced Property)
Property Group | Log Message Elements To Include |
Description | Indicates whether log messages should include the thread ID for the Directory Server 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)
Property Group | Other Configuration |
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 |
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}] ...