Form ID: (SM302010)
You use this form to monitor statuses of the queues for push notifications, business event,
and commerce push notifications.
Attention: In a cluster environment, you should access this form by node.
Form Toolbar
The form toolbar includes standard buttons and
form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands can be
shown as buttons on the form toolbar, as commands on the More menu, or in both places.
These commands are listed in the following table in alphabetical order.
Element |
Description |
Show Errors |
Opens the Errors dialog box where you can review the
list of errors occurred during processing of the selected queue. |
Clear Queue |
Clears the selected queue. |
Restart Dispatcher |
Restarts services that are processing records in the selected queue. |
Summary Area
In this area, you can select a queue type to clear queues and restart dispatchers for the
selected queue type.
Element |
Description |
Queue Type |
There are three types available: Push Notifications, Business
Events, Commerce. |
Status |
A read-only box that displays the processing status of a queue which can be
either OK or Invalid. The system displays a warning with an error
details, in case of the Invalid status. |
Messages |
A read-only box that displays the current number of records in the
queue. |
Queue Size, KB |
Current and maximum queue size. By default, the maximum size is of a queue is
limited by 100 MB, which is the recommended size of the queue. If the current queue
size reaches 80% of the limit, the system displays a warning that limit will be
exceeded soon. You can use this parameter to monitor the queue growing size. |
Queue Name |
A read-only box that displays the name of the queue that was generated by the
queue service for the website during the site installation. |
Errors Dialog Box
You use this dialog box to view the list of errors occurred during processing of the
selected queue.
Attention: The system logs processing errors if the value of the
api:push-notifications:enable-dead-message-log
key is set to
True
in the
web.config file. You add the key to the
<appSettings>
section of the file as follows:
<add key="api:push-notifications:enable-dead-message-log" value="True" />
Table 1. Table Toolbar
The table toolbar includes standard buttons and
buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are
listed below.
Button |
Description |
Delete All |
Deletes all error records in the table. |
Show Source Data |
Opens the Source Data dialog box, where you can view
details of the notification whose processing raised an error. |
Table 2. Table Columns
Column |
Description |
Destination ID |
The internal identifier of a destination defined for the notification on the
Push Notifications(SM302000) form. |
Notification Source |
The identifier of a generic inquiry defined for the notification on the Push Notifications(SM302000) or Business Events (SM302050)
form. |
Internal Source Event |
The details of the notification whose processing raised an error. |
Error |
The description of an error. |
Date |
The date and time of an error occurrence. |
Statistics Tab
You use this tab to view statistics of a queue type selected in the Summary area. You can
specify for how long the system should keep statistics and longs for a queue type and
whether it should log trigger details. There two tabs where statistics is grouped by hours
and by minute, that include the same list of parameters that is described in the table
below.
Table 3. Summary Area
Element |
Description |
Keep Statistics and Logs for (Days) |
The number of days the system should keep statistics and long processing logs
in database. The records that are older than the specified period will be removed
automatically. If you do not need to keep the statistics at all, specify 0 value in
the box. |
Log Trigger Details |
A check box that indicates (if selected), that the system will save detailed
statistics for the selected queue type. You can view the details by clicking a link
in the Date column of the table on the Grouped by
Hour or Grouped by Minute tabs. |
Table 4. Table Columns
Column |
Description |
Date |
Time interval rounded by an hour or by minute, listed in descending order. You
can click the link in the column to open the Trigger Details
dialog box. If the Log Trigger Detailsis selected for the
queue type, the dialog box will display the detailed statistics, otherwise the
dialog box will display no details. |
Queued |
The number of messages came to the queue within the selected period of
time. |
Processed |
The number of messages processed by the dispatcher within the selected period
of time |
Max. Queue Size (KB) |
Maximum size of a queue for the selected period of time. |
Avg Processing Time (ms) |
Average processing time within the selected period of time. |
Max Processing Time (ms) |
Maximum processing time within the selected period of time. |
Trigger Details Dialog Box
You use this dialog box to review detailed statistics about the source of incoming messages
in the queue within the period of time selected in the Date column on
the Grouped by Hour or Grouped by Minute tab.
You can change the time period using the From and
To boxes.
Attention: Details are logged only if the Log
Trigger Details check box is selected on the Statistics
tab.
Table 5. Summary Area
Element |
Description |
From |
The start time of the time period rounded to hour. |
To |
The end time of the time period rounded to hour. |
Table 6. Triggering Fields Tab
Column |
Description |
Handler Definition |
A definition of a handler that triggered the messages (generic inquiry or
business event). |
Field |
The field name that triggered the messages within the selected period of
time. |
Messages |
The number of messages triggered within the selected period of time |
Table 7. Source DACs Tab
Column |
Description |
Screen |
An identifier of a screen which was the source of transaction. |
DAC |
The name of a DAC which was the source of transaction. |
Messages |
The number of messages triggered within the selected period of time |
Performance Issues Tab
You use this tab to configure saving of processing details for queues whose processing time
exceeds the specified threshold.
Table 8. Summary Area
Element |
Description |
Number of Records in Detailed Log |
The number of log events to be logged during processing of a transaction. The
log is to be displayed in the Queue Processing Log dialog box that you open
by clicking a link in the Date column from the table
below. |
Processing Time Threshold (s) |
The processing time threshold in seconds, set to 2 second by default. If
processing time of a record exceeds this value the system saves the processing
details. |
Table 9. Table Toolbar
The table toolbar includes standard buttons and
buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are
listed below.
Button |
Description |
Clear Logs |
Removes the saved logs for the selected queue. |
Table 10. Table Columns
Element |
Description |
Date |
Time interval rounded by an hour, listed in descending order. |
Processing Time |
The processing time of the queue within the selected period of time. |
Queries |
Queries involved in the processing. |