Queued RFC

This monitor is dedicated to the monitoring of RFC queues. It will watch for:
* Queue error status
* The number of current entries
* The number of entries older than a specified age

Configuration hints

The configuration table will define how the queues are going to be monitored. All collected queue results will be processed by each line of the table

Error status monitoring

If parameter Error severity is different than DISABLED, every queue having an error status and matching the filter will be processed for alerting

If aggregate parameter is OFF, one alarm per queue will be sent

If aggregate parameter is ON, only one alarm will be sent, indicating the total number of queues with errors

Number of entries

If max entries parameter is greater than 0, one alarm will be generated if the total amount of entries for queues matching the filter is greater than this value.

This check will be active only if aggregate parameter is ON

Entry age

If parameter Oldest entry age is greater than 0, collected queues having a state matching Queue status will be processed

If the age of the oldest entry is older than the threshold, an alarm will be generated

If aggregate parameter is OFF, one alarm per queue will be sent

If aggregate parameter is ON, only one alarm will be sent, indicating the total number of queues having old entries

Period parameter

The period parameter is only used for the queue errors check

If set to 0, the monitor will check queues with error status having a last update time more recent than the last check time

If different than 0, it will check queues with error status having a last update time younger than the start of the period

Queue filter and exclusion

You can filter queues based on their client, queue name and destination. Only the queues matching those filters will be processed by the rule.

If the exclusive option is ON, queue result matching the filter will not be processed by subsequent rules, they will be removed from the results pool.

Configuration

Send metadata:

If enabled, this parameter will send collected queue information as metadata to the configured plugins/integrations

It can usually be retrieved as logs or tabular data within the corresponding integrations

Send metrics

If enabled, the monitor will send metrics (See metrics table below)

Surveillance table

Parameter	Description
Active	Use this field to activate or deactivate a rule.
Period	To limit the period of time in the past (minutes) to look for QRFC errors. Set 0 for the period elapsed since the last check
Client	A filter to match only a subset of clients.
Queue	A filter to match only a given queue or subset of queues.
Destination	A filter to match a given destination.
Direction	Defines if the rule is to be applied for INBOUND or OUTBOUND queues.
Error Sev.	The severity of the alarm in case of queue error status.
Max entries	A threshold to define the maximum number of entries per queue.
Max Sev.	The severity of the alarm sent in case of too many entries.
Oldest entry age(min)	The threshold for the age of the oldest entry in a queue, in minutes.
Queue status (entry age)	Defines the status of the queue for which the “old entry check” will be performed. If NOSEND is set, it will only watch for old entries of queues having NOSEND status.
Wait Sev.	Defines the severity of the alarm sent for old entries.
Aggregates	If checked, for each breached threshold, only one alarm will be sent, indicating how many queues are over the limit. If not checked, one alarm per queue will be sent.
Auto clear	If checked, the alarm will be cleared as soon as the alarm condition is not met anymore.
Alarm tag	This 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.
Exclusive	If ON, the queue results matching the filter will not be processed by next rules
Alarm	If ON, this line of surveillance will be used for alarm generation.
Report	If ON, this line of surveillance will used for showing threshold and severity in the daily report

Examples

Active	Client	Queue	Destination	Direction	Period	Error Sev.	Max entries	Max Sev.	Oldest entry age(min)	Queue status	Wait Sev.	Aggregates	Auto clear	Alarm tag	Alarm	Metric	Report
true	*	*	*	OUTBOUND	60	CRITICAL	10	WARNING	30	NOSEND	WARNING	true	true	true	false	false

Effect : Watch for any OUTBOUND queue entries occurred in the alst 60 minutes. Send CRITICAL alarms if a queue with error state is detected. Send a WARNING alarm if 10 or more entries are found. Send a WARNING alarm if queues with NOSEND status contain entries older than 30 minutes.

Examples

Active	Client	Queue	Destination	Direction	Period	Error Sev.	Max entries	Max Sev.	Oldest entry age(min)	Queue status	Wait Sev.	Aggregates	Auto clear	Alarm tag	Alarm	Metric	Report
true	*	R3AD_MATERIAT12344	DTZ800	OUTBOUND	60	CRITICAL	100	MAJOR	NOSEND	WARNING	true	true	true	false	false

Effect : Watch for R3AD_MATERIAT12344 queue entries of destination DTZ800, with no limit of time. Send a CRITICAL alarm as soon as the queue has an error status and a MAJOR alarm if it contains 100 entries or more.

Generated metrics

metricId	metricUnit	metric tags	metricDescription
QRFC_ERRORS_COUNT	Errors	CLIENT, DIRECTION, DESTINATION, ERROR	Sends the error count for the last check period
QRFC_TOTAL_ERRORS_COUNT	Errors	CLIENT, DIRECTION, DESTINATION, ERROR	Sends the total error count