Menu Path : Monitoring>Web Services>Web Service Details |
Required Access Rights:
|
Optional Access Group Rights:
|
The Web Service Details page displays details and statistics for a web service and the communication points where the web service is used. It consists of the following panels:
Overview
Field/Action |
Description |
|---|---|
Name |
The name of the web service. |
Status |
Web services can take on the following states:
|
Restart Web Service |
Click the Restart link to restart the web service. |
Communication Points This Web Service Is Used In
Field |
Description |
|---|---|
Communication Point |
Identifies the communication points that use this web service and their current status (started or stopped). Click the communication point's name to display the Communication Point Details page. |
Mode |
Identifies the operational mode of the communication point. |
Status |
For each communication point the following information is displayed:
You must stop the communication point to view messages on the inbound and outbound queues. |
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
To export throughput statistics for individual web services or all statistics for the system:
Click the Export link next to Throughput to display the Export Statistics dialog box:
Select one of the following radio buttons:
Option
Description
Throughput Statistics Only for <web service name>
Only exports statistics for a specific web service.
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 CSV file.
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/Action |
Description |
|---|---|
Messages Received / Sent |
A count of the messages received/sent by this web service since it was created and started for the first time. |
Messages Received / Sent Since Reset |
A count of the messages received/sent by this web service since the count was reset. To reset the message count to zero (0), click the Reset link. |
Idle Time |
The period of time (in seconds, minutes, hours or days) since a message was last processed by this Web service. |
Up Time |
The period of time (in seconds, minutes, hours or days) that this web service has been running. |
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 Log File |
Click the View Log File link to display the log file for the web service. Refer to System Log for details. |
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.
Web Service Operations
The Web Service Operations panel displays web service operation details.
Field |
Description |
|---|---|
Name |
The local name of the operation. |
Mode |
In-Only or Request-Response |
Description |
A description of the web service operation. |
Configuration
The Configuration panel displays the configuration properties for this web service, defined on the Configuration tab of the Web Service Properties window in Rhapsody IDE. Each web service has a different set of properties depending on the information it requires.