Menu Path : Monitoring>Routes>Route Details |
Required Access Rights:
|
Optional Access Group Rights:
|
The Route Details page displays the statistics and details for the selected route. It consists of the following panels:
Overview
Field /Action |
Description |
|---|---|
Name |
The name of the route, for example Route for Gen Source. |
Status Icon |
Routes can take on the following states:
|
Route Location |
Identifies the name of the folder (if any) in which the route is located in Rhapsody IDE. Routes and communication points can be organized into folders and sub-folders using the Rhapsody IDE workspace. |
Start Route/Stop Route |
Depending on the current status of the route, click the link to Stop or Start the route. |
Route Details
Click the Route Details link to view the details pane for the route. Click the Hide link to hide the route details pane.
Field |
Description |
|---|---|
Input |
Displays all the input communication points and cross-connected routes for this route and their current status. For each component, the following information is displayed:
Click a component's name to display its corresponding component details page. |
Filters |
Displays the filters currently present on the route. For each filter, the following information is displayed:
Click a filter's name to open its Filter Details page. |
Output |
Displays all the all output communication points and cross-connected routes for this route. For each component, the following information is displayed:
Click a component's name to display its corresponding component details page. |
Throughput
The graph displays the messages that have been sent, received and failed on a communication point over time. This enables you to monitor and view processing trends, for example, message spikes. You can alter the display period of the graph as follows:
- All - displays all processed messages.
- 60d - displays messages processed in the last 60 days.
- 30d - displays messages processed in the last 30 days.
- 7d - displays messages processed in the last 7 days.
- 24h - displays messages processed in the last 24 hours.
- 1h - displays messages processed in the last 1 hour.
To zoom, click and drag on the graph.
The Advanced button enables you to show or hide the Failed line graph. It is disabled by default.
Exporting Statistics
The throughput and system statistics can be exported as a CSV file that contains the following information:
| Column | Description |
|---|---|
| Component Type | The component type:
|
| Component Identifier | The identifier of the component. |
| Component Name | The name of the component (if the component type is the system, the engine name is displayed). |
| Statistics Type | The type of throughput statistics:
|
| Timestamp | The time in the current time zone when the throughput statistic was collected. When using UTC for export time, the time is recorded in UTC. |
| Value | The number of messages collected within the given time period based on the Statistics Type. |
| Optional Value | When using UTC for export time, Optional Value is the offset in milliseconds added to the time of export in the current time zone to obtain the time in UTC; when not using UTC, the offset is zero. |
To export throughput statistics for individual routes or all statistics for the system:
Click the Export link next to Throughput to display the Export Statistics dialog:
Select one of the following radio buttons:
Option
Description
Throughput Statistics Only for <route name>
Only exports throughput statistics for a specific individual route.
All System and Engine Statistics
Exports all statistics types for the system.
- Select the collection time period of statistics you want to export from the Export Last drop-down list.
Select the Export Times Using UTC checkbox if you want to export the data using Coordinated Universal Time as the time zone.
If this option is not selected, the data is exported using the local time of the Rhapsody engine, which could potentially result in time discrepancies, if a daylight saving changeover occurs during the period the statistics were collected.
- Select the Export button to export the data to a zipped
.csvfile.
Activity Feed
The Activity Feed is divided into two panels:
Current Issues
The Current Issues panel displays all the current issues for the selected component, for example:
| Element | Description |
|---|---|
| Alert Severity | Indicates the level of severity (alarm or warning). |
| Issue | The name of the issue raised |
| Time | The date and time the alert was raised, and how long ago. |
| Actions | Clickable links that you can use to act upon the issues. |
Managing Current Issues
Use the following actions to manage current issues:
Action |
Description |
|---|---|
Comment |
Click the Comment link to enter a comment for the issue. |
Previously Resolved |
Click the link to filter the activity feed to display only the related historical resolved issues. This link will only show for Numerical Issues. The number represents the number of issues of the same type which are in the historically resolved part of the Activity Feed. |
Dismiss Alert |
Click the link to Dismiss the issue and enter a comment in the text box. Numerical Issues also have the option to Suspend Notifications, where you can enter the time in minutes to suspend notifications for the "Issue" (not "Issue Type"). For a Non-Numerical Issue, clicking Dismiss will move it immediately to the Historical Issues section. Clicking the Dismiss link for a Numerical Issue will mark it as "Dismissed". Rhapsody will continue to check the threshold until the issue is resolved. Once the issue is resolved, it will move to the Historical Issues section. Until the issue is resolved it will stay in the Current Issues. If the severity of the issue increases, for example from "Warning" to "Alarm", the issue will no longer appear as "Dismissed". Refer to Working with Issues for details. |
Reactivate Alert |
Click the link to cancel the "Dismissed" state, thus Reactivating the severity of the issue. Refer to Working with Issues for details. This link will only appear for Numerical Issues that are currently "Dismissed". |
Suspend Notifications |
Click the link and enter a Suspend Notification time in minutes to suspend notifications for the "Issue" (not "Issue Type"). |
Resume Notifications |
Click the link to Resume Notifications for the "Issue" (not "Issue Type"). This link will only appear when notifications for this issue are currently suspended. |
Assign |
Click the link and select a user to assign the issue to. |
Activity |
Click the Activity link to show or hide the activity for the specific issue. The number represents the number of items that will be shown. |
Because the system may be updating the state of an issue while you are in the process of performing an action on it, the system will occasionally not let you perform the action without first reviewing the changes that have happened. In this case, it will ask you to refresh the page and try the action again. You may wish to copy the text of any comment you have entered to your clipboard so that you can then have the option of pasting it after you have refreshed the page.
Historical Issues
The Historical Issues panel displays all the current issues for the selected component, for example:
| Element | Description |
|---|---|
| Filters | Clickable links that you can use to filter the list of displayed issues. |
| Alert Severity | Indicates the level of severity (alarm or warning). |
| Issue | The name of the issue raised |
| Time | The date and time the alert was raised, and how long ago. |
| Actions | Clickable links that you can use to manage the issues. |
Filtering Historical Issues
Use the following filters to filter historical issues:
| Filter | Description |
|---|---|
| Issue Types | The issue types to filter on. |
| Log Level | The issue types to filter on. |
| Show/Hide Comments | Toggle the Comments icon This does not filter comments placed against an issue. |
| Notifications | Toggle the Notifications button to view all or none of the following entries in the Activity Feed:
This shows notifications in both the Current Issues and Historical Issues panels. |
Managing Historical Issues
Use the following actions to manage historical issues:
Action |
Description |
|---|---|
Make a comment |
Click the Make a comment link to add a comment to the Activity Feed. |
| Comment | Click the Comment link next to a historical issue to comment on that specific issue. |
| Activity | Click the Activity link next to a historical issue to show or hide the activity for this issue. The number represents the number of items that will be shown. |
| Show error details | Click the Show error details link next to a historical issue to show the stack trace of any error. |
Details and Statistics
The Details and Statistics panel displays message details and statistical information:
Field |
Description |
|---|---|
Messages Processed |
The total number of messages processed by this route since Rhapsody was installed. In other words, the total number of messages that have entered the route and subsequently left the route without any error. This number does not include any duplicate or split messages that are spawned within the route or messages that are sent to the Error Queue or Hold Queue. |
Messages Processed Since Reset |
The total number of messages processed on this route since the count was reset. To reset the message count to zero, click the Reset link. The count is user specific. |
Messages waiting to enter route |
The number of messages waiting to enter the route. This can indicate that there are messages on the input communication point outbound queue, waiting to enter the route for processing. |
Processing Queue |
The number of messages currently on the processing queue. For example, when a filter is processing a message (such as a message collection, mapping, and so on), it will show on this queue. Click the View link to view waiting messages (the View link is displayed only when the route is stopped). |
Idle Time |
The period of time (in seconds, minutes, hours, or days) since a message was last processed by this route. |
Log Level |
The log level for this route. Click the Change link to select a log level from the drop-down list. You can select from the following log levels:
Refer to Logging Levels for details. |
View Error Messages |
Displays a list of all messages that were routed to the Error Queue from this route. |
View Log File |
Click the View Log File link to display the log file for the route. Refer to System Log for details. |
Support Notes
The Support Notes panel displays the support note you added through Rhapsody IDE.
Notifications
The Notifications panel displays a read-only list of all recipients (users, watchlists, emails or SNMP).
Click the Change link to display the Change Notification dialog where you can set up custom notification preferences for the selected component and override the default set up on the Default Notification Settings page.
When you click the Change link to edit the list of recipients who will receive notifications, it only applies to the selected component.
To edit a watchlist notification preference, click the watchlist name to display the Watchlists page.
- Click the Suspend All link to suspend all the notifications for the selected component. When you suspend notifications for the selected component an information banner is displayed above the Activity Feed:
- Click the Resume Notifications link to resume notifications for the selected component. Refer to Suspend / Resume All Notifications for details.
Custom Thresholds
The Custom Thresholds panel enables you to set up custom thresholds for alerts for the selected component.
For a descriptive list of alerts applicable to a communication point, refer to Default Threshold Settings.
Click the Change link to display the Change Thresholds dialog where you can setup threshold values that are appropriate for the selected component.
Select the Yes button and then select the Warning or Alarm button to raise an issue for the selected component. Select the No button if you do not wish to raise a warning or alarm for an issue for the selected component.
The changes will overwrite the Default Settings only for the issue that you have changed the threshold settings for and only for the selected component. To revert to the default settings for a particular issue, on the Change Threshold dialog, click the Use Default Settings link for an issue.
Click the Add Time Period link to set the time scale to be applied to the threshold for the component.
- To apply the time period, select a time period from the drop-down list and select the Apply button.
- To remove the time period, select a time period you want to remove from the drop-down list and click the Remove Selected Period link.
Configuration
The Configuration panel displays the configuration properties for the route:
Field |
Description |
|---|---|
Startup State |
Displays the startup state for the route. The startup state of a route determines whether the route is automatically started when the Rhapsody engine is started. |
Start only if previously running |
Set to |
Route FIFO Mode |
Displays the FIFO Mode for the route. |
Route Priority |
Displays the route processing priority. |