Skip to content

docs: improve performance tuning and profiling guidance#2581

Draft
evenyag wants to merge 4 commits into
mainfrom
docs/performance-tips
Draft

docs: improve performance tuning and profiling guidance#2581
evenyag wants to merge 4 commits into
mainfrom
docs/performance-tips

Conversation

@evenyag

@evenyag evenyag commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

What's Changed in this PR

  • Expands the performance tuning tips page with EXPLAIN ANALYZE VERBOSE guidance for debugging slow queries, including common scan, filter, cache, and metadata findings.
  • Updates cache tuning guidance with current cache metrics, cache type labels, index cache allocation, range result and prefilter result caches, and index cache sizing tips.
  • Adds ingestion troubleshooting guidance for throughput, request latency, datanode write pressure, flush performance, write distribution, and write buffer sizing.
  • Adds CPU and memory profiling collection guidance for nodes with high resource usage, including platform availability, node-local collection, flamegraph overhead, and issue reporting details.
  • Refreshes the Profiling Tools HTTP endpoint reference with current CPU and memory profiling endpoints, output formats, heap profiling status and activation, gdump, and symbolication.
  • Updates the region engine configuration reference with corrected cache default descriptions and the range_result_cache_size and prefilter_result_cache_size options.

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

evenyag added 4 commits June 17, 2026 17:08
Signed-off-by: evenyag <realevenyag@gmail.com>
Signed-off-by: evenyag <realevenyag@gmail.com>
Signed-off-by: evenyag <realevenyag@gmail.com>
Signed-off-by: evenyag <realevenyag@gmail.com>
@evenyag evenyag changed the title docs: add profiling collection guidance docs: improve performance tuning and profiling guidance Jun 22, 2026

@fengjiachun fengjiachun left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

En part LGTM

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants