[MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output by meiravgri · Pull Request #7709 · RediSearch/RediSearch

meiravgri · 2025-12-10T05:22:30Z

Summary

Adds a new metric Internal cursor reads to FT.PROFILE shard profiles that tracks the number of cursor reads performed during distributed aggregate operations.

Changes

Feature: Track internal cursor reads

Added cursor_reads field to AREQ struct to count cursor read operations
Increment counter in runCursor() for each cursor read (initial + subsequent reads)
Print "Internal cursor reads" in shard profile output when IsCursor(req) is true

Bug Fix

Preserve timeout flag across cursor reads in cluster FT.PROFILE

Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output.

Note

Add shard-level Internal cursor reads metric to FT.PROFILE AGGREGATE and ensure timeout state persists across cursor reads.

Feature: FT.PROFILE AGGREGATE (cluster)
- Track and expose shard-level Internal cursor reads in profile output.
- Add AREQ::cursor_reads and increment in runCursor(); print metric in Profile_Print() when IsCursor(req).
Reliability
- Preserve timeout state across cursor reads: use req->has_timedout |= has_timedout and pass req->has_timedout to profile context in both RESP2/RESP3 paths.
Tests
- Add RESP2/RESP3 tests for Internal cursor reads, including timeout scenarios and coordinator behavior.
- Update RESP3 expected shard profile schema to include Internal cursor reads.
- Adjust indices in existing profile-based tests to account for new field.

^{Written by Cursor Bugbot for commit 21f2b68. This will update automatically on new commits. Configure here.}

update in runCursor print in Profile_Print if cursor

Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output.

src/aggregate/aggregate.h

src/aggregate/aggregate_exec.c

GuyAv46 · 2025-12-10T10:55:36Z

tests/pytests/test_profile.py

+  env.assertEqual(len(res[0]) - 1, num_docs)
+
+  shards_profile = get_shards_profile(env, res)
+  env.assertEqual(len(shards_profile), env.shardsCount)


Consider adding the shards_profile as a message on failure

GuyAv46 · 2025-12-10T10:56:35Z

tests/pytests/test_profile.py

+  res = env.cmd('FT.PROFILE', 'idx', 'AGGREGATE', 'QUERY', '*')
+
+  shards_profile = get_shards_profile(env, res)
+  env.assertEqual(len(shards_profile), env.shardsCount)


Consider adding the shards_profile as a message on failure

codecov · 2025-12-10T11:11:34Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.83%. Comparing base (2402970) to head (21f2b68).
⚠️ Report is 13 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7709      +/-   ##
==========================================
- Coverage   84.84%   84.83%   -0.02%     
==========================================
  Files         349      349              
  Lines       54413    54551     +138     
  Branches    14500    14632     +132     
==========================================
+ Hits        46169    46278     +109     
- Misses       8049     8076      +27     
- Partials      195      197       +2

Flag	Coverage Δ
flow	`85.18% <100.00%> (-0.17%)`	⬇️
unit	`51.96% <0.00%> (+0.09%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

redisearch-backport-pull-request · 2025-12-10T16:48:26Z

Backport failed for 2.8, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.8
git worktree add -d .worktree/backport-7709-to-2.8 origin/2.8
cd .worktree/backport-7709-to-2.8
git switch --create backport-7709-to-2.8
git cherry-pick -x 005186a403e44e718c6094925a55ad651afc05cf

redisearch-backport-pull-request · 2025-12-10T16:48:27Z

Backport failed for 2.10, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.10
git worktree add -d .worktree/backport-7709-to-2.10 origin/2.10
cd .worktree/backport-7709-to-2.10
git switch --create backport-7709-to-2.10
git cherry-pick -x 005186a403e44e718c6094925a55ad651afc05cf

redisearch-backport-pull-request · 2025-12-10T16:48:29Z

Backport failed for 8.2, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 8.2
git worktree add -d .worktree/backport-7709-to-8.2 origin/8.2
cd .worktree/backport-7709-to-8.2
git switch --create backport-7709-to-8.2
git cherry-pick -x 005186a403e44e718c6094925a55ad651afc05cf

redisearch-backport-pull-request · 2025-12-10T16:48:30Z

Backport failed for 8.4, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 8.4
git worktree add -d .worktree/backport-7709-to-8.4 origin/8.4
cd .worktree/backport-7709-to-8.4
git switch --create backport-7709-to-8.4
git cherry-pick -x 005186a403e44e718c6094925a55ad651afc05cf

…output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a)

…OFILE output (#7709) (#7736) * [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a) * fix IsCursor

…OFILE output (#7737) [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a)

…output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a)

…ROFILE output (#7746) * [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a) * fix test * fix test * fix test

[MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a)

…ROFILE output (#7746) * [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a) * fix test * fix test * fix test (cherry picked from commit 1911f5b)

…OFILE output (#7751) * cp master [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a) * [2.10] [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7746) * [MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output (#7709) * add cursor_reads to req struct update in runCursor print in Profile_Print if cursor * Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output. * fix test * fix test * add message to the test (cherry picked from commit 005186a) * fix test * fix test * fix test (cherry picked from commit 1911f5b) * minimal test for timeout * remove new code

add cursor_reads to req struct

0546b33

update in runCursor print in Profile_Print if cursor

github-actions bot added the size:S label Dec 10, 2025

meiravgri changed the title ~~add cursor_reads to req struct~~ [MOD-12414] add cursor_reads to req struct Dec 10, 2025

meiravgri requested a review from GuyAv46 December 10, 2025 09:32

meiravgri changed the title ~~[MOD-12414] add cursor_reads to req struct~~ [MOD-12414] Add Internal cursor reads metric to cluster FT.PROFILE output Dec 10, 2025

meiravgri added backport 2.8 backport 2.10 backport 8.2 backport 8.4 labels Dec 10, 2025

Fix: Preserve timeout flag across cursor reads in cluster FT.PROFILE

3c5e62b

Use |= instead of = to ensure has_timedout remains true once set, preventing earlier cursor read warnings from being lost in final output.

github-actions bot added the size:M label Dec 10, 2025

fix test

0770dee

meiravgri enabled auto-merge December 10, 2025 10:13

fix test

b5147a0

GuyAv46 reviewed Dec 10, 2025

View reviewed changes

add message to the test

21f2b68

GuyAv46 approved these changes Dec 10, 2025

View reviewed changes

meiravgri added this pull request to the merge queue Dec 10, 2025

Merged via the queue into master with commit 005186a Dec 10, 2025
26 checks passed

meiravgri deleted the meriavg_profile_cursor_reads branch December 10, 2025 16:48

meiravgri mentioned this pull request Dec 10, 2025

[8.4] [MOD-12414] Add Internal cursor reads metric to cluster FT.PROFILE output (#7709) #7736

Merged

meiravgri mentioned this pull request Dec 10, 2025

[8.2] [MOD-12414] Add Internal cursor reads metric to cluster FT.PROFILE output #7737

Merged

meiravgri mentioned this pull request Dec 11, 2025

[2.10] [MOD-12414] Add Internal cursor reads metric to cluster FT.PROFILE output #7746

Merged

meiravgri mentioned this pull request Dec 11, 2025

[2.8] [MOD-12414] Add Internal cursor reads metric to cluster FT.PROFILE output #7751

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output#7709

[MOD-12414] Add `Internal cursor reads` metric to cluster FT.PROFILE output#7709
meiravgri merged 5 commits intomasterfrom
meriavg_profile_cursor_reads

meiravgri commented Dec 10, 2025 •

edited by cursor bot

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuyAv46 Dec 10, 2025

Uh oh!

GuyAv46 Dec 10, 2025

Uh oh!

codecov bot commented Dec 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

meiravgri commented Dec 10, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Bug Fix

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuyAv46 Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

GuyAv46 Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

redisearch-backport-pull-request bot commented Dec 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

meiravgri commented Dec 10, 2025 •

edited by cursor bot

Loading

codecov bot commented Dec 10, 2025 •

edited

Loading