Function controller_health

python/ray/serve/scripts.py:805–846

(address: str, output_json: bool)

    help="Output metrics as JSON instead of formatted YAML.",
)
def controller_health(address: str, output_json: bool):
    if not ray.is_initialized():
        # Connect to existing cluster only, don't start a new one
        try:
            ray.init(
                address=address,
                namespace=SERVE_NAMESPACE,
            )
        except ConnectionError:
            cli_logger.error(
                f"Could not connect to Ray cluster at address '{address}'. "
                "Make sure a Ray cluster is running."
            )
            sys.exit(1)

    try:
        # Get the controller handle
        controller = _get_global_client()._controller

        # Fetch health metrics
        metrics = ray.get(controller.get_health_metrics.remote())

        if output_json:
            print(json.dumps(metrics, indent=2))
        else:
            print(
                yaml.dump(
                    metrics,
                    default_flow_style=False,
                    sort_keys=False,
                ),
                end="",
            )
    except RayServeException as e:
        cli_logger.error(str(e))
        sys.exit(1)
    except Exception:
        cli_logger.error(
            "Failed to get controller health metrics, "
            "see the controller logs for more details."
        )
        sys.exit(1)


@cli.command(