Metrics Engine Documentation Index
Configuration Reference Home

Error Log Publisher

Note: this is an abstract component that cannot be instantiated.

Error Log Publishers are responsible for distributing error log messages from the error logger to a destination.

Error log messages provide information about any warnings, errors, or significant events that are encountered during server processing.

Direct Subcomponents
Parent Component
Properties
dsconfig Usage

Direct Subcomponents

The following Error Log Publishers are available in the server :

These Error Log Publishers inherit from the properties described below.

Parent Component

The Error Log Publisher component inherits from the Log Publisher

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class
↓ default-severity
↓ override-severity

Basic Properties

description

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

enabled

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

java-class (Read-Only)

Description
The fully-qualified name of the Java class that provides the Error Log Publisher implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.ErrorLogPublisher
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

default-severity

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

override-severity

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


dsconfig Usage

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}