Skip to main content
The StarTree Cloud Cluster Health Dashboard provides a real-time overview of your Apache Pinot cluster’s operational status. Designed to help you proactively identify and resolve potential issues, this dashboard displays the pass/fail status of various system checks, allowing you to quickly pinpoint performance bottlenecks or stability concerns. By observing key health indicators and filtering checks based on specific instances or tables, you gain a holistic view of your cluster’s well-being, ensuring optimal data ingestion and query performance.

Key Features of the Cluster Health Dashboard

  • Comprehensive Health Checks: Monitors essential components and operations of your Pinot cluster, including Zookeeper connectivity, controller health, segment availability, and more.
  • Clear Pass/Fail Status: Quickly identify issues with intuitive status indicators for each check.
  • Granular Filtering: Drill down into specific health concerns by filtering checks based on individual instances or particular tables.
  • Detailed Insights: Access additional context and error messages for failed checks to aid in troubleshooting.

Accessing the Cluster Health Dashboard

Follow these steps to view your cluster’s health in the StarTree Cloud UI:
  1. Log in to the StarTree Cloud Data Portal.
  2. Click the Cluster Health link in the left navigation menu.
A dashboard will appear, displaying a comprehensive list of health checks. For each check, you’ll see:
  • Its descriptive name.
  • A clear PASS or FAIL status indicator.
  • Additional details which may include specific error messages, affected instances, or relevant metrics to help you understand the issue.

How Cluster Health Checks Work

The cluster health checks are executed by the ClusterHealthCheckTask, which runs periodically every 20 minutes by default. The results of these checks are cached in memory and overwritten with each new run, ensuring you always see the latest health status.

Understanding and Responding to Health Check Failures

When a health check fails, it indicates a potential issue that may impact your cluster’s performance or stability. The “additional details” provided for each failed check are crucial for diagnosis.

Using Cluster Health Checks Ad-Hoc (API Reference)

For immediate insights or integration with automated scripts, you can trigger and fetch cluster health checks using the following Controller API calls:

Run Health Checks Immediately

This endpoint triggers the ClusterHealthCheckTask to run at the moment you call it, bypassing the default 20-minute interval.
Example cURL Request:
Expected Response: A confirmation message indicating that the task has been queued or executed successfully.

Fetch Current Cluster Health Report

Retrieves the latest cached cluster health report, containing the pass/fail status and details of all checks.
Example cURL Request:
Expected Response: A JSON object detailing the status of all health checks, similar to what you would see in the dashboard. List All Available Cluster Health Checks Provides a list of all defined health check types that the system monitors, along with their brief descriptions.
Example cURL Request:
Expected Response: A JSON array listing all available health checks, useful for understanding the scope of the dashboard.

List of Available Health Checks

The StarTree Cloud Cluster Health Dashboard monitors a wide range of parameters to ensure your Pinot cluster’s optimal operation. Below is a list of the checks performed and their descriptions:
  • Scheduled Server Scaling — the INSTANCE_POOLS_CHECK and INSTANCE_POOLS_N_REPLICA_GROUPS_CHECK checks above cover the same pool/replica-group setup that scheduled scale-down requires.