Add documentation on HealthObserve trait

cloudflare · Aug 9, 2024 · 50c3687 · 50c3687
1 parent 8a0c73f
commit 50c3687
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/.bleep b/.bleep
@@ -1 +1 @@
-36269b8823b23381398508138bbab33c03ba7681
+f123f5e43e9ada31a0e541b917ea674527fd06a3
diff --git 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.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		36269b8823b23381398508138bbab33c03ba7681
		f123f5e43e9ada31a0e541b917ea674527fd06a3