Using the Throughput Quota Policy
Learn how to monitor web service throughput performance by specifying a throughput limit (quota) and queue size, and by configuring fault and alert notifications.
Supported Platforms: 7.x, 8.0
Table of Contents
- Throughput Quota Policy Options
- Use Cases for Policy Manager
- Use Cases for the Akana API Platform (Community Manager)
A Throughput Quota Policy is a Quality of Service (QoS) policy that allows you to monitor web service throughput performance by specifying a throughput limit (quota) and queue size, and by configuring fault and alert notifications.
If the quota is exceeded, a Consumer Fault Message is returned to the service consumer and an alert is logged.
Throughput Quota Policy Options
The policy includes the configuration options listed below.
Concurrency Quota Policy Details
- Name: A read-only field that displays the name of the Throughput Quota Policy.
- Description: A read-only field that displays the description of the Throughput Quota Policy.
- Throughput Limit: Allows you to specify the throughput limit; number, and unit of measure (secs or mins).
- Fault Message: Allows you to enter the SOAP fault message (<faultString>).
- Fault Element Name: Allows you to enter the SOAP fault element that holds errors and status information for a SOAP message.
- Fault Namespace URI: Allows you to enter the URL that points to the fault code schema.
- Fault Namespace Prefix: Allows you to enter the fault namespace prefix.
- Time to Clear Alert(s): Allows you to enter the time that the throughput needs to be within the limit before a second alert is sent to signify that the consumer is once again within the quota.
- Set Reminder Alert: A checkbox that enables the Reminder Alert function. This function is an alert that is sent at the specified Reminder Alert Interval until the consumer is within the quota.
- Reminder Alert Interval(s): Allows you to enter an interval (in seconds) that Reminder Alerts will be sent until the consumer is within the quota.
Let's take a quick walkthrough of the Throughput Quota Policy configuration process to get you started.
Step 1: Add Policy
In Policy Manager, to create a Throughput Quota Policy instance, go to Policies > QoS Policies and choose Add Policy.
Step 2: Modify Policy
When you click Modify to make changes to the Throughput Quota Policy on the Policy Details page, the initial policy looks like this:
Configure the policy options based on your requirements and click Apply.
Step 3: Attach Policy
After you've saved your policy, you can attach it to a web service, operation, or binding.
Step 4: Test Policy and View Monitoring Data
After you've attached the Throughput Quota Policy to a web service, operation, or binding, send a request to your service and go to the Services > Monitoring section to view the results for Logs, Real Time Charts, and Historical Charts. For more information on using the monitoring functions, refer to the Policy Manager Online Help, available via the Help button.
Use Cases for Policy Manager
For a list of Policy Manager-specific use cases for the Throughput Quota Policy, refer to Throughput Quota Policy Usage Scenarios for Policy Manager.
Use Cases for the Akana API Platform (Community Manager)
For a list of Community Manager-specific use cases for the Throughput Quota Policy, refer to Throughput Quota Policy Usage Scenarios for Community Manager.