Packages

object CheckConfig

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CheckConfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class IsActive(node: Option[String] = None) extends CheckConfig with Product with Serializable

    Returns the isActive state of a node.

    Returns the isActive state of a node. Intended for a HA node where only one of potentially many replicas will be active concurrently.

    node

    If unset will default to picking the only configured node as this is the likely usage of this check. If many nodes are available within the process it will pick the first participant node. If using many nodes in process then set to the configured name of the node to return the active status of.

  2. case class Ping(participant: String, interval: time.NonNegativeFiniteDuration, timeout: time.NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(10)) extends CheckConfig with Product with Serializable

    Attempt to ping the given participant to determine health

    Attempt to ping the given participant to determine health

    participant

    Alias of a locally configured participant (will ping itself)

    interval

    The duration to wait between pings

    timeout

    Duration to allow for the ping to complete

Value Members

  1. case object AlwaysHealthy extends CheckConfig with Product with Serializable

    Always return a healthy result - useful for testing and where there may be no suitable domain configured to use the ping health check

  2. object IsActive extends Serializable