- 
                Notifications
    
You must be signed in to change notification settings  - Fork 9.8k
 
[LB] Adds Monitor Groups docs #25820
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
    
      
        
          +148
        
        
          −1
        
        
          
        
      
    
  
  
     Merged
                    Changes from 1 commit
      Commits
    
    
            Show all changes
          
          
            4 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      
    File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
        
          
  
    
      
          
            47 changes: 47 additions & 0 deletions
          
          47 
        
  src/content/docs/load-balancing/monitors/monitor-groups.mdx
  
  
      
      
   
        
      
      
    
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| pcx_content_type: reference | ||
| title: Monitor Groups | ||
| sidebar: | ||
| order: 48 | ||
| 
     | 
||
| --- | ||
| 
     | 
||
| Group multiple health monitors together to create sophisticated health checks for your applications, ensuring more intelligent and resilient traffic steering. | ||
| 
     | 
||
| You can group multiple health monitors to build sophisticated health checks that more accurately reflect your application's true health. A Monitor Group allows you to combine several independent monitors, define aggregation logic, and use the collective result to determine the health of an origin pool. | ||
| 
     | 
||
| This enables more intelligent and resilient failover. For example, you can require that both a general API gateway monitor and a specific /login service monitor must be healthy for a pool to receive traffic. | ||
| 
     | 
||
| ## Availability | ||
| 
     | 
||
| Monitor Groups are only available to customers on an Enterprise plan with the Load Balancing subscription. | ||
| 
     | 
||
| Configuration is available via the [API](/api/resources/load_balancers/subresources/monitor_groups/methods/create/) only. | ||
| 
     | 
||
| ## How it works | ||
| 
     | 
||
| When you attach a Monitor Group to a pool, the health of that pool is determined by aggregating the results of all enabled monitors within the group. | ||
| 
     | 
||
| The sections below explain how monitor groups influence health status, latency, and result handling. | ||
| 
     | 
||
| ## Endpoint health with Monitor Groups | ||
| 
     | 
||
| A Monitor Group determines an endpoint's health using a combination of critical monitor overrides and quorum-based consensus. | ||
| 
     | 
||
| **Critical Monitor Override** (`must_be_healthy`): You can designate a monitor as critical by setting `"must_be_healthy": true`. If a monitor with this setting fails its health check against an endpoint, that specific endpoint is immediately marked as unhealthy. This happens regardless of the status reported by other monitors in the group for that same endpoint. This provides a definitive override for essential services. | ||
| 
     | 
||
| **Quorum-Based Health**: In the absence of a failure from a `must_be_healthy` monitor, an endpoint's health is determined by a quorum of all other active monitors. | ||
| 
     | 
||
| - An endpoint is considered unhealthy only if more than 50% of its assigned monitors report it as unhealthy. | ||
| - Monitors marked as `"monitoring_only": true` are excluded from the quorum calculation. They will still run and can trigger notifications, but they do not vote on the endpoint's health status. | ||
| - Monitors marked as `disabled` will not send monitoring requests to any associated pool. They are also excluded from the quorum calculation. | ||
| 
     | 
||
| This quorum system prevents an endpoint from being prematurely marked as unhealthy due to a transient failure from a single, non-critical monitor. | ||
| 
     | 
||
| ## Latency for Steering | ||
| 
     | 
||
| For pools using Dynamic Steering, the pool's latency is calculated as the average latency of all its enabled, non-monitoring-only monitors. This aggregated RTT (Round Trip Time) value provides a more holistic view of an origin's performance and is used to make steering decisions. | ||
| 
     | 
||
| ## Result handling for different intervals | ||
| 
     | 
||
| If monitors in a group have different check intervals, the group uses the last available result from each monitor until it is refreshed. For example, if one monitor runs every 10 seconds and another every 30 seconds, the 30-second monitor's result is considered valid for the full 30 seconds until its next run completes. | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.