Error Log Publisher Message Exclusion Policy

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.

The Error Log Publisher Message Exclusion Policies are policies that can be configured to exclude error log messages that match some specific criteria.

For the Error Log Publisher Message Exclusion Policies to exclude an error log message, the message must match all the criteria specified in the exclusion policy.

Parent Component Relations to This Component Properties dsconfig Usage

Parent Component

The Error Log Publisher Message Exclusion Policy component inherits from the Log Publisher Message Exclusion Policy

Relations to This Component

The following components have a direct aggregation relation to Error Log Publisher Message Exclusion Policies:

Properties

The properties supported by this managed object are as follows:


General Configuration Basic Properties: Advanced Properties:
 description  None
 enabled
Exclusion Criteria Basic Properties: Advanced Properties:
 log-message-category  None
 log-message-severity
 log-message-id
 log-message-regex

Basic Properties

description

Property Group
General Configuration
Description
A description for this Log Publisher Message Exclusion Policy
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 Message Exclusion Policy 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

log-message-category

Property Group
Exclusion Criteria
Description
The category of message the Error Log Publisher Message Exclusion Policy will check to exclude.
Default Value
None
Allowed Values
CORE - The category of messages that are core to the server.

EXTENSIONS - The category of messages that are related to server extensions.

PROTOCOL - The category of messages that are related to server protocols.

CONFIG - The category of messages that are related to server configuration.

LOG - The category of messages that are related to server logging.

UTIL - The category of messages that are related to server utilities.

SCHEMA - The category of messages that are related to server schema.

PLUGIN - The category of messages that are related to server plugins.

JEB - The category of messages that are related to the server's Java Entry Builder.

BACKEND - The category of messages that are related to server backends.

TOOLS - The category of messages that are related to server tools.

TASK - The category of messages that are related to server tasks.

ACCESS_CONTROL - The category of messages that are related to server access control.

ADMIN - The category of messages that are related to server administration.

REPLICATION - The category of messages that are related to server replication.

VERSION - The category of messages that are related to server version.

QUICKSETUP - The category of messages that are related to server quick setup.

ADMIN_TOOL - The category of messages that are related to server administration tools.

DSCONFIG - The category of messages that are related to server dsconfig.

USER_DEFINED - The category of messages that are user-defined.

EXAMINER - The category of messages that are related to server examiner.

SYNC - The category of messages that are related to server sync.

PROXY - The category of messages that are related to server proxy.

UPDATE - The category of messages that are related to server update.

CONSOLE - The category of messages that are related to server console.

CONSOLE_TOOLS - The category of messages that are related to server console tools.

COMMON - The category of messages that are related to server common.

METRIC - The category of messages that are related to server metric.

ID_SERVER - The category of messages that are related to server id server.

MONITORING - The category of messages that are related to server monitoring.

AUTHORIZATION - The category of messages that are related to server authorization.

THIRD_PARTY - The category of messages that are related to third-party integrations.

COMPONENTS - The category of messages that are related to server components.

RUNTIME_INFORMATION - The category of messages that are related to runtime information.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

log-message-severity

Property Group
Exclusion Criteria
Description
The severity level of the log message we want to exclude.
Default Value
None
Allowed Values
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.

INFORMATION - 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
No
Required
Yes
Admin Action Required
None. Modification requires no further action

log-message-id

Property Group
Exclusion Criteria
Description
Indicates the message id the Error Log Publisher Message Exclusion Policy will check to exclude. If the log-message-id is not set, the Error Log Publisher Message Exclusion Policy will check for a -1 message id value.
Default Value
None
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-message-regex

Property Group
Exclusion Criteria
Description
The message regex the Error Log Publisher Message Exclusion Policy will check to exclude. If the error log message matches this regular expression, it will be excluded.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Log Publisher Message Exclusion Policies:

dsconfig list-log-publisher-message-exclusion-policies
     [--property {propertyName}] ...

To view the configuration for an existing Log Publisher Message Exclusion Policy:

dsconfig get-log-publisher-message-exclusion-policy-prop
     --policy-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Log Publisher Message Exclusion Policy:

dsconfig set-log-publisher-message-exclusion-policy-prop
     --policy-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Error Log Publisher Message Exclusion Policy:

dsconfig create-log-publisher-message-exclusion-policy
     --policy-name {name}
     --type error
     --set enabled:{propertyValue}
     --set log-message-category:{propertyValue}
     --set log-message-severity:{propertyValue}
     --set log-message-regex:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log Publisher Message Exclusion Policy:

dsconfig delete-log-publisher-message-exclusion-policy
     --policy-name {name}