pub struct SystemHealth { /* private fields */ }Expand description
Current Health Status If use_endpoint_health_status is set then initialize the endpoint_health hashmap to the starting health status
Implementations§
Source§impl SystemHealth
impl SystemHealth
pub fn new( starting_health_status: HealthStatus, use_endpoint_health_status: Vec<String>, health_path: String, live_path: String, ) -> Self
pub fn set_health_status(&mut self, status: HealthStatus)
pub fn set_endpoint_health_status(&self, endpoint: &str, status: HealthStatus)
Sourcepub fn get_health_status(&self) -> (bool, HashMap<String, String>)
pub fn get_health_status(&self) -> (bool, HashMap<String, String>)
Returns the overall health status and endpoint health statuses System health is determined by ALL endpoints that have registered health checks
Sourcepub fn register_health_check_target(
&self,
endpoint_subject: &str,
instance: Instance,
payload: Value,
)
pub fn register_health_check_target( &self, endpoint_subject: &str, instance: Instance, payload: Value, )
Register a health check target for an endpoint
Sourcepub fn get_health_check_targets(&self) -> Vec<(String, HealthCheckTarget)>
pub fn get_health_check_targets(&self) -> Vec<(String, HealthCheckTarget)>
Get all health check targets
Sourcepub fn has_health_check_targets(&self) -> bool
pub fn has_health_check_targets(&self) -> bool
Check if any health check targets are registered
Sourcepub fn get_health_check_endpoints(&self) -> Vec<String>
pub fn get_health_check_endpoints(&self) -> Vec<String>
Get list of endpoints with health check targets
Sourcepub fn get_health_check_target(
&self,
endpoint: &str,
) -> Option<HealthCheckTarget>
pub fn get_health_check_target( &self, endpoint: &str, ) -> Option<HealthCheckTarget>
Get health check target for a specific endpoint
Sourcepub fn get_endpoint_health_status(&self, endpoint: &str) -> Option<HealthStatus>
pub fn get_endpoint_health_status(&self, endpoint: &str) -> Option<HealthStatus>
Get the endpoint health status (Ready/NotReady)
Sourcepub fn get_endpoint_health_check_notifier(
&self,
endpoint_subject: &str,
) -> Option<Arc<Notify>>
pub fn get_endpoint_health_check_notifier( &self, endpoint_subject: &str, ) -> Option<Arc<Notify>>
Get the endpoint-specific health check notifier
Sourcepub fn take_new_endpoint_receiver(&self) -> Option<UnboundedReceiver<String>>
pub fn take_new_endpoint_receiver(&self) -> Option<UnboundedReceiver<String>>
Take the receiver for new endpoint registrations (can only be called once) This is used by HealthCheckManager to receive notifications of new endpoints
Sourcepub fn initialize_uptime_gauge<T: MetricsHierarchy>(
&self,
registry: &T,
) -> Result<()>
pub fn initialize_uptime_gauge<T: MetricsHierarchy>( &self, registry: &T, ) -> Result<()>
Initialize the uptime gauge using the provided metrics registry
Sourcepub fn update_uptime_gauge(&self)
pub fn update_uptime_gauge(&self)
Update the uptime gauge with the current uptime value
Sourcepub fn health_path(&self) -> &str
pub fn health_path(&self) -> &str
Get the health check path
Trait Implementations§
Source§impl Clone for SystemHealth
impl Clone for SystemHealth
Source§fn clone(&self) -> SystemHealth
fn clone(&self) -> SystemHealth
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl !Freeze for SystemHealth
impl !RefUnwindSafe for SystemHealth
impl Send for SystemHealth
impl Sync for SystemHealth
impl Unpin for SystemHealth
impl !UnwindSafe for SystemHealth
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);