Type Members

1.  class BaseDelegatingMutableHealthComponent[Id, H <: BaseHealthComponent] extends BaseHealthComponent with NamedLogging with FlagCloseable

   Mutable Health component, use when the multiple health components identified by Id are not instantiated at bootstrap time and/or change during the lifetime of the node.

   Mutable Health component, use when the multiple health components identified by Id are not instantiated at bootstrap time and/or change during the lifetime of the node. Also supports aggregation of the health of multiple components into a single health state.

   This class does not enforce a specific ComponentHealth type to defer to. For convenience DelegatingMutableHealthComponent can be used when dealing with HealthComponents

2.  trait BaseHealthComponent extends HealthElement

   Abstracts common behavior of a component that reports health The State is left abstract.

   Abstracts common behavior of a component that reports health The State is left abstract. For a generic component state, use ComponentHealth

3.  class BaseMutableHealthComponent[H <: BaseHealthComponent] extends BaseHealthComponent with NamedLogging with FlagCloseable

   Mutable Health component, use when the health component is not instantiated at bootstrap time and/or changes during the lifetime of the node.

   Mutable Health component, use when the health component is not instantiated at bootstrap time and/or changes during the lifetime of the node. This class does not enforce a specific ComponentHealth type to defer to. For convenience DeferredHealthComponent can be used when dealing with HealthComponents

4.  final case class ComponentStatus(name: String, state: ComponentHealthState) extends PrettyPrinting with Product with Serializable

   Simple representation of the health state of a component, easily (de)serializable (from)to protobuf or JSON

5.  final class DelegatingMutableHealthComponent[Id] extends BaseDelegatingMutableHealthComponent[Id, HealthComponent] with HealthComponent
6.  trait HealthComponent extends BaseHealthComponent

   Implements health component Base using ComponentHealthState as a state.

   Implements health component Base using ComponentHealthState as a state. Suitable for most components unless there is a need for a custom State type.

7.  trait HealthElement extends AnyRef

   There are 2 subtypes of HealthElement: - ComponentHealth: directly reports its own health - ServiceHealth: Aggregates ComponentHealth under critical and soft dependencies Services are queryable through their name in the gRPC Health Check service/

8.  final case class HealthService(name: String, criticalDependencies: Seq[BaseHealthComponent] = Seq.empty, softDependencies: Seq[BaseHealthComponent] = Seq.empty) extends HealthElement with Product with Serializable
9.  final case class MutableHealthComponent(loggerFactory: NamedLoggerFactory, uninitializedName: String, timeouts: ProcessingTimeout, shutdownState: ComponentHealthState = ComponentHealthState.ShutdownState) extends BaseMutableHealthComponent[HealthComponent] with HealthComponent with Product with Serializable

   Mutable component for ComponentHealths

10.  final case class ServiceHealthStatusManager(name: String, manager: HealthStatusManager, services: Set[HealthService]) extends Product with Serializable

    Combines a health status manager (exposed as a gRPC health service), with the set of health services it needs to report on.