Using the Concurrency Quota Policy

Learn how to monitor web service concurrency performance by specifying a concurrency limit (quota).

About Policies Managing Policies QoS Policies

Use Cases for Policy Manager Use Cases for the Akana API Platform (Community Manager)

Supported Platforms: 7.x, 8.0

Table of Contents

  1. Introduction
  2. Concurrency Quota Policy Options
  3. Configuration
  4. Use Cases for Policy Manager
  5. Use Cases for the Akana API Platform (Community Manager)

Introduction

A Concurrency Quota Policy is a Quality of Service (QoS) policy that allows you to monitor the web service concurrency performance by specifying a concurrency limit (quota) that represents the maximum number of connections, and configuring fault and alert notifications.

You can define a fault message by specifying the following values:

  • Name (Fault Message)
  • SOAP fault element that holds errors and status information for a SOAP message (Fault Element Name)
  • URL that points to the fault code schema (Fault Namespace URI)
  • URL that points to the fault code schema (Fault Namespace URI)

You can also define Alert Codes in the Alerts > Alert Codes section and enable and select them in the policy definition.

If the specified concurrency limit is exceeded, Policy Manager returns a fault and sends an alert.

Concurrency 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 Concurrency Quota Policy.
  • Description: A read-only field that displays the description of the Concurrency Quota Policy.
Concurrency Quota
  • Concurrency Limit: Allows you to specify a concurrency limit (quota) that represents the maximum number of concurrency connections.
  • Fault Message: Allows you to enter the SOAP fault message (that is, <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 sends the alert that is selected on the Alert Code drop-down list. The alert is sent at the Reminder Alert Interval until the consumer is within the quota.
  • Reminder Alert Interval(s): Allows you to enter an interval (in seconds) at which Reminder Alerts will be sent until the consumer is within the quota.  
  • Alert Code: A drop-down menu that displays a list of custom alert codes that you have defined. If you have "Send Reminder Alert" selected, alerts will be sent based on the alert interval defined using the selected Alert Code. For more information on defining an Alert Code, see About Alert Codes in the Policy Manager Online Help.
  • Clear Alert Code: A drop-down menu that displays a list of custom alert codes that you have defined. If you have "Send Reminder Alert" selected, alerts are sent when the alert condition no longer exists.
  • Reminder Alert Code: A drop-down menu that displays a list of custom alert codes that you have defined. If you have "Send Reminder Alert" selected, alerts are sent based on the specified interval when the condition continues to be exceeded.

Back to top

Configuration

Let's take a quick walkthrough of the Concurrency Quota Policy configuration process to get you started.

Step 1: Add Policy

In Policy Manager, to create a Concurrency 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 Concurrency 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 Concurrency 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.

Back to top

Use Cases for Policy Manager

For a list of Policy Manager-specific use cases for the Concurrency Quota Policy, refer to Concurrency Quota Policy Usage Scenarios for Policy Manager.

Back to top

Use Cases for the Akana API Platform (Community Manager)

For a list of Community Manager-specific use cases for the Concurrency Quota Policy, refer to Concurrency Quota Policy Usage Scenarios for Community Manager.

Back to top