products:promonitor:6.8:monitorsguide:netweaver:piximessagesjava

PI/XI messages JAVA

Purpose

This monitor is dedicated to the monitoring of PI/XI messages status of Java stack instances. It will detect messages with an error status and report with alarms and metrics

Prerequisites

In case of the user management engine (UME) referred to a data source served by an ABAP client stack, the user account to access PI/XI information in the web portal must meet the following prerequisites: - The web client connection user must be created in the client of the UME associated ABAP system (normally it is the “production” client, ask to the users administrator). - Following roles must be granted to the user: SAP_XI_DISPLAY_USER_J2EE, SAP_XI_RWB_SERV_USER (exclusively, DO NOT USE A COPY)

Configuration hints

This monitor must be used with a Web portal connector to the target SAP system, with user credentials having access to the PI/XI messages view

You must specify the XI components that you want to monitor, you cannot use regular expressions for this filter. To discover the available XI components from your system, you can call the following servlet with your web browser: - http://[host]:[port]/mdt/messageoverviewqueryservlet

It will return the available components in the XIComponents tag.

You can filter in or out certain types of messages by using Sender, Receiver and Interface fields. You can adjust the level of alarm severity depending on the type of status or on message characteristic. A disabled severity will filter out the messages matching the filters, for all subsequent lines. With this monitor, you will have the possibility to be notified when a given number of messages from an XI component are in a given state, within a period of time.

Atomic fields

Alarm severity for component collection errorLevel of the alarm when the probe can't collect information about a component defined in the surveiliance table

Surveillance table

ParameterDescription
ActiveUse this field to activate or deactivate a line of configuration.
StatusDefine the type message status to look for.
PeriodDefines the period of time in which the probe will look for messages.
ComponentDefines the xi component associated with the messages. The exact component name must be specified here.
SenderA filter for the sender of the messages.
ReceiverA filter for the receiver of the messages.
InterfaceA filter for the message interface.
Max. messagesThe threshold of the alarm generated if an equal or greater number of messages pass the alarm filter.
AggregatesIf not set, threshold will be compared to the number of messages grouped by Sender, Receiver and Interface. If set, the threshold will be compared to the cumulated number of messages.
SeverityThe default severity to apply when the simple threshold syntax is used.
Auto clearIf checked, the alarm will be cleared as soon as the alarm condition is not met anymore.
Alarm tagThis field allows to add custom text within the alarm message. %MSG% variable will contain the actual generated message and can be used such as: “my_prefix %MSG% my_suffix”. By default, tag will be used as prefix.
AlarmIf checked, this line of surveillance will be used for alarm generation.
MetricIf checked, this line of surveillance will be used for metric generation.
ReportIf checked, this line of surveillance will used for showing threshold and severity in the daily report

Examples

ActiveStatusPeriodComponentSenderReceiverInterfaceMax. messagesAggregatesSeverityAuto clearAlarm tagAlarmMetricReport
trueHOLDINGCURRENT_HOURmssql.xi.id2***5trueWARNINGtrue truefalsefalse

Effect : Sends a WARNING alarm if 5 or more messages are in HOLDING state in the current hour for the component mssql.xi.id2.

Examples

ActiveStatusPeriodComponentSenderReceiverInterfaceMax. messagesAggregatesSeverityAuto clearAlarm tagAlarmMetricReport
trueSYSTEM ERRORLAST_DAYmssql.xi.id2SenderX**50trueMAJORtrue truefalsefalse

Effect : Sends a MAJOR alarm if 50 or more messages are in SYSTEM ERROR state in the previous day, sent by SenderX.

Generated metrics

metricIdmetricUnitmetricTargetmetricDescription
PIXI_JAVA_MESSAGE_STATUSMessage errors[STATUS][PERIOD][SENDER][RECEIVER][INTERFACE]Sends TRUE if the corresponding rule generated an alarm, FALSE instead
PIXI_JAVA_MESSAGE_STATUS_COUNTStatus[STATUS][PERIOD][SENDER][RECEIVER][INTERFACE]Sends the number of messages matching the filter
/home/clients/8c48b436badcd3a0bdaaba8c59a54bf1/wiki-web/data/pages/products/promonitor/6.8/monitorsguide/netweaver/piximessagesjava.txt · Last modified: 2024/05/01 18:35 (external edit)