CentraSite Documentation : Runtime Governance with CentraSite : Run-Time Governance Reference : Built-In Run-Time Actions Reference for APIs : Run-Time Actions Reference : Throttling Traffic Optimization
Throttling Traffic Optimization
This action limits the number of API invocations during a specified time interval, and sends alerts to a specified destination when the performance conditions are violated.
Reasons for limiting the API invocation traffic include:
*To avoid overloading the back-end services and their infrastructure.
*To limit specific clients in terms of resource usage (that is, you can use the “Monitor Service Level Agreement” action to monitor performance conditions for a particular client, together with “Throttle API Usage” to limit the resource usage).
*To shield vulnerable servers, services, and even specific operations.
*For API consumption metering (billable pay-per-use APIs).
Note:  
To enable Mediator to publish performance metrics, you must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to Solutions > Mediator > Administration > CentraSite Communication). For the procedure, see Administering webMethods Mediator.
Input Parameters
Soft Limit
Number. Optional. The maximum number of invocations allowed per Interval Value before issuing an alert. Reaching the soft limit will not affect further processing of requests (until the Hard Limit is reached).
Note:  
The limit is reached when the total number of invocations coming from all the clients (specified in the Limit Traffic for Applications field) reaches the limit. Soft Limit is computed in an asynchronous manner; thus when multiple requests are made at the same time, it may be possible that the Soft Limit alert will not be strictly accurate.
Alert Message for Soft Limit
String. Optional. A text message to include in the soft limit alert.
Hard Limit
Required. The maximum number of invocations allowed per Interval Value before stopping the processing of further requests and issuing an alert. Typically, this number should be higher than the soft limit.
Note:  
The limit is reached when the total number of invocations coming from all the clients (specified in the Limit Traffic for Consumers field) reaches the limit. Hard Limit is computed in an asynchronous manner; thus when multiple requests are made at the same time, it may be possible that the Hard Limit alert will not be strictly accurate.
Alert Message for Hard Limit
String. Optional. A text message to include in the hard limit alert.
Alert for Consumer Applications
String. The consumer application(s) that this action applies to. To specify multiple consumers, use the plus button to add rows, or select Any Consumer to apply this action to any consumer application.
Alert Interval
String. The amount and unit (Minutes, Hours, Days or Weeks) of time for the soft limit and hard limit to be reached.
Alert Frequency
String. Frequency to issue alerts.
Value
Description
Every Time
Default. Issues an alert every time the specified condition is violated.
Only Once
Issues an alert only the first time the specified condition is violated.
Alert Destination
String. Optional. A place to log the alerts.
Important:  
Ensure that Mediator is configured to send event notifications to the destination(s) you specify here. For details about alerts and transaction logging, see Administering webMethods Mediator.
Value
Description
CentraSite
Sends the alerts to the API's Events profile in CentraSite.
Prerequisite: You must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to Solutions > Mediator > Administration > CentraSite Communication). For information about how to configure communication with CentraSite, see Administering webMethods Mediator.
Local Log
Sends the alerts to the server log of the Integration Server on which Mediator is running.
Also choose a value in the Log Level field:
*Info: Logs error-level, warning-level, and informational-level alerts.
*Warn: Logs error-level and warning-level alerts.
*Error: Logs only error-level alerts.
Important:  
The Integration Server Administrator's logging level for Mediator should match the logging level specified for this action (go to Settings > Logging > Server Logger).
SNMP
Sends the alerts to CentraSite's SNMP server or a third-party SNMP server.
Prerequisite: You must configure the SNMP server destination (in the Integration Server Administrator, go to Solutions > Mediator > Administration > Email). For the procedure, see Administering webMethods Mediator.
Email
Sends the alerts to an SMTP email server, which sends them to the email address(es) you specify here. To specify multiple addresses, use the plus button to add rows.
Prerequisite: You must configure the SMTP server destination (in the Integration Server Administrator, go to Solutions > Mediator > Administration > Email). For the procedure, see Administering webMethods Mediator.
EDA
Mediator can use EDA to log the payloads to a database.
Prerequisite: You must configure the EDA destination (in the Integration Server Administrator, go to Solutions > Mediator > Administration > EDA). For the procedure, see Administering webMethods Mediator.
Copyright © 2005-2015 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback