Skip to main content

Analysis API

Prefix: /api/analysis | Tag: analysis

Breaking-point analysis, usage-pattern charts, and cluster version/upgrade data. Queries run against StarRocks metrics and the unified scores table.

Endpoints​

MethodPathDescription
GET/api/analysis/breakingClusters near breaking point (threshold cards)
GET/api/analysis/usageUsage-pattern chart data
GET/api/analysis/upgradesCluster versions and available upgrades

GET /api/analysis/breaking​

Returns clusters that breach warning/critical thresholds across key metrics (compaction, disk, query errors, memory, etc.).

Response:

{
  "thresholds": [
    {
      "metric": "Max Compaction",
      "threshold": 1000,
      "unit": "",
      "count": 3,
      "clusters": [
        {"cluster_name": "prod-analytics", "customer_name": "Acme", "value": 8500}
      ]
    }
  ],
  "details": [
    {
      "metric": "Max Compaction",
      "cluster_id": "uuid",
      "cluster_name": "prod-analytics",
      "customer_name": "Acme",
      "value": 8500,
      "threshold": 1000,
      "unit": "",
      "severity": "critical"
    }
  ],
  "source": "live",
  "generated_at": "..."
}

GET /api/analysis/usage​

Returns chart data for health distribution, compaction bars, latency trends, and QPS bars.

Response:

{
  "health_distribution": {"healthy": 150, "warning": 15, "critical": 7},
  "compaction_bars": [{"cluster_name": "...", "value": 1200.5, "threshold": 5000}],
  "latency_trend": [{"cluster_name": "...", "avg_latency": 120.3, "max_latency": 890.0}],
  "qps_bars": [{"cluster_name": "...", "value": 5432.1}],
  "source": "live",
  "generated_at": "..."
}

GET /api/analysis/upgrades​

Returns active clusters with their current StarRocks versions and available upgrade targets.

Response:

{
  "clusters": [
    {
      "cluster_id": "uuid",
      "cluster_name": "prod-analytics",
      "customer_name": "Acme Corp",
      "cluster_type": "ELASTIC",
      "region": "US East (N. Virginia) us-east-1",
      "sr_version": "3.4.7-ee",
      "resource_state": "RUNNING",
      "node_count": 5
    }
  ],
  "available_versions": ["3.5.15-ee", "3.5.14-ee", "..."],
  "source": "live",
  "generated_at": "..."
}