Copyright © Cloud Software Group, Inc. All Rights Reserved

Configuring Throttles

Using the Config UI, you can configure all types of the throttles. This section explains how to create a throttle policy definition and assign a throttle policy to a partner, partner group, partner operation, or target operation.

Configuration Parameters for Throttles

The following table describes the parameters required to configure throttles. These parameters can be configured under the Monitors tab of a project configuration on the Config UI.

Table 88 Throttle Configuration Parameters

Parameter	Description
Monitor Name	• Specifies the name of the throttle. The name of the throttle is required to configure the throttle for a service, partner, partner group, or partner operation. • Required.
Monitor Type	• Specifies the type of throttle. Select one of the supported values from the drop-down list: − Rate − Quota − HWM − Error • Required.
Interval	• Specifies a time period for which the maximum count of throttles are allowed.
Max Limit	• Specifies the maximum number of throttle count allowed during the throttle interval period.
Monitor Counter	• Specifies the type of the counter used to increment the throttle count. • Not Applicable for the Error and High Water Mark throttle types. • The possible values for the monitor counter are as follows: − Request Count − Input Payload Size − Output Payload Size − Transaction Payload Size • The default value is Request Count. Request Count applies to all throttle types, except Payload size throttles. Input Payload Size, Output Payload Size, and Transaction Payload Size are applicable for only Rate and Quota throttle types.
Monitor Time Modifiers	Specifies the date, day, and time ranges for the throttle when the time modifiers are active. See Monitor Time Modifiers.

Create a Throttle Policy Definition

This section explains how to configure a quota monitor T1 with a limit of 5 requests within 24 hours for service throttle metric.

Prerequisites

This example assumes that you have completed Configuring an Endpoint Operation for TIBCO API Exchange Gateway.

Modify the Existing Configuration to Add Throttles

This section explains how to open the existing configuration.

1.	Start the GUI, if not already started. See Starting GUI for details.

2.	Expand the Projects node, click the ASG_Get_Start configuration.

Define a Quota Throttle

Add a new throttle as follows:

1.	Click the MONITORING tab.

2.	Click the Monitors tab.

3.	Click the Add property icon to create a new monitor.

4.	Specify the throttles details, as follows:

Table 89 Quota Throttle Configuration

Parameter	Value
Monitor Name	T1
Monitor Type	Quota
Interval	24
Max Limit	5

Assign a Throttle Policy to the Target Operation

To assign a Quota throttle to the target operation, follow these steps:

1.	Click the ROUTING tab on the upper right.

2.	Click the Target Operations tab on the top menu.

3.	Edit the http.GetBooksByAuthor target operation configuration.

4.	Enter the details defined as follows:

Table 90 Edit Target Operation Configuration

Parameter	Value
Operation Name	http.GetBooksByAuthor
Type	HTTP (select from the drop-down list.)
Monitor(s)	T1 (select from the drop-down list.)

Test the Target Operation

1.	Launch the TIBCO Designer and open the following project: ASG_HOME/examples/BookQuery/BookQuery

2.	Run the following server processes:

−	BooksInterface-service1

3.	Run the following client process:

−	QueryByAuthorClient

4.	Verify that the process runs successfully without any errors.

5.	Send few more requests to the gateway.

6.	Notice that after 5 successful requests, an error appears for the Quota Throttle violation.

Copyright © Cloud Software Group, Inc. All Rights Reserved