Move explanation of TrinoStatus to its own section in routing-rules page

trinodb · Oct 8, 2024 · 1bb4748 · 1bb4748
1 parent 6ee7566
commit 1bb4748
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/routing-rules.md b/docs/routing-rules.md
@@ -134,6 +134,21 @@ condition: 'request.getHeader("X-Trino-Client-Tags") contains "label=foo"'
 
 If no rules match, then request is routed to adhoc.
 
+### TrinoStatus
+
+This class attempts to track the current state of Trino cluster. It is updated per every healthcheck.
+There are three possible states
+
+- PENDING
+    - A Trino cluster will show this state when it is still starting up. It will be treated as
+      unhealthy by RoutingManager, and therefore requests will not be routed to PENDING clusters
+- HEALTHY
+    - A Trino cluster will show this state when healthchecks report clusters as healthy and ready.
+      RoutingManager will only route requests to healthy clusters
+- UNHEALTHY
+    - A Trino cluster will show this state when healthchecks report clusters as unhealthy. RoutingManager
+      will not route requests to unhealthy clusters.
+
 ### TrinoRequestUser
 
 This class attempts to extract the user from a request. In order, it attempts