@@ -163,6 +163,7 @@ macro_rules! http_tests {
163163 test_http_auth,
164164 test_sql_api,
165165 test_http_analyze_stream_tql,
166+ test_http_analyze_stream_scan_diagnostics,
166167 test_http_sql_slow_query,
167168 test_prometheus_promql_api,
168169 test_promql_over_non_millisecond_physical_tables,
@@ -1338,6 +1339,133 @@ async fn test_sql_format_api() {
13381339 guard.remove_all().await;
13391340}
13401341
1342+ pub async fn test_http_analyze_stream_scan_diagnostics(store_type: StorageType) {
1343+ // Check both levels of JSON: the analyze node schema and the verbose scan
1344+ // object inside its string-valued `param`.
1345+ fn scan_details(node: &Value, scans: &mut Vec<Value>) {
1346+ assert!(node["name"].is_string());
1347+ assert!(node["param"].is_string());
1348+ assert!(node["output_rows"].is_u64());
1349+ assert!(node["elapsed_compute"].is_u64());
1350+ assert!(node["metrics"].is_object());
1351+ if matches!(
1352+ node["name"].as_str(),
1353+ Some("SeqScan" | "UnorderedScan" | "SeriesScan")
1354+ ) {
1355+ let (_, fields) = node["param"].as_str().unwrap().split_once("), ").unwrap();
1356+ let fields = if fields.starts_with('{') {
1357+ fields.to_string()
1358+ } else {
1359+ format!("{{{fields}}}")
1360+ };
1361+ let details: Value = serde_json::from_str(&fields).unwrap();
1362+ assert_eq!(details["projection"], json!(["reading", "ts"]));
1363+ assert!(
1364+ details["filters"]
1365+ .as_array()
1366+ .is_some_and(|filters| !filters.is_empty())
1367+ );
1368+ assert_eq!(details["time_range"], "TimestampRange{[0ms,6000ms)}");
1369+ assert_eq!(details["file_summary"]["files"], 2);
1370+ assert_eq!(details["file_summary"]["rows"], 4);
1371+ assert_eq!(details["file_summary"]["row_groups"], 2);
1372+ assert_eq!(details["max_part_range"]["files"], 2);
1373+ assert!(details["max_part_range"].get("identifier").is_none());
1374+ scans.push(details);
1375+ }
1376+ for child in node["children"].as_array().unwrap() {
1377+ scan_details(child, scans);
1378+ }
1379+ }
1380+ fn assert_verbose(scans: &[Value]) {
1381+ assert!(!scans.is_empty());
1382+ for scan in scans {
1383+ let files = scan["files"].as_array().unwrap();
1384+ assert_eq!(files.len(), 2);
1385+ for key in ["rows", "size", "index_size"] {
1386+ assert_eq!(
1387+ scan["file_summary"][key],
1388+ files
1389+ .iter()
1390+ .map(|file| file[key].as_u64().unwrap())
1391+ .sum::<u64>()
1392+ );
1393+ }
1394+ }
1395+ }
1396+
1397+ let (app, mut guard) = setup_test_http_app_with_frontend(store_type, "scan_diagnostics").await;
1398+ let client = TestClient::new(app).await;
1399+ for sql in [
1400+ "CREATE TABLE scan_diagnostics (host STRING PRIMARY KEY, reading DOUBLE, ts TIMESTAMP TIME INDEX)",
1401+ "INSERT INTO scan_diagnostics VALUES ('a', 1, 0), ('b', 2, 3000)",
1402+ "ADMIN FLUSH_TABLE('scan_diagnostics')",
1403+ "INSERT INTO scan_diagnostics VALUES ('c', 3, 2000), ('d', 4, 5000)",
1404+ "ADMIN FLUSH_TABLE('scan_diagnostics')",
1405+ "INSERT INTO scan_diagnostics VALUES ('outside', 5, 10000)",
1406+ "ADMIN FLUSH_TABLE('scan_diagnostics')",
1407+ "INSERT INTO scan_diagnostics VALUES ('mem', 6, 1000)",
1408+ ] {
1409+ let response = execute_sql(&client, sql).await;
1410+ let status = response.status();
1411+ let body = response.text().await;
1412+ assert_eq!(status, StatusCode::OK, "{sql}: {body}");
1413+ let body: Value = serde_json::from_str(&body).unwrap();
1414+ assert!(body.get("error").is_none(), "{body}");
1415+ }
1416+ let query = "SELECT reading, ts FROM scan_diagnostics WHERE ts >= 0 AND ts < 6000";
1417+ let sql = format!("EXPLAIN ANALYZE FORMAT JSON {query}");
1418+ let response = execute_sql(&client, &sql).await;
1419+ let status = response.status();
1420+ let body = response.text().await;
1421+ assert_eq!(status, StatusCode::OK, "{body}");
1422+ let body: Value = serde_json::from_str(&body).unwrap();
1423+ let mut explain_scans = vec![];
1424+ for row in body["output"][0]["records"]["rows"].as_array().unwrap() {
1425+ if row[0].is_null() {
1426+ assert_eq!(row[2], "Total rows: 5");
1427+ continue;
1428+ }
1429+ let plan: Value = serde_json::from_str(row[2].as_str().unwrap()).unwrap();
1430+ scan_details(&plan, &mut explain_scans);
1431+ }
1432+ assert!(!explain_scans.is_empty());
1433+ assert!(explain_scans.iter().all(|scan| scan.get("files").is_none()));
1434+
1435+ let sql = format!("EXPLAIN ANALYZE VERBOSE FORMAT JSON {query}");
1436+ let response = client
1437+ .post("/v1/sql/analyze/stream?snapshot_interval_ms=100")
1438+ .header("Accept", "text/event-stream")
1439+ .form(&BTreeMap::from([("sql", sql)]))
1440+ .send()
1441+ .await;
1442+ assert_eq!(response.status(), StatusCode::OK);
1443+ let body = response.text().await;
1444+ let mut first_scan_seen = false;
1445+ let mut final_seen = false;
1446+ for event in body.split("\n\n") {
1447+ let Some(data) = event.lines().find_map(|line| line.strip_prefix("data: ")) else {
1448+ continue;
1449+ };
1450+ let payload: Value = serde_json::from_str(data).unwrap();
1451+ let mut scans = vec![];
1452+ for stage in payload["metrics"].as_array().unwrap() {
1453+ assert!(stage["stage"].is_u64());
1454+ assert!(stage["node"].is_u64());
1455+ scan_details(&stage["plan"], &mut scans);
1456+ }
1457+ // Every available scan is checked, including its first appearance. A fast
1458+ // query may finish before the first periodic snapshot.
1459+ first_scan_seen |= !scans.is_empty();
1460+ if payload["state"] == "final" {
1461+ assert_verbose(&scans);
1462+ final_seen = true;
1463+ }
1464+ }
1465+ assert!(first_scan_seen && final_seen, "{body}");
1466+ guard.remove_all().await;
1467+ }
1468+
13411469pub async fn test_http_analyze_stream_tql(store_type: StorageType) {
13421470 common_telemetry::init_default_ut_logging();
13431471 let (app, mut guard) =
0 commit comments