DS 7.3.4

Error Log Publisher

This is an abstract object type 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.

Error Log Publishers

The following Error Log Publishers are available:

These Error Log Publishers inherit the properties described below.

Parent

The Error Log Publisher object inherits from Log Publisher.

Error Log Publisher properties

You can use configuration expressions to set property values at startup time. For details, see Property value substitution.

Basic Properties

default-severity
enabled
java-class
json-output
override-severity

Basic properties

Use the --advanced option to access advanced properties.

default-severity

Synopsis

Specifies the default severity levels for the logger.

Default value

error

warning

notice

Allowed values

  • all: Messages of all severity levels are logged.

  • debug: The error log severity that is used for messages that provide debugging information triggered during processing.

  • error: The error log severity that is used for messages that provide information about 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.

  • 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.

  • 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).

  • warning: The error log severity that is used for messages that provide information about warnings triggered during processing.

Multi-valued

Yes

Required

No

Admin action required

None

Advanced

No

Read-only

No

enabled

Synopsis

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

Advanced

No

Read-only

No

java-class

Synopsis

The fully-qualified name of the Java class that provides the Error Log Publisher implementation.

Default value

org.opends.server.loggers.ErrorLogPublisher

Allowed values

A Java class that extends or implements:

  • org.opends.server.loggers.LogPublisher

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

json-output

Synopsis

Output log lines using JSON format (structured logging) instead of free form text.

Default value

false

Allowed values

true

false

Multi-valued

No

Required

No

Admin action required

None

Advanced

No

Read-only

No

override-severity

Synopsis

Specifies the override severity levels for the logger based on the category of the messages.

Description

Each override severity level should include the category and the severity levels to log for that category, for example, core=error,info,warning. Valid categories are: core, extensions, protocol, config, log, util, schema, plugin, jeb, backend, tools, task, access-control, admin, sync, version, setup, admin-tool, dsconfig, user-defined. Valid severities are: all, error, info, warning, notice, 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

Advanced

No

Read-only

No
Copyright © 2010-2024 ForgeRock, all rights reserved.