From 50c3687e837e1380e7806900849c1df2f491e715 Mon Sep 17 00:00:00 2001
From: Andrew Hauck <ahauck@cloudflare.com>
Date: Fri, 9 Aug 2024 09:12:23 -0700
Subject: [PATCH] Add documentation on HealthObserve trait

---
 .bleep                                     | 2 +-
 pingora-load-balancing/src/health_check.rs | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

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.