Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
JDBC Based Error Log Publishers store error log information using a JDBC database connection.
JDBC Based Error Log Publishers store error log information to a database table using a JDBC connection. There are two additional configuration items to complete for a JDBC Based Error Log Publisher. First, you will need to decide what fields to log. You can use or copy one of the provided Log Field Mapping configurations. Any field that has a database column specified will be logged. If no field is specified, then it will not be logged. To aid in database table creation, an example database DDL is written to a file at the root of the server installation directory under 'logs/ddls'. Second, you will need to specify the connection parameters to a database using the JDBC External Server configuration.
The JDBC Based Error Log Publisher component inherits from the Error Log Publisher
The following components have a direct aggregation relation from JDBC Based Error Log Publishers:
The properties supported by this managed object are as follows:
| General Configuration Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| logging-error-behavior | |
| JDBC Configuration Basic Properties: | Advanced Properties: |
| server | None |
| log-field-mapping | |
| log-table-name | |
| Log Messages To Include Basic Properties: | Advanced Properties: |
| default-severity | None |
| override-severity | |
| Other Configuration Basic Properties: | Advanced Properties: |
| None | 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 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 | JDBC Configuration |
| Description | The JDBC-based Database Server to use for a connection. |
| Default Value | None |
| Allowed Values | The DN of any JDBC External Server. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Property Group | JDBC Configuration |
| Description | The log field mapping associates loggable fields to database column names. The table name is not part of this mapping. You will need to decide what fields to log to the JDBC Based Error Log Publisher. You can use or copy one of the provided Log Field Mapping configurations. Any field that has a database column specified will be logged. If no field is specified, then it will not be logged. To aid in database table creation, an example database DDL is written to a file at the root of the server installation directory under 'logs/ddls'. |
| Default Value | None |
| Allowed Values | The DN of any Error Log Field Mapping. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Property Group | JDBC Configuration |
| Description | The table name to log entries to the database server. |
| Default Value | error_log |
| Allowed Values | A string |
| 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 |
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 JDBC 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 JDBC Based Error Log Publisher:
dsconfig create-log-publisher
--publisher-name {name}
--type jdbc-based
--set enabled:{propertyValue}
--set server:{propertyValue}
--set log-field-mapping:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log Publisher:
dsconfig delete-log-publisher
--publisher-name {name}