DMSCHealthChecker

Struct DMSCHealthChecker 

Source
pub struct DMSCHealthChecker { /* private fields */ }
Expand description

Main health checker service.

This struct provides the core functionality for managing health checks, including registering health checks, starting background monitoring, and retrieving health status.

Implementations§

Source§

impl DMSCHealthChecker

Source

pub fn new(check_interval: Duration) -> Self

Source

pub fn with_tracer(self, tracer: Arc<DMSCTracer>) -> Self

Source

pub fn set_tracer(&mut self, tracer: Arc<DMSCTracer>)

Source

pub async fn register_health_check( &self, service_name: &str, endpoint: &str, check_type: DMSCHealthCheckType, config: DMSCHealthCheckConfig, ) -> DMSCResult<()>

Registers a health check for a service.

This method registers a health check for a service and performs an immediate check.

§Parameters
  • service_name: Name of the service to check
  • endpoint: Endpoint URL for health checks
  • check_type: Type of health check to perform
  • config: Health check configuration
§Returns

A DMSCResult<()> indicating success or failure

Source

pub async fn start_health_check( &self, service_name: &str, endpoint: &str, ) -> DMSCResult<()>

Starts background health checks for a service.

This method creates a background task that periodically checks the health of a service.

§Parameters
  • service_name: Name of the service to check
  • endpoint: Endpoint URL for health checks
§Returns

A DMSCResult<()> indicating success or failure

Source

pub async fn stop_health_check( &self, service_name: &str, _endpoint: &str, ) -> DMSCResult<()>

Stops health checks for a specific service endpoint.

This method clears the health check results for the specified service. The background task will continue running but will no longer record results.

§Parameters
  • service_name: Name of the service
  • endpoint: Endpoint URL
§Returns

A DMSCResult<()> indicating success or failure

Source

pub async fn start_health_check_with_type( &self, service_name: &str, endpoint: &str, check_type: DMSCHealthCheckType, ) -> DMSCResult<()>

Starts background health checks for a service with a specific health check type.

This method creates a background task that periodically checks the health of a service using the specified health check type.

§Parameters
  • service_name: Name of the service to check
  • endpoint: Endpoint URL for health checks
  • check_type: Type of health check to perform
§Returns

A DMSCResult<()> indicating success or failure

Source

pub async fn get_health_status( &self, service_name: &str, ) -> DMSCResult<Vec<DMSCHealthCheckResult>>

Gets the health check results for a service.

§Parameters
  • service_name: Name of the service to get results for
§Returns

A DMSCResult<Vec<DMSCHealthCheckResult>> containing the health check results

Source

pub async fn get_latest_health_status( &self, service_name: &str, ) -> DMSCResult<Option<DMSCHealthCheckResult>>

Gets the latest health check result for a service.

§Parameters
  • service_name: Name of the service to get the latest result for
§Returns

A DMSCResult<Option<DMSCHealthCheckResult>> containing the latest health check result if available

Source

pub async fn get_health_status_within( &self, service_name: &str, time_window: Duration, ) -> DMSCResult<Vec<DMSCHealthCheckResult>>

Gets the health check results for a service within a specified time window.

§Parameters
  • service_name: Name of the service to get results for
  • time_window: Time window to filter results by
§Returns

A DMSCResult<Vec<DMSCHealthCheckResult>> containing the filtered health check results

Source

pub async fn get_service_health_summary( &self, service_name: &str, ) -> DMSCResult<DMSCHealthSummary>

Gets a health summary for a service.

This method aggregates health check results to provide a summary of the service’s health, including success rate, average response time, and overall status.

§Parameters
  • service_name: Name of the service to get a summary for
§Returns

A DMSCResult<DMSCHealthSummary> containing the health summary

Source

pub async fn start_background_tasks(&self) -> DMSCResult<()>

Starts background health check tasks.

This method initializes and starts all background health monitoring tasks, including periodic health checks for registered services and cleanup tasks.

§Returns

A DMSCResult<()> indicating success or failure

Source

pub async fn stop_background_tasks(&self) -> DMSCResult<()>

Stops all background health check tasks.

This method aborts all running background health check tasks and cleans up resources.

§Returns

A DMSCResult<()> indicating success or failure

Source

pub async fn health_check(&self) -> DMSCResult<bool>

Performs a health check on the health checker itself.

§Returns

A DMSCResult<bool> indicating whether the health checker is healthy

Trait Implementations§

Source§

impl<'py> IntoPyObject<'py> for DMSCHealthChecker

Source§

type Target = DMSCHealthChecker

The Python output type
Source§

type Output = Bound<'py, <DMSCHealthChecker as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for DMSCHealthChecker

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for DMSCHealthChecker

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = c"Main health checker service.\n\nThis struct provides the core functionality for managing health checks, including\nregistering health checks, starting background monitoring, and retrieving health status.\x00"

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<DMSCHealthChecker>

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for DMSCHealthChecker

Source§

const TEXT_SIGNATURE: &'static str = "(check_interval)"

Source§

impl PyMethods<DMSCHealthChecker> for PyClassImplCollector<DMSCHealthChecker>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for DMSCHealthChecker

Source§

const NAME: &'static str = "DMSCHealthChecker"

Class name.
Source§

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
Source§

impl DerefToPyAny for DMSCHealthChecker

Source§

impl ExtractPyClassWithClone for DMSCHealthChecker

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Ungil for T
where T: Send,