What problem does it solve?
This skill eliminates the need to manually navigate multiple Clinic UI pages or write ad-hoc curl commands to gather cluster observability data. It provides a unified, scriptable interface for querying cluster metadata, slow queries, metrics, logs, profiling data, and diagnostic files from PingCAP Clinic.
Core Features & Use Cases
- Cluster Metadata & Topology: Retrieve cluster details, node counts, CPU/memory specs, and storage configuration for Dedicated, Premium, and BYOC clusters.
- Observability Data Access: Query Prometheus metrics, Loki logs, slow query logs, and TopSQL aggregates through standardized REST endpoints.
- Diagnostic Artifacts: Download continuous profiling (pprof) data and NGM diagnostic bundles (plan replayer, OOM records) for offline analysis.
- Use Case: When investigating a TiDB performance incident, use this skill to pull the cluster topology, fetch the top slow queries for the incident window, download CPU profiles from hot TiKV nodes, and retrieve recent OOM diagnostic files.
Quick Start
Use the clinic-api skill to retrieve cluster topology and recent slow query logs for a given cluster ID by sourcing the shell helper script and calling the appropriate sub-skill functions.