aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAndrew Hauck <[email protected]>2024-08-09 09:12:23 -0700
committerAndrew Hauck <[email protected]>2024-08-09 14:30:49 -0700
commit50c3687e837e1380e7806900849c1df2f491e715 (patch)
treed45d30fdb1ccb7ddd1ba2bf744c9e249e0b5ef43
parent8a0c73f174a27a87c54426a748c4818b10de9425 (diff)
downloadpingora-50c3687e837e1380e7806900849c1df2f491e715.tar.gz
pingora-50c3687e837e1380e7806900849c1df2f491e715.zip
Add documentation on HealthObserve trait
-rw-r--r--.bleep2
-rw-r--r--pingora-load-balancing/src/health_check.rs2
2 files changed, 3 insertions, 1 deletions
diff --git a/.bleep b/.bleep
index 4cef6a0..9c45175 100644
--- a/.bleep
+++ b/.bleep
@@ -1 +1 @@
-36269b8823b23381398508138bbab33c03ba7681 \ No newline at end of file
+f123f5e43e9ada31a0e541b917ea674527fd06a3 \ No newline at end of file
diff --git a/pingora-load-balancing/src/health_check.rs b/pingora-load-balancing/src/health_check.rs
index b02776d..ac63579 100644
--- a/pingora-load-balancing/src/health_check.rs
+++ b/pingora-load-balancing/src/health_check.rs
@@ -24,6 +24,8 @@ use pingora_http::{RequestHeader, ResponseHeader};
use std::sync::Arc;
use std::time::Duration;
+/// [HealthObserve] is an interface for observing health changes of backends,
+/// this is what's used for our health observation callback.
#[async_trait]
pub trait HealthObserve {
/// Observes the health of a [Backend], can be used for monitoring purposes.