Data Sync Server Documentation Index
Configuration Reference Home

Third Party Error Log Publisher

Third Party Error Log Publisher provide error log publisher implementations created in third-party code using the UnboundID server SDK.

Parent Component
Properties
dsconfig Usage

Parent Component

The Third Party Error Log Publisher component inherits from the Error Log Publisher

Properties

The properties supported by this managed object are as follows:


General Configuration Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ logging-error-behavior
Custom Extension Configuration Basic Properties: Advanced Properties:
↓ extension-class  None
↓ extension-argument
Log Messages To Include Basic Properties: Advanced Properties:
↓ default-severity  None
↓ override-severity

Basic Properties

description

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

enabled

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

logging-error-behavior

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

extension-class (Read-Only)

Property Group
Custom Extension Configuration
Description
The fully-qualified name of the Java class providing the logic for the Third Party Error Log Publisher.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.common.api.ErrorLogger
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Property Group
Custom Extension Configuration
Description
The set of arguments used to customize the behavior for the Third Party Error Log Publisher. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

default-severity

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

override-severity

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


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 create a new Third Party Error Log Publisher:

dsconfig create-log-publisher
     --publisher-name {name}
     --type third-party
     --set enabled:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log Publisher:

dsconfig delete-log-publisher
     --publisher-name {name}