Avi GSLB Service Health Monitors

The operation and configuration of data- and control-plane global application health monitors are covered in this article.

Prerequisite Reading


As mentioned in the Avi GSLB Architecture and Object Model article, a GSLB service is the representation of a global application deployed at multiple sites. The corresponding GslbService configuration object defines the FQDN of the application, the backing virtual services in various sites, and the priority/ratios governing selection of a particular virtual-service at any given time. This object also defines the health-monitoring methods by which unhealthy components can be identified so that best alternatives may be selected.

GSLB Service Health Monitoring

There are two general categories of GSLB service health monitoring: control-plane and data-plane. One or both can be applied on a per-application basis.

GSLB Member Healthchecks

Control-Plane-Based Global Application Health Monitoring

Independent of Avi GSLB, every Avi Controller cluster routinely performs local health checks to collect the health scores and performance metrics of virtual services under its direct control. In addition, if GslbService.controller_health_status_enabled is True, active GSLB sites will also periodically query the Avi Controllers at all the other sites specified within the GSLB site configuration (both active and passive). From them they will fetch locally-collected health and load information. This very efficient data collection method gives insight into all Avi Vantage virtual services that participate in a global application.

Note: Control-plane health monitoring does not apply to third-party load balancer VIPs or standalone servers because — by definition — there is no Avi Controller to query in those cases.

To avoid cluttering the below figure with too many arrows, only the active Controller in DC1 is shown collecting health information from 3 other Controllers (dashed arrows). DC1’s Controller passes a coalesced picture of health status to its local DNS (solid arrow). In reality, the active Controllers in DC2 and AWS would behave in like fashion, updating their respective local DNS virtual services with control-plane-based health status.

Control plane healthcheck

Data-Plane-Based Global Application Health Monitoring

In contrast to control-plane-based health monitoring, no site’s Controller cluster is queried. Instead, health checks go directly to participating services, i.e., to the data plane. At an active site, an SE hosting a GSLB DNS VS can perform a variety of periodic health checks against all GSLB pool members (including the virtual services local to it). Starting with release 17.1.2, an SE can be dedicated to performing these health checks. Active monitors generate synthetic traffic from the DNS Service Engine to mark a virtual service (pool member) up or down, based on its response. The below diagram shows the DNS in DC1 (the only active site) performing this function against its local virtual service (VS-A1), as well as VS-A2, VS-A3 and VS-A4.

As previously mentioned, the object used for this is called the GslbHealthMonitor. Ping, TCP, UDP, DNS, and HTTP(S) health monitors are supported (as pictured in the Configuring Health Monitoring section below. Additionally, one can write and incorporate one’s own monitor.

Please read the Health Monitoring KB for more information.

Data plane healthcheck

Localized Data-Plane-Based Global Application Health Monitoring

To explain localized data-plane health checking, let’s first embellish the single-DNS configuration depicted above. In the below figure, DC3 is transformed into an active site via deployment of an Avi DNS SE. This nominally adds four additional data-plane health checks, from DC3’s Avi DNS SE to each of the four member virtual services.

Data plane healthcheck

Now let’s focus attention on the DC1 DNS check of VS-A4 as well as the DC3 DNS check of VS-A1. Suppose we wish or need to avoid these checks for one or both of the following reasons:

  • The firewalls protecting DC1 and DC3 have been configured to permit the Avi Controllers to communicate, but they block direct access to VS-A4 (from DC1) and to VS-A1 (from DC3).
  • We want to scale the performance of each Avi DNS SE by minimizing the number of health checks each must perform. Since each member VS is already being data-plane checked by a local DNS, we consider it wasteful for remote DNSes to replicate those checks.

We can achieve the optimization depicted in the below figure by optioning VS-A1 and VS-A4 for localized data-plane heath checks. Two data-plane health checks are eliminated. Instead, each DNS SE gets the health informmation it needs by querying the remote site’s Avi Controller.

localized data-plane health check

This hybrid approach, which combines control- and data-plane health checking, is enabled for a global service on an individual member VS basis. The only restriction is that the member VS runs on an active Avi site.

Interaction with the GSLB DNS

When health monitoring determines a GSLB service pool member (i.e., some participating VS) is down, one of four standard responses are returned by the GSLB DNS. In the GslbService object, set the GslbService.down_response parameter to select one of these four:

  • GSLB_SERVICE_DOWN_RESPONSE_NONE, the default option, simply drops the request.
  • GSLB_SERVICE_DOWN_RESPONSE_FALLBACK_IP respond with a single preset fallback IP address, which typically would point to a server that’s serving a “sorry” page.
  • GSLB_SERVICE_DOWN_RESPONSE_ALL_RECORDS returns all IP addresses of all members of all pools
  • GSLB_SERVICE_DOWN_RESPONSE_EMPTY returns an empty DNS response, and can be used to make the client retry in certain cases.

Options and Combinations for GSLB Service Health Monitoring

  • Control-plane health checking only: If this is desired, define no active data-plane health monitors. Have all active Controllers coalesce the health stats they collect locally with stats from remote Controllers responsible for their local GSLB pool members. Coalesced stats are then passed from each active Controller (cluster) to its local DNS. This health-checking technique is only available for members implemented as Avi Vantage virtual services.
  • Data-plane health checking only: Set GslbService.controller_health_status_enabled to False. Have each GSLB DNS perform health checks on all GSLB member virtual services (including those hosted on external sites).
  • Both control- and data-plane health checking: Turn both options on. For a member VS to be marked UP, both control and data health should report UP. If the control-plane health check is failing due to a remote Controller being down/inaccessible, but data-plane health checking is still possible, then it alone will determine whether a GS member VS is marked UP or DOWN.

Health Checking Optimizations

Set data-plane health monitor scope appropriately

GslbService.health_monitor_scope is an optional parameter that takes on one of two states. By default it is set to GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, in which case DNS SEs actively probe pool members at both Avi and external sites. However, the parameter can be set to GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS, such that external member status is collected the only way possible, while the work of Avi member health checking is offloaded from DNS SEs to Avi Controllers local to the GSLB pool members.

Limit the number of active sites

When a large fraction of GSLB sites are configured to be active, the burden on Controllers and the networks interconnecting them can be excessive. For example, consider two deployments, each with 10 Avi sites. One has 5 active Controllers, the other just 2. Each regularly scheduled remote-site health check from an active Controller collects health status from 9 remote sites. Compare the throughput consumed when 5 Controllers probe 9 sites each, versus when just 2 Controllers probe 9 sites. That’s 45 remote-site collections per unit of time compared to just 18. The latter is considerably more throughput-efficient, while still delivering reasonable GSLB DNS redundancy for HA.

Configuring Health Monitoring

The below specifications apply to the GUI examples shown in this section.

  • The customer has multiple data centers.
  • Two global applications spanning both are going to be deployed. Each will require health monitors to be configured.
  • view.sales.avi.local will run in US-West and rely on US-Central as a disaster recovery site.
  • pay.sales.avi.local will run at US-West as well as US-East to achieve both high availability and optimal user experience.

**1. Configure a data-plane health monitor for both GSLB services. **Recall that this operation can only be performed by an authorized user logged into the GSLB leader Controller.

The Templates -> Profiles -> Global Health Monitor tab shows the five pre-existing system-standard monitors:

system-standard GSLB health monitors
When not satisfied with the default values for a monitor’s parameters, one can change them. However, in the case of a system-standard monitor, the better practice is to define a brand new monitor by clicking Create. The defaults that apply will be populated into the editor window, and can then be modified as desired. Refer to the New GSLB Health Monitor editor window below.

The monitor name is arbitrary; the letters “tcp” merely help us recognize it for what it is. The Type parameter is what counts. Note the other values we’ve specified for some of the parameters. Parameters above the solid line are common to all monitor types.


  • Successful Checks: The number of consecutive successful health checks before a virtual service is marked UP
  • Failed Checks: The number of consecutive failed health checks before a virtual service is marked DOWN
  • Send Interval: The number of seconds between health checks to a given virtual service
  • Receive Timeout: A valid response from the server is expected within this number of seconds. It must be less than the send interval. If server status is regularly flapping between UP and DOWN, consider increasing this value.
  • Health Monitor Port: Regardless of what port underpinning virtual services use, this monitor will direct its health checks to port 80. A monitor port is mandatory for HTTP(S), TCP, UDP and external health monitors.

Clicking Save in the new GSLB Health Monitor editor completes the custom-monitor creation.

**2. Configure the GSLB services. **This operation can only be performed on the GSLB leader Controller. The New GSLB Service wizard speeds the definition of either active/active or active-standby configurations, as first introduced in the Avi GSLB Overview article. Both are illustrated below.

  • Active/standby GSLB service for view.avi.com**By astutely picking GslbPool.priority values, one for each of our pools, it is possible to fashion an active/standby configuration. A pool with priority 12 will handle all traffic unless and until it fails, at which time a standby pool with priority 5 will automatically take over.

  • Navigate to Applications -> GSLB Service, click Create and choose the Basic Setup option.
  • Naming the new GSLB service "view- a-s" reminds administrators that this is an active/standby GSLB service. The Application Name field, which is set to "view," is more important for application users. Since this is to be a TCP service, and data-plane health checking is desired, an appropriate active health monitor to choose is our-gslb-tcp-monitor," the health monitor created in step 1. The default value for Health Monitor Scope (All Members) is left alone for two reasons: (1) No external virtual services are planned, so "Only Non Avi Members" becomes irrelevant. (2) Un-clicking "All Members" would mean we set up a customer monitor for no reason. We might consider un-checking Controller Health Status option and rely only on the active monitor just enabled. From a health monitoring point of view, these fields are the most important ones in the scenario. Other fields, though likewise important, have nothing to do with health monitoring.In the Pool Member section, "Virtual Service" (the default) is appropriate, since in this example external virtual services (for which an IP address would be appropriate) are not desired.Of the various site clusters in the pulldown, "US-West" is picked. The Virtual Service pulldown reveals all existing Avi virtual services running under that Controller cluster. VS-Site-US-West is selected.The Priority field has no default value. Setting it to 12 will make this the active site simply because a lower value (5) is planned for the standby site's pool.Clicking Save completes this step.
    Screen Shot 2016-12-30 at 5.23.36 PM
  • From Avi Vantage's point of view, the global service is ready to accept client requests, even though the standby half of it has yet to be created. This is reflected by the Enable State and Status values in the application list that appears, as shown below:Screen Shot 2016-12-30 at 5.45.40 PM
    Clicking the pencil icon in the rightmost column of the application's row shows the progress made so far (see below). Notice the default choices Avi Vantage has automatically made for the pool Name and its Algorithm (round robin, as opposed to consistent hash).Screen Shot 2016-12-30 at 5.49.58 PM
  • Clicking Add Pool in the GSLB service editor enables addition of the standby pool. Continuing with Avi Vantage's pool-naming convention, "view a-s-pool-2" is chosen, with a priority of 5, and the default for the LB algorithm. Although "US-West" is once again offered in the Site Cluster Controller pulldown, "US-Central" makes more sense. At US-Central, "VS-Site-US-Central" is the chosen virtual service. The default Ratio (1) is a "don't care" value because no additional virtual services are planned for this pool. It would matter were Add GSLB Pool Member clicked and a second virtual service identified. Clicking Done ends this step.Screen Shot 2016-12-30 at 6.08.11 PM
  • The GSLB service editor screen that appears (see below) reveals the progress made so far. Notice that no GSLB-service-specific values for Number of IPs returned by DNS server or TTL served by DNS Service have been specified. The DNS service's values for these will therefore apply.Screen Shot 2016-12-30 at 6.10.20 PM
    Clicking Save completes this step. Our two-pool active/standby GSLB service has been created.
  • </ol>

    • **Active/active GSLB service for pay.avi.com** <ol>
  • Navigate to Applications -> GSLB Service, click Create and choose the Basic Setup option.
  • Name the new GSLB service "pay a-a," set Application Name to "pay," choose "our-gslb-tcp-monitor" from the Health Monitor pulldown, accept the default for Select Group Type, choose "US-West" for the first of the two sites, and "VS-Site-US-West" for the Virtual Service parameter. Click Save to complete this step.

    Screen Shot 2016-12-30 at 6.55.58 PM
  • The Applications list will initially show a red-circle-exclamation-point status, but after some seconds, if all is well, it will turn solid green, indicating "pay a-a" is enabled and healthy.Screen Shot 2016-12-30 at 7.25.03 PM
  • Clicking on the pencil icon for "pay a-a" continues the process by returning us to the GSLB service editor:Screen Shot 2016-12-30 at 7.46.49 PM
  • At this point, we don't need a second pool. Instead we need to add more virtual services to the existing pool. ["Active/active" pertains to the virtual services within the pool.] Clicking the pencil icon in the Gslb Pool section of the above screen yields the below, so that we can add a second pool member, i.e., a second virtual service.

    Screen Shot 2016-12-30 at 7.50.56 PM
  • Clicking Add GSLB Pool Member above opens up a second set of pool-member fields. The below shows them completed. The Site Cluster Controller is "US-East" and the desired virtual service is "VS-Site-US-East." Leaving the Ratio values at 1 suggests that neither virtual service will be weighted over the other.Screen Shot 2016-12-30 at 7.54.50 PM
  • Click Done above returns us to the GSLB service editor (as shown below). Clicking Save completes the process.Screen Shot 2016-12-30 at 7.56.50 PM
    Note that an "active/active" GSLB service nominally requires only one pool. A single-pool configuration will show a value in the Priority field, but it is inconsequential. Virtual service selection within the single pool is instead a function of algorithm (round robin in this case), tempered by the ratios, if unequal.
  • </ol>

    Adding a Standby Site to an Active/Active GSLB Service

    Standby functionality can be added to the active/active “pay” application by adding a second pool with a lower priority. The below Gslb Pools section of the GSLB service editor shows a configuration that implements such an upgrade.

    • The initial active pool = pay a-a-pool
    • The added standby pool = pay a-a-pool-2

    As long as either VS-Site-US-West or VS-Site-US-East is up and not at maximum capacity, its higher priority steers all traffic toward “pay a-a-pool.” Otherwise, Avi Vantage puts “pay a-a-pool-2” to work.

    Screen Shot 2016-12-30 at 8.12.19 PM

    CLI Configuration

    1. Configure health monitor for GSLB services

    Only on the leader (

    : > configure gslbhealthmonitor global-http-hm
    : gslbhealthmonitor> type health_monitor_http
    : gslbhealthmonitor> monitor_port 80
    : gslbhealthmonitor> save


    2. Configure routes to make sure that DNS Service has reachability to local virtual services

    The DNS Service Engine monitors the health of the GSLB service members. Add static routes (or default gateway) to make sure that the members are reachable. (See KB article for more details).

    For example, on the leader:

    : > configure vrfcontext global
    Updating an existing object. Currently, the object is:
    | Field          | Value                                           |
    | uuid           | vrfcontext-fde3b826-b19c-449c-8dec-ddeb119f2498 |
    | name           | global                                          |
    | system_default | True                                            |
    | tenant_ref     | admin                                           |
    | cloud_ref      | Default-Cloud                                   |
    : vrfcontext> static_routes
    : vrfcontext:static_routes> prefix next_hop
    : vrfcontext:static_routes> save
    : vrfcontext> save
    | Field            | Value                                           |
    | uuid             | vrfcontext-fde3b826-b19c-449c-8dec-ddeb119f2498 |
    | name             | global                                          |
    | static_routes[1] |                                                 |
    |   prefix         |                                      |
    |   next_hop       |                                      |
    |   route_id       | 1                                               |
    | system_default   | True                                            |
    | tenant_ref       | admin                                           |
    | cloud_ref        | Default-Cloud                                   |
    : >

    On a follower (

    3. Configure GSLB Services

    : > configure gslbservice view
    : gslbservice> domain_names view.avi.com
    : gslbservice> health_monitor_refs global-http-hm
    : gslbservice> num_dns_ip 1
    : gslbservice> groups
    New object being created
    : gslbservice:groups> algorithm gslb_algorithm_round_robin
    : gslbservice:groups> name active-sc
    : gslbservice:groups> priority 10
    : gslbservice:groups> members
    New object being created
    : gslbservice:groups:members> ip
    : gslbservice:groups:members> save
    : gslbservice:groups> save
    : gslbservice> groups
    : gslbservice:groups:members> ip
    : gslbservice:groups:members> save
    : gslbservice:groups> save
    : gslbservice> save
    | Field                            | Value                                              |
    | uuid                             | gslbservice-3f359566-f534-47d9-a735-10105fa53bfb |
    | name                             | view                                               |
    | domain_names[1]                  | view.avi.com                                       |
    | groups[1]                        |                                                    |
    |   name                           | active-sc                                          |
    |   priority                       | 10                                                 |
    |   algorithm                      | GSLB_ALGORITHM_ROUND_ROBIN                         |
    |   members[1]                     |                                                    |
    |     ip                           |                                       |
    |     ratio                        | 1                                                  |
    |     enabled                      | True                                               |
    | groups[2]                        |                                                    |
    |   name                           | standby-boston                                     |
    |   priority                       | 7                                                  |
    |   algorithm                      | GSLB_ALGORITHM_ROUND_ROBIN                         |
    |   members[1]                     |                                                    |
    |     ip                           |                                     |
    |     ratio                        | 1                                                  |
    |     enabled                      | True                                               |
    | num_dns_ip                       | 1 count                                            |
    | health_monitor_refs[1]           | global-http-hm                                     |
    | site_persistence_type            | SITE_PERSISTENCE_NONE                              |
    | site_persistence_profile_timeout | 5 mins                                             |
    | tenant_ref                       | admin                                              |

    4. Configure pass-through server

    In case there’s an FQDN miss on a DNS virtual service, Avi can pass this request through (load-balancer) to one or more backup DNS servers. To enable this, configure a pool containing these servers, and attach this to the DNS virtual service.

    If a domain filter is configured in the application filter of the VS, then the pass-through is performed only for FQDNs that fall within this subdomain. All other queries are dropped.

    Unsupported queries are also forwarded to the pass-through server.

    5. Configure corporate/external DNS server to delegate sub-domain to the Avi DNS Service.

    Delegate avi.com to the Avi GSLB

    To try this out in the lab, dnsmasq was installed on the clients, and the following entries added:

    On client 1:



    dig pay.avi.com ..

    On client 2:



    6. Troubleshooting

    : > show virtualservice colo-dns dnstable
    Sub Domains Serviced:
    | FQDN           | TTL | Num-IPS | IP Addresses                                                | Service | Tenant |
    | cloud7.avi.com | 60  | 1       | de:, de:, be:, uk: | gs-4    | admin  |
    | cloud8.avi.com | 60  | 1       | de:, de:, be:, uk: | gs-4    | admin  |
    : > show virtualservice colo-dns gslbserviceruntime filter gs_uuid gslbservice-c3a4785b-a722-476b-906a-6869ed7e2cae
    : > show virtualservice colo-dns gslbserviceinternal filter gs_uuid gslbservice-c3a4785b-a722-476b-906a-6869ed7e2cae
    : > show virtualservice colo-dns gslbservicehmonstat filter gs_uuid gslbservice-c3a4785b-a722-476b-906a-6869ed7e2cae

    Connection logs provide information about the FQDN and the response IP addresses provided in the DNS query response.

    Updated: 2017-09-20 06:30:58 +0000