Note: this is an abstract component that cannot be instantiated.
JSON Formatted HTTP Operation Log Publishers may be used to log detailed information about interaction with HTTP clients, with log messages formatted as JSON objects.
The following JSON Formatted HTTP Operation Log Publishers are available in the server :
These JSON Formatted HTTP Operation Log Publishers inherit from the properties described below.
The JSON Formatted HTTP Operation Log Publisher component inherits from the HTTP Operation Log Publisher
The properties supported by this managed object are as follows:
| General Configuration Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| logging-error-behavior | |
| Log File Management Basic Properties: | Advanced Properties: |
| write-multi-line-messages | None |
| Log Messages To Include Basic Properties: | Advanced Properties: |
| log-requests | None |
| log-results | |
| Log Message Elements To Include Basic Properties: | Advanced Properties: |
| include-product-name | include-thread-id |
| include-instance-name | |
| include-startup-id | |
| include-request-details-in-result-messages | |
| log-request-headers | |
| suppressed-request-header-name | |
| log-response-headers | |
| suppressed-response-header-name | |
| log-request-authorization-type | |
| log-request-cookie-names | |
| log-response-cookie-names | |
| log-request-parameters | |
| suppressed-request-parameter-name | |
| log-request-protocol | |
| log-redirect-uri |
| 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 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 |
| 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 use a multi-line representation (with each object field and array value on its own line) that may be easier for administrators to read, but each message will be larger (because of additional spaces and end-of-line markers), and it may be more difficult to consume and parse through some text-oriented tools. |
| 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 record a log message with information about requests received from 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 record a log message with information about the result of processing a requested HTTP operation. |
| Default Value | true |
| 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 product name for the Directory 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 Message Elements To Include |
| Description | Indicates whether log messages should include the instance name for the Directory 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 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 | 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
| Property Group | Log Message Elements To Include |
| Description | Indicates whether result log messages should include all of the elements of request log messages. This may be used to record a single message per operation with details about both the request and response. |
| Default Value | true |
| 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 request log messages should include information about HTTP headers included in the request. |
| Default Value | none |
| Allowed Values | none - Indicates that no information about request headers should be logged. header-names - Indicates that only the names of request headers should be logged, but the values should be suppressed. header-names-and-values - Indicates that request header names and values should be logged. Note that request headers may include sensitive information, so it may be desirable to suppress information about one or more such request headers. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
suppressed-request-header-name
| Property Group | Log Message Elements To Include |
| Description | Specifies the case-insensitive names of request headers that should be omitted from log messages (e.g., for the purpose of brevity or security). This will only be used if the log-request-headers property has a value of true. For security reasons, the "Authorization" and "Cookie" headers will be suppressed by default. The "Content-Length" header will be suppressed because it will be included in the contentLength element, and the "Content-Type" header will be suppressed because it will be included in the contentType log element. If all request headers should be logged, then a nonsense value that will not appear as a valid request header should be provided. |
| Default Value | Authorization Content-Length Content-Type Cookie |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Log Message Elements To Include |
| Description | Indicates whether response log messages should include information about HTTP headers included in the response. |
| Default Value | none |
| Allowed Values | none - Indicates that no information about response headers should be logged. header-names - Indicates that only the names of response headers should be logged, but the values should be suppressed. header-names-and-values - Indicates that response header names and values should be logged. Note that response headers may include sensitive information, so it may be desirable to suppress information about one or more such response headers. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
suppressed-response-header-name
| Property Group | Log Message Elements To Include |
| Description | Specifies the case-insensitive names of response headers that should be omitted from log messages (e.g., for the purpose of brevity or security). This will only be used if the log-response-headers property has a value of true. For security reasons, the "Set-Cookie" header will be suppressed by default. The "Location" header will also be suppressed because its value will normally be included in the redirectURI log element, the "Content-Length" header will be suppressed because it will be included in the contentLength log element, and the "Content-Type" will be suppressed because it will be included in the contentType element. If all response headers should be logged, then a nonsense value that will not appear as a valid response header should be provided. |
| Default Value | Content-Length Content-Type Location Set-Cookie |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
log-request-authorization-type
| Property Group | Log Message Elements To Include |
| Description | Indicates whether to log the type of credentials given if an "Authorization" header was included in the request. Logging the authorization type may be useful, and is much more secure than logging the entire value of the "Authorization" header. |
| Default Value | true |
| 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 the names of any cookies included in an HTTP request. Logging cookie names may be useful and is much more secure than logging the entire content of the cookies (which may include sensitive information). |
| Default Value | true |
| 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 the names of any cookies set in an HTTP response. Logging cookie names may be useful and is much more secure than logging the entire content of the cookies (which may include sensitive information). |
| Default Value | true |
| 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 what (if any) information about request parameters should be included in request log messages. Note that this will only be used for requests with a method other than GET, since GET request parameters will be included in the request URL. |
| Default Value | parameter-names |
| Allowed Values | none - Indicates that no information about request parameters should be logged. parameter-names - Indicates that only the names of request parameters should be logged, but the values should be suppressed. parameter-names-and-values - Indicates that request parameter names and values should be logged. Note that request parameters may include sensitive information, so it may be desirable to suppress information about one or more such request parameters. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
suppressed-request-parameter-name
| Property Group | Log Message Elements To Include |
| Description | Specifies the case-insensitive names of request parameters that should be omitted from log messages (e.g., for the purpose of brevity or security). This will only be used if the log-request-parameters property has a value of parameter-names or parameter-names-and-values. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Log Message Elements To Include |
| Description | Indicates whether request log messages should include information about the HTTP version specified in the request. |
| Default Value | true |
| 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 the redirect URI (i.e., the value of the "Location" header from responses) should be included in response log messages. |
| Default Value | true |
| Allowed Values | true false |
| 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 | false |
| Allowed Values | true false |
| 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}] ...
To delete an existing Log Publisher:
dsconfig delete-log-publisher
--publisher-name {name}