Skip to content

docs: fix nonexistent query_processed_rows metric (should be query_returned_rows)#1911

Merged
lukekim merged 1 commit into
trunkfrom
docs-fix-query-processed-rows-metric
Jul 9, 2026
Merged

docs: fix nonexistent query_processed_rows metric (should be query_returned_rows)#1911
lukekim merged 1 commit into
trunkfrom
docs-fix-query-processed-rows-metric

Conversation

@claudespice

Copy link
Copy Markdown
Collaborator

Summary

Deployment guides across many connectors list a Spice query-execution metric named query_processed_rows under runtime.metrics. No such metric exists. The runtime's query telemetry defines:

  • query_processed_bytes (u64 counter)
  • query_returned_bytes (u64 counter)
  • query_returned_rows (u64 histogram) ← the actual rows metric
  • query_duration_ms (f64 histogram)
  • query_failures (u64 counter; exported as query_failures_total)

Source: crates/runtime/src/metrics/telemetry/mod.rs:59-99 and crates/runtime-metrics/src/telemetry/mod.rs:59-99 (.u64_histogram("query_returned_rows") at line 85). A repo-wide grep for query_processed_rows returns no instrument — the only processed_rows match is the unrelated dataset_acceleration_refresh_processed_rows.

This corrects query_processed_rowsquery_returned_rows everywhere it appears.

What changed

Replaced the fabricated query_processed_rows with the real query_returned_rows in all deployment/monitoring sections. Affected connectors/catalogs: s3, dremio, delta-lake, spiceai, cosmosdb, elasticsearch, github, graphql, https, duckdb, file, and the unity-catalog catalog page. Propagated across vNext + version-2.0.x + version-2.1.x (36 files).

Source PRs

  • Verified against spiceai/spiceai at trunk: crates/runtime/src/metrics/telemetry/mod.rs (metric definitions).

Test plan

  • grep -rn query_processed_rows website/ → 0 hits after fix
  • Pure inline-code token rename; no links, tags, or frontmatter changed (Docusaurus link/tag validation unaffected). Local npm run build not run in this environment (no node_modules; full versioned build is memory-constrained) — CI Deploy check is the authoritative link/tag gate for this prose-only diff.
  • Files updated: 36 (1 unversioned set + version-2.0.x + version-2.1.x)

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ No banned labels detected

Failed checks:

  • ❌ Please select at least one of the required labels for this pull request: area/blog, area/docs, area/cookbook, dependencies
  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🚀 deployed to https://047c17e1.spiceai-org-website.pages.dev

@lukekim lukekim merged commit e6a1863 into trunk Jul 9, 2026
6 of 10 checks passed
@lukekim lukekim deleted the docs-fix-query-processed-rows-metric branch July 9, 2026 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants