Add query timing and debug logging to index execution paths
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 427
- Forks
- 101
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 20
Description
Summary
Add query timing and debug logging around index execution paths for better observability.
Level: Intermediate
Current State
- Logging exists in some RedisVL components, but query execution paths are lightly instrumented.
- Performance triage often requires ad hoc local instrumentation.
Proposed Change
- Add debug logs for sync/async query execution in
redisvl/index/index.py:- query category/type
- elapsed time (ms)
- result count
- Add optional slow-query warning threshold.
Definition of Done
- Query timing appears in debug logs for sync and async paths.
- No functional behavior changes to query results.
- Overhead is negligible when debug logging is disabled.
Out of Scope
- Full tracing backend integration (OpenTelemetry, etc.).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in redisvl/index/index.py and trace the sync and async query execution paths, noting where query type, elapsed time, and result count can be observed. Done means both paths emit the requested debug timing data, slow queries can trigger the optional warning, results are unchanged, and disabled debug logging adds negligible overhead.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, redis
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100