Skip to content

Document query profiling#394

Merged
g-despot merged 1 commit intomainfrom
query-profiling
Apr 17, 2026
Merged

Document query profiling#394
g-despot merged 1 commit intomainfrom
query-profiling

Conversation

@g-despot
Copy link
Copy Markdown
Contributor

Summary

Document the query profiling feature (added in v1.36.9) that provides per-shard timing breakdowns for search queries.

New pages

  • docs/weaviate/search/query-profile.md — Full how-to: enabling profiling, supported search types (vector, BM25, hybrid, fetch), response structure, all available metrics (general, vector, filter, BM25), example output, multi-node behavior, performance impact, limitations
  • _includes/code/howto/search.profile.py — Python examples for near_vector, BM25, hybrid, and list-style metadata
  • _includes/feature-notes/query-profile.mdx — Shared version admonition

Cross-references added

  • search/basics.md — Tip box in "Retrieve metadata values" section
  • api/graphql/additional-properties.md — New queryProfile additional property
  • deploy/configuration/logging.md — Link from slow query logging
  • deploy/configuration/monitoring.md — Contrast with Prometheus aggregate metrics
  • more-resources/performance.md — New "Profiling query performance" section
  • sidebars.js — Added to search sidebar

Verified

  • All 6 test scenarios pass against Weaviate 1.37.0-rc.0 (near_vector, BM25, hybrid, fetch_objects, list-style metadata, no-profile-when-not-requested)

🤖 Generated with Claude Code

Copy link
Copy Markdown

@orca-security-eu orca-security-eu Bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@g-despot g-despot merged commit 852903f into main Apr 17, 2026
13 checks passed
@g-despot g-despot deleted the query-profiling branch April 17, 2026 10:12
@g-despot g-despot restored the query-profiling branch April 17, 2026 10:12
g-despot added a commit that referenced this pull request Apr 17, 2026
This reverts commit 852903f, reversing
changes made to e4f87b8.
@g-despot g-despot deleted the query-profiling branch April 20, 2026 07:11
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.

1 participant