The Syslog JSON HTTP Operation Log Publisher can be used to write JSON-formatted HTTP operation log messages to a syslog server.
The Syslog JSON HTTP Operation Log Publisher component inherits from the JSON Formatted HTTP Operation Log Publisher
The following components have a direct aggregation relation from Syslog JSON HTTP Operation Log Publishers:
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 |
| Syslog Configuration Basic Properties: | Advanced Properties: |
| syslog-external-server | queue-size |
| syslog-facility | |
| syslog-severity | |
| syslog-message-host-name | |
| syslog-message-application-name | |
| 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 | Syslog Configuration |
| Description | The syslog server to which messages should be sent. Multiple servers can be configured for the sake of redundancy. If multiple servers are configured, then they must all be configured to communicate over TCP (with or without TLS encryption). When sending a syslog message, servers will be tried in the order in which they are listed. |
| Default Value | None |
| Allowed Values | The DN of any Syslog External Server. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Syslog Configuration |
| Description | The syslog facility to use for the messages that are logged by this Syslog JSON HTTP Operation Log Publisher. |
| Default Value | system-daemons |
| Allowed Values | user-level-messages - A facility that is commonly used for messages logged by user applications running on the system. This facility has an integer value of 1. system-daemons - A facility that is commonly used for messages logged by daemon processes running on the system. This facility has an integer value of 3. security-and-authorization - A facility that is commonly used for messages related to security and authorization-related processing. This facility has an integer value of 4. security-and-authorization-alternative - An alternative facility for messages related to security and authorization-related processing. This facility has an integer value of 10. log-audit - A facility for messages related to log audit processing. This facility has an integer value of 13. log-alert - A facility for messages related to log alert processing. This facility has an integer value of 14. local-use-0 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 16. local-use-1 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 17. local-use-2 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 18. local-use-3 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 19. local-use-4 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 20. local-use-5 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 21. local-use-6 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 22. local-use-7 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 23. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Syslog Configuration |
| Description | The syslog severity to use for the messages that are logged by this Syslog JSON HTTP Operation Log Publisher. |
| Default Value | informational |
| Allowed Values | emergency - A severity that is commonly used for messages indicating that the system is unusable. This severity has an integer value of 0. alert - A severity that is commonly used for messages that require immediate administrative action. This severity has an integer value of 1. critical - A severity that is commonly used for messages that represent critical error conditions. This severity has an integer value of 2. error - A severity that is commonly used for messages that represent non-critical error conditions. This severity has an integer value of 3. warning - A severity that is commonly used for messages that represent warning conditions. This severity has an integer value of 4. notice - A severity that is commonly used for messages that represent normal but significant conditions. This severity has an integer value of 5. informational - A severity that is commonly used for informational messages. This severity has an integer value of 6. debug - A severity that is commonly used for debug messages. This severity has an integer value of 7. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Syslog Configuration |
| Description | The local host name that will be included in syslog messages that are logged by this Syslog JSON HTTP Operation Log Publisher. If this is specified, then the value must be between 1 and 255 characters in length, and it must contain only printable ASCII characters between 0x21 (the '!' character) and 0x7E (the '~') character, inclusive. It should represent a qualified or unqualified hostname, an IPv4 address, or an IPv6 address. If this is not specified, then the server will attempt to automatically determine the hostname for the local system. If no hostname should be included in syslog messages, then a value of "-" should be used. |
| Default Value | The server will attempt to automatically determine the hostname for the local system. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
syslog-message-application-name
| Property Group | Syslog Configuration |
| Description | The application name that will be included in syslog messages that are logged by this Syslog JSON HTTP Operation Log Publisher. If this is specified, then the value must be between 1 and 48 characters in length, and it must contain only printable ASCII characters between 0x21 (the '!' character) and 0x7E (the '~') character, inclusive. If this is not specified, then the server will use a default value of "PingDirectory". If no application name should be included in syslog messages, then a value of "-" should be used. |
| Default Value | The server will use a default value of "PingDirectory". |
| Allowed Values | A string |
| 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 |
queue-size (Advanced Property)
| Property Group | Syslog Configuration |
| 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 | 100000 |
| Allowed Values | An integer value. Lower limit is 1000. Upper limit is 100000 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Syslog JSON HTTP Operation Log Publisher must be restarted if this property is changed and the asynchronous property is set to true. |
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 create a new Syslog JSON HTTP Operation Log Publisher:
dsconfig create-log-publisher
--publisher-name {name}
--type {type}
--set enabled:{propertyValue}
--set syslog-external-server:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log Publisher:
dsconfig delete-log-publisher
--publisher-name {name}