checkclientsarehealthy

check_clients_are_healthy Task

Description

The check_clients_are_healthy task is designed to ensure the health of specified clients. It verifies if the clients are reachable and synchronized on the same network.

Task Behavior

• The task polls clients at regular intervals to check their health status.
• By default, the task returns immediately when the health criteria are met.
• Use continueOnPass: true to keep monitoring even after success (useful for continuous health monitoring).

Configuration Parameters

• clientPattern:
  A regular expression pattern used to specify which clients to check. This allows for targeted health checks of specific clients or groups of clients within the network. A blank pattern targets all clients.

• pollInterval:
  The interval at which the health check is performed. Set this to define how frequently the task should check the clients' health. Default: 5s.

• skipConsensusCheck:
  A boolean value that, when set to true, skips the health check for consensus clients. Useful if you only want to focus on execution clients. Default: false.

• skipExecutionCheck:
  A boolean value that, when set to true, skips the health check for execution clients. Use this to exclusively check the health of consensus clients. Default: false.

• expectUnhealthy:
  A boolean value that inverts the expected result of the health check. When true, the task succeeds if the clients are not ready or unhealthy. This can be useful in test scenarios where client unavailability is expected or being tested. Default: false.

• minClientCount:
  The minimum number of clients that must match the clientPattern and pass the health checks for the task to succeed. A value of 0 indicates that all matching clients need to pass the health check. Default: 0.

• maxUnhealthyCount:
  Specifies the maximum number of unhealthy clients allowed before the health check fails. A value of -1 means unlimited unhealthy clients are allowed. A value of 0 means that any unhealthy client will cause the health check to fail. Default: -1.

• failOnCheckMiss:
  Determines the task's behavior when a health check fails. If true, the task reports a failure upon the first unsuccessful health check. If false, the task continues to poll the clients until a successful check occurs. Default: false.

• continueOnPass:
  If set to true, the task continues monitoring client health even after the criteria are met. This is useful for continuous health monitoring during long-running tests. If false (default), the task exits immediately on success.

Defaults

These are the default settings for the check_clients_are_healthy task:

- name: check_clients_are_healthy
  config:
    clientPattern: ""
    pollInterval: 5s
    skipConsensusCheck: false
    skipExecutionCheck: false
    expectUnhealthy: false
    minClientCount: 0
    maxUnhealthyCount: -1
    failOnCheckMiss: false
    continueOnPass: false

Outputs

This task does not produce any outputs.