Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact support for assistance if you believe that you have a need to create or modify this type of object.
A legacy error log publisher that offers limited functionality and can only send unencrypted messages to a syslog server over UDP. It is only recommended for backward compatibility with older versions of the server. New deployments should use either the syslog-text-error-log-publisher or syslog-json-error-log-publisher.
The Syslog Based Error Log Publisher component inherits from the Error Log Publisher
The properties supported by this managed object are as follows:
General Configuration Basic Properties: | Advanced Properties: |
---|---|
description | None |
enabled | |
logging-error-behavior | |
Syslog Configuration Basic Properties: | Advanced Properties: |
server-host-name | syslog-facility |
server-port | |
Log Messages To Include Basic Properties: | Advanced Properties: |
default-severity | None |
override-severity | |
Other Configuration Basic Properties: | Advanced Properties: |
None | auto-flush |
asynchronous | |
queue-size |
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 Syslog Based Error Log Publisher is enabled for use. |
Default Value | None |
Allowed Values | true false |
Multi-Valued | No |
Required | Yes |
Admin Action Required | This is a legacy error log publisher that offers limited functionality and can only send unencrypted messages to a syslog server over UDP. It is only recommended for backward compatibility with older versions of the server. New deployments should use either the syslog-text-error-log-publisher or syslog-json-error-log-publisher. |
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 | Syslog Configuration |
Description | Specifies the hostname or IP address of the syslogd host to log to. It is highly recommend to use localhost. |
Default Value | localhost |
Allowed Values | A string |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
Property Group | Syslog Configuration |
Description | Specifies the port number of the syslogd host to log to. |
Default Value | 514 |
Allowed Values | An integer value. Lower limit is 1. Upper limit is 65535 . |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
Property Group | Log Messages To Include |
Description | Specifies the default severity levels for the logger. |
Default Value | fatal-error severe-warning severe-error |
Allowed Values | all - Messages of all severity levels are logged. none - No messages of any severity are logged by default. This value is intended to be used in conjunction with the override-severity property to define an error logger that will publish no error message beside the errors of a given category. fatal-error - The error log severity that is used for messages that provide information about fatal errors which may force the server to shut down or operate in a significantly degraded state. info - The error log severity that is used for messages that provide information about significant events within the server that are not warnings or errors. mild-error - The error log severity that is used for messages that provide information about mild (recoverable) errors encountered during processing. mild-warning - The error log severity that is used for messages that provide information about mild warnings triggered during processing. notice - The error log severity that is used for the most important informational messages (i.e., information that should almost always be logged but is not associated with a warning or error condition). severe-error - The error log severity that is used for messages that provide information about severe errors encountered during processing. severe-warning - The error log severity that is used for messages that provide information about severe warnings triggered during processing. debug - The error log severity that is used for messages that provide debugging information triggered during processing. |
Multi-Valued | Yes |
Required | No |
Admin Action Required | None. Modification requires no further action |
Property Group | Log Messages To Include |
Description | Specifies the override severity levels for the logger based on the category of the messages. Each override severity level should include the category and the severity levels to log for that category, for example, core=mild-error,info,mild-warning. Valid categories are: core, extensions, protocol, config, log, util, schema, plugin, jeb, backend, tools, task, access-control, admin, replication, version, quicksetup, admin-tool, dsconfig, user-defined. Valid severities are: all, fatal-error, info, mild-error, mild-warning, notice, severe-error, severe-warning, debug. |
Default Value | All messages with the default severity levels are logged. |
Allowed Values | A string in the form category=severity1,severity2... |
Multi-Valued | Yes |
Required | No |
Admin Action Required | None. Modification requires no further action |
syslog-facility (Advanced Property)
Property Group | Syslog Configuration |
Description | Specifies the syslog facility to use for this Syslog Based Error Log Publisher Enter a syslog facility code from the list
|
Default Value | 1 |
Allowed Values | An integer value. Lower limit is 0. Upper limit is 23 . |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
auto-flush (Advanced Property)
Property Group | Other Configuration |
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)
Property Group | Other Configuration |
Description | Indicates whether the Syslog Based Error Log Publisher will publish records asynchronously. |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
queue-size (Advanced Property)
Property Group | Other 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 | 10000 |
Allowed Values | An integer value. Lower limit is 1000. Upper limit is 100000 . |
Multi-Valued | No |
Required | No |
Admin Action Required | The Syslog Based Error Log Publisher must be restarted if this property is changed and the asynchronous property is set to true. |
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 Based Error Log Publisher:
dsconfig create-log-publisher --publisher-name {name} --type syslog-based --set enabled:{propertyValue} [--set {propertyName}:{propertyValue}] ...
To delete an existing Log Publisher:
dsconfig delete-log-publisher --publisher-name {name}