Monitors

The Monitors tab enables you to define different types of throttles with different throttle metrics.

Procedure

  1. Click the Monitors tab.
  2. Click the Add property icon to create a new monitor.
  3. Enter the parameters for monitors, as follows:

    Monitors Configuration Parameters

    Parameter Description
    Throttle Parameters
    Monitor Name The logical name for the monitor. This is the value used in the configuration to identify the monitor.
    Monitor Type The type of monitor. The possible values for monitors are as follows: 
    • Rate
Quota
High Water Mark
Error
    Interval The time interval during which the monitor is applied. It has different time units depending on the monitor type.

    For example,

    • Rate and Error throttle types specify the interval in seconds.
    • Quota throttle type specify the interval in hours.
    • High Water Mark throttle type does not have any time interval.
    Max Limit The number of requests allowed during the interval. This number should be a positive integer greater than zero.
    Monitor Time Modifiers Specifies the time modifiers to apply to the monitor. Multiple time modifiers are allowed.

    This has the following parameters:

    • Max Count - Monitor limit to apply if the time modifier is active (in range).
    • Start Date - Specifies the start date when the time modifier can be applied. The format is yyyyMMdd. It can be combined with the end date to specify a date range. Optional.
    • End Date - Specifies the end date when the time modifier can be applied. The format is yyyyMMdd. Optional.
    • Day of Week - Specifies a list of the days of the week when the time modifier can be applied. The order of the days is not important. Optional.
    • Time Range - Specifies a list of time ranges when the modifier can be applied. The format is hh:mm:ss-hh:mm:ss. Multiple time ranges can be specified. Optional.
    Monitor Count
    • Specifies the type of the counter used to increment the count of the used monitor. The possible values are: 
      • Request Count
Input Payload Size
Output Payload Size
Transaction Payload Size
    • The Monitor count is not applicable for Error and High Water Mark monitor types.

    See Throttle Counter.

    Use Approximate Monitor Indicates if the maximum number of requests as specified by the Max Limit property is distributed by the number of running engine instances.

    If this value is set to true, the maximum number of requests is distributed by the number of active engines.

    If the value is set to false, the maximum number of requests is shared by the number of engines. You must set the Max Count Ratio parameter if the value of Use Approximate Monitor is set to false.
    Max Count Ratio

    An integer value indicating the percentage of maximum number of requests allowed by instance of an engine locally.