Web Services Report
To analyze the performance of web services running on a Web Services Hub, you can run a report for the Web Services Hub or for a web service running on the Web Services Hub.
The Web Services Report provides run-time and historical information on the web service requests handled by the Web Services Hub. The report displays aggregated information for all web services in the Web Services Hub and information for each web service running on the Web Services Hub. The Web Services Report also provides historical information.
Understanding the Web Services Report
You can run the Web Services Report for a time interval that you choose. The Web Services Hub collects information on web services activities and caches 24 hours of information for use in the Web Services Report. It also writes the information to a history file.
Time Interval
By default, the Web Services Report displays activity information for a five-minute interval. You can select one of the following time intervals to display activity information for a web service or Web Services Hub:
- •5 seconds
- •1 minute
- •5 minutes
- •1 hour
- •24 hours
The Web Services Report displays activity information for the interval ending at the time you run the report. For example, if you run the Web Services Report at 8:05 a.m. for an interval of one hour, the Web Services Report displays the Web Services Hub activity from 7:05 a.m. and 8:05 a.m.
Caching
The Web Services Hub caches 24 hours of activity data. The cache is reinitialized every time the Web Services Hub is restarted. The Web Services Report displays statistics from the cache for the time interval that you run the report.
History File
The Web Services Hub writes the cached activity data to a history file. The Web Services Hub stores data in the history file for the number of days that you set in the MaxStatsHistory property of the Web Services Hub. For example, if the value of the MaxStatsHistory property is 5, the Web Services Hub keeps five days of data in the history file.
Contents of the Web Services Report
The Web Services Report view contains information about the web services in the domain. When you select a web services hub in the Navigator, you can view the following information about the web services it contains:
- •Properties view. Displays General Properties, Web Services Hub Summary, and Historical Statistics for the web services hub.
- •Web Services view. Lists the web services in the web services hub. When you select a web service, you can view Properties, Top IP Addresses, and Historical Statistics for the web service.
General Properties and Web Services Hub Summary
To view the general properties and summary information for the Web Services Hub, select the Properties view in the content panel.
The following table describes the general properties:
Property | Description |
|---|
Name | Name of the Web Services Hub. |
Description | Short description of the Web Services Hub. |
Service type | Type of Service. For a Web Services Hub, the service type is ServiceWSHubService. |
The following table describes the Web Services Hub Summary properties:
Property | Description |
|---|
# of Successful Message | Number of requests that the Web Services Hub processed successfully. |
# of Fault Responses | Number of fault responses generated by web services in the Web Services Hub. The fault responses could be due to any error. |
Total Messages | Total number of requests that the Web Services Hub received. |
Last Server Restart Tme | Date and time when the Web Services Hub was last started. |
Avg. # of Service Partitions | Average number of partitions allocated for all web services in the Web Services Hub. |
% of Partitions in Use | Percentage of web service partitions that are in use for all web services in the Web Services Hub. |
Avg. # of Run Instances | Average number of instances running for all web services in the Web Services Hub. |
Web Services Historical Statistics
To view historical statistics for the web services in the Web Services Hub, select the Properties view in the content panel. The detail panel displays data from the Web Services Hub history file for the date that you specify.
The following table describes the historical statistics:
Property | Description |
|---|
Time | Time of the event. |
Web Service | Name of the web service for which the information is displayed. When you click the name of a web service, the Web Services Report displays the Service Statistics window. |
Successful Requests | Number of requests successfully processed by the web service. |
Fault Responses | Number of fault responses sent by the web service. |
Avg. Service Time | Average time it takes to process a service request received by the web service. |
Max Service Time | The largest amount of time taken by the web service to process a request. |
Min Service Time | The smallest amount of time taken by the web service to process a request. |
Avg. Service Partitions | Average number of session partitions allocated for the web service. |
Percent Partitions in Use | Percentage of partitions in use by the web service. |
Avg Run Instances | Average number of instances running for the web service. |
Web Services Run-time Statistics
To view run-time statistics for each web service in the Web Services Hub, select the Web Services view in the content panel. The Web Services view lists the statistics for each web service.
The report provides the following information for each web service for the selected time interval:
Property | Description |
|---|
Service name | Name of the web service for which the information is displayed. |
Successful Requests | Number of requests received by the web service that the Web Services Hub processed successfully. |
Fault Responses | Number of fault responses generated by the web services in the Web Services Hub. |
Avg. Service Time | Average time it takes to process a service request received by the web service. |
Avg. Service Partitions | Average number of session partitions allocated for the web service. |
Avg. Run Instances | Average number of instances of the web service running during the interval. |
Web Service Properties
To view the properties of a web service, select the web service in the Web Services view of the content panel. In the details panel, the Properties view displays the properties for the web service.
The report provides the following information for the selected web service:
Property | Description |
|---|
# of Successful Requests | Number of requests received by the web service that the Web Services Hub processed successfully. |
# of Fault Responses | Number of fault responses generated by the web services in the Web Services Hub. |
Total Messages | Total number of requests that the Web Services Hub received. |
Last Server Restart Time | Date and time when the Web Services Hub was last started |
Last Service Time | Number of seconds it took to process the most recent service request |
Average Service Time | Average time it takes to process a service request received by the web service. |
Avg.# of Service Partitions | Average number of session partitions allocated for the web service. |
Avg. # of Run Instances | Average number of instances of the web service running during the interval. |
Web Service Top IP Addresses
To view the top IP addresses for a web service, select a web service in the Web Services view of the content panel and select the Top IP Addresses view in the details panel. The Top IP Addresses displays the most active IP addresses for the web service, listed in the order of longest to shortest service times.
The report provides the following information for each of the most active IP addresses:
Property | Description |
|---|
Top 10 Client IP Addresses | The list of client IP addresses and the longest time taken by the web service to process a request from the client. The client IP addresses are listed in the order of longest to shortest service times. Use the Click here link to display the list of IP addresses and service times. |
Web Service Historical Statistics
To view a table of historical statistics for a web service, select a web service in the Web Services view of the content panel and select the Table view in the details panel. The details panel displays a table of historical statistics for the web service.
The table provides the following information for the selected web service:
Property | Description |
|---|
Time | Time of the event. |
Web Service | Name of the web service for which the information is displayed. |
Successful Requests | Number of requests successfully processed by the web service. |
Fault Responses | Number of requests received for the web service that could not be processed and generated fault responses. |
Avg. Service Time | Average time it takes to process a service request received by the web service. |
Min. Service Time | The smallest amount of time taken by the web service to process a request. |
Max. Service Time | The largest amount of time taken by the web service to process a request. |
Avg. Service Partitions | Average number of session partitions allocated for the web service. |
Percent Partitions in Use | Percentage of partitions in use by the web service. |
Avg. Run Instances | Average number of instances running for the web service. |
Running the Web Services Report
Run the Web Services Report from the Reports tab in the Administrator tool.
Before you run the Web Services Report for a Web Services Hub, verify that the Web Services Hub is enabled. You cannot run the Web Services Report for a disabled Web Services Hub.
1. In the Administrator tool, click the Reports tab.
2. Click Web Services.
3. In the Navigator, select the Web Services Hub for which to run the report.
In the content panel, the Properties view displays the properties of the Web Services Hub. The details view displays historical statistics for the services in the Web Services Hub.
4. To specify a date for historical statistics, click the date filter icon in the details panel, and select the date.
5. To view information about each service, select the Web Services view in the content panel.
The Web Services view displays summary statistics for each service for the Web Services Hub.
6. To view additional information about a service, select the service from the list.
In the details panel, the Properties view displays the properties for the service.
7. To view top IP addresses for the service, select the Top IP Addresses view in the details panel.
8. To view table attributes for the service, select the Table view in the detail panel.
Running the Web Services Report for a Secure Web Services Hub
To run a Web Services Hub on HTTPS, you must have an SSL certificate file for authentication of message transfers. When you create a Web Services Hub to run on HTTPS, you must specify the location of the keystore file that contains the certificate for the Web Services Hub. To run the Web Services Report in the Administrator tool for a secure Web Services Hub, you must import the SSL certificate into the Java certificate file. The Java certificate file is named cacerts and is located in the /lib/security directory of the Java directory. The Administrator tool uses the cacerts certificate file to determine whether to trust an SSL certificate.
In a domain that contains multiple nodes, the node where you generate the SSL certificate affects how you access the Web Services Report for a secure Web Services Hub.
Use the following rules and guidelines to run the Web Services Report for a secure Web Services Hub in a domain with multiple nodes:
- •For each secure Web Services Hub running in a domain, generate an SSL certificate and import it to a Java certificate file.
- •The Administrator tool searches for SSL certificates in the certificate file of a gateway node. The SSL certificate for a Web Services Hub running on worker node must be generated on a gateway node and imported into the certificate file of the same gateway node.
- •To view the Web Services Report for a secure Web Services Hub, log in to the Administrator tool from the gateway node that has the certificate file containing the SSL certificate of the Web Services Hub for which you want to view reports.
- •If a secure Web Services Hub runs on a worker node, the SSL certificate must be generated and imported into the certificate file of the gateway node. If a secure Web Services Hub runs on a gateway and a worker node, the SSL certificate of both nodes must be generated and imported into the certificate file of the gateway node. To view reports for the secure Web Services Hub, log in to the Administrator tool from the gateway node.
- •If the domain has two gateway nodes and a secure Web Services Hub runs on each gateway node, access to the Web Services Reports depends on where the SSL certificate is located.
For example, gateway node GWN01 runs Web Services Hub WSH01 and gateway node GWN02 runs Web Services Hub WSH02. You can view the reports for the Web Services Hubs based on the location of the SSL certificates:
- - If the SSL certificate for WSH01 is in the certificate file of GWN01 but not GWN02, you can view the reports for WSH01 if you log in to the Administrator tool through GWN01. You cannot view the reports for WSH01 if you log in to the Administrator tool through GWN02. If GWN01 fails, you cannot view reports for WSH01.
- - If the SSL certificate for WSH01 is in the certificate files of GWN01 and GWN02, you can view the reports for WSH01 if you log in to the Administrator tool through GWN01 or GWN02. If GWN01 fails, you can view the reports for WSH01 if you log in to the Administrator tool through GWN02.
- •To ensure successful failover when a gateway node fails, generate and import the SSL certificates of all Web Services Hubs in the domain into the certificates files of all gateway nodes in the domain.