Skip to content

[D1] Add Query Insights documentation - #33383

Draft
ivoryibu wants to merge 1 commit into
productionfrom
d1-query-insights-updates
Draft

[D1] Add Query Insights documentation#33383
ivoryibu wants to merge 1 commit into
productionfrom
d1-query-insights-updates

Conversation

@ivoryibu

Copy link
Copy Markdown
Collaborator

Summary

Adds the Query Insights documentation page for D1 at /d1/observability/query-insights/. This page covers how to access query metrics and automated index recommendations via the Cloudflare CLI (cf), Wrangler, and REST API, and walks through applying a recommended index using D1 migrations.

Key decisions reflected in this draft:

  • Dashboard UI is excluded from the "Access insights" section — general query insights (latency, volume, rows read/written) are not yet exposed in the dashboard. A dedicated subsection under index recommendations notes that recommendations are visible in the dashboard under the Queries tab, with an image placeholder to be filled once a screenshot is available.
  • Cloudflare CLI (cf) and Wrangler are both listed throughout as separate tools, both supporting index recommendations.
  • Includes a copyable AI-agent prompt block for users who want to pipe the raw CLI JSON into an agent to generate a migration script.
  • "Handle errors" API error table removed — not included in this page.

Screenshots (optional)

Documentation checklist

  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.

@github-actions github-actions Bot added the product:d1 D1: https://developers.cloudflare.com/d1/ label Sep 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/d1/ @irvinebroque, @ivoryibu, @joshthoward, @lambrospetrou, @rita3ko, @rts-rob, @vy-ton, @cloudflare/product-owners

@cloudflare-workers-and-pages

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://d1-query-insights-updates.previews.developers.cloudflare.com (commit a13d403)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://68d9324e.previews.developers.cloudflare.com a13d403 2026-09-10T19:40:15.703Z Visit the dashboard ↗

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:d1 D1: https://developers.cloudflare.com/d1/ size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants