15 Configuration

This topic describes the systematic instructions to perform the configuration.

End-user can configure the properties w.r.t. monitoring, alert and export.

End-user can configure the same at System level and granular levels such as Consumer, Consumer Service and Routing.

The Configuration screen contains the following sections.
  • Monitoring - It has the features required by the breaker to store and aggregate the result of calls.
  • Alert - It has the features required for transitioning circuit breaker.
  • Email Alert - It has the feature required for mail notification.
  • Export - It has the properties that are required for exporting the configuration JSON and will be visible at system level only.
Specify User ID and Password, and login to Home screen.
  1. On Home screen, click Core Maintenance. Under Core Maintenance, click Routing Hub.
  2. Under Routing Hub, click Configuration.
    The Configuration screen displays.

    Figure 15-1 Configuration


    Description of Figure 15-1 follows
    Description of "Figure 15-1 Configuration"

  3. On Configuration screen, specify the fields.

    Note:

    The fields marked as Required are mandatory.
    For more information on fields, refer to the field description table.

    Table 15-1 Configuration - Field Description

    Field Description
    Window Type Select the type of the window.
    The available options are:
    • Count: The count-based sliding window aggregates the outcome of the last N calls (Window Size).
    • Time: The time-based sliding window aggregates the outcome of the calls of the last N seconds (Window Size).
    Window Size Specify the window size to record the outcome of the calls when the circuit breaker is closed.
    • For Count window type, The window size is N calls.
    • For Time window type, The window size has N seconds.
    Minimum number of calls Specify the minimum number of calls.

    For example, if the minimum required number of calls is 10, you need to record at least 10 calls before you can determine the failure rate.

    If only nine calls are logged, the circuit breaker will not switch to open, even if all nine calls are unsuccessful.
    Failure rate threshold Specify the failure rate threshold in percentage.

    If the failure rate meets or exceeds the threshold, the breaker opens and begins to short-circuit calls.
    Email Addresses Specify the E-mail address. The user can use semi-colon to add more email addresses.

    Once the failure rate crosses the Failure rate threshold, a mail is sent to the end-user about the event.

    Mark data as factory shipped Select the toggle to mark the exported configuration JSON as factory shipped JSON.

    The end-user will not be able to modify or delete the certain data once imported.

    By default, the toggle is OFF.
    Allow data masking Turn on the toggle to hide sensitive information in request audit messages.
    Regex patterns Specify the regex patterns for identification of sensitive fields.

    Note:

    You can group values by using a sub-pattern that is placed inside parentheses ().
    Example:

    Table 15-2 Configuration - Field Entry Values

    Field Entry Values
    Window Type Count
    Window Size 20
    Minimum number of calls 10
    Failure rate Threshold 50%

    Configured properties will result as below:

    After 10 (minimum number of calls) calls, routing would get shutdown if 50% (failure rate) of almost last 20 (window size) calls have failed. If the email address property is configured, then the end-user is notified as well.

  4. Click Clear to clear all the specified details.
  5. Click Reset to reset the details.
  6. Click Save to save all the details.