check-example

Template: Copy this file and rename it to check-<your_check>.md when adding a new health check.

Overview

Brief description of what this check monitors and why it matters for cluster health.

Requirements

List any external tools, packages, or hardware needed. Remove this section if there are no special requirements.

• Tool Name: Description of the tool
• Package: apt-get install package-name or yum install package-name

Command-Line Options

Option	Type	Default	Description
--your-option	String	-	Description of check-specific option
--timeout	Integer	300	Command execution timeout in seconds
--sink	String	do_nothing	Telemetry sink destination
--sink-opts	Multiple	-	Sink-specific configuration
--verbose-out	Flag	False	Display detailed output
--log-level	Choice	INFO	DEBUG, INFO, WARNING, ERROR, CRITICAL
--log-folder	String	/var/log/fb-monitoring	Log directory
--heterogeneous-cluster-v1	Flag	False	Enable heterogeneous cluster support

Exit Conditions

Exit Code	Condition
OK (0)	Feature flag disabled (killswitch active)
OK (0)	Normal condition — no errors detected
WARN (1)	Warning condition
WARN (1)	Command execution failed
CRITICAL (2)	Critical condition
UNKNOWN (3)	Unexpected error before parsing

Usage Examples

Basic Check

health_checks check-example [CLUSTER] app

With Telemetry

health_checks check-example \
  --sink otel \
  --sink-opts "log_resource_attributes={'attr_1': 'value1'}" \
  [CLUSTER] \
  app

Debug Mode

health_checks check-example \
  --log-level DEBUG \
  --verbose-out \
  --sink stdout \
  [CLUSTER] \
  app