[Client Introspection] Client Commands Extended Filtering #1466

sarthakaggarwal97 · 2024-12-20T16:35:55Z

In this PR, we introduce a support for few more filters for CLIENT LIST and CLIENT KILL commands. We introduce these new filters:

FLAGS Client must include this flag. This can be a string with bunch of flags present one after the other.
NAME client name
IDLE minimum idle time of the client
LIB-NAME clients with the specified lib name.
LIB-VER clients with the specified lib version.
DB clients currently operating on the specified database ID
IP client ip address
CAPA client capabilities

Partly Addresses: #668

codecov · 2024-12-20T20:07:31Z

Codecov Report

Attention: Patch coverage is 71.05263% with 44 lines in your changes missing coverage. Please review.

Project coverage is 71.00%. Comparing base (51387dd) to head (4b7d0d7).
Report is 1 commits behind head on unstable.

Files with missing lines	Patch %	Lines
src/networking.c	71.05%	44 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##           unstable    #1466      +/-   ##
============================================
+ Coverage     70.98%   71.00%   +0.01%     
============================================
  Files           123      123              
  Lines         65768    65912     +144     
============================================
+ Hits          46687    46799     +112     
- Misses        19081    19113      +32

Files with missing lines	Coverage Δ
src/commands.def	`100.00% <ø> (ø)`
src/networking.c	`87.48% <71.05%> (-1.03%)`	⬇️

... and 12 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sarthakaggarwal97 · 2025-01-22T18:05:32Z

@zuiderkwast @hpatro would you please help review this. I have added the additional filters requested in #668.
Once the decision is being taken over the IP filter, I can add that as well. Thank you!

sarthakaggarwal97 · 2025-02-07T22:27:38Z

@valkey-io/core-team requesting you to take a look at the PR. Related to #668! Thank you

zuiderkwast

Looks good to me on a high level. The refactoring is already done in the previous PR so the implementation in this PR strait-forward.

Still, it's a large change to the user-facing interface that needs to be carefully reviewed and needs majority approval. We are near the cutoff for 8.1 and we have many features that seem more important to prioritize. We may need to postpone this feature to 9.0, or maybe we can accept it after RC1.

src/networking.c

soloestoy · 2025-02-10T06:49:17Z

does this PR support negative filtering?

sarthakaggarwal97 · 2025-02-10T17:41:49Z

@soloestoy it doesn't support negative filtering right now. Would you recommend doing it in this PR itself?

soloestoy · 2025-02-11T03:22:39Z

@soloestoy it doesn't support negative filtering right now. Would you recommend doing it in this PR itself?

that would be very appreciated :)

sarthakaggarwal97 · 2025-02-11T20:01:58Z

@soloestoy do we want negative filtering only for flags or every other filter? Also, how would you recommend the filter command should look like with negation?

hpatro

Mostly LGTM.

src/networking.c

tests/unit/introspection.tcl

Signed-off-by: Sarthak Aggarwal <[email protected]>

Signed-off-by: Harkrishn Patro <[email protected]>

Co-authored-by: Madelyn Olson <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]>

Signed-off-by: Harkrishn Patro <[email protected]>

Signed-off-by: Sarthak Aggarwal <[email protected]>

hpatro · 2025-04-14T23:09:45Z

Great work @sarthakaggarwal97! It's merged now. 🎉

hpatro · 2025-04-14T23:34:49Z

@sarthakaggarwal97 Please submit the doc PR.

Documentation for additional filters introduced in valkey-io/valkey#1466 Signed-off-by: Sarthak Aggarwal <[email protected]>

sarthakaggarwal97 · 2025-04-16T17:59:16Z

@hpatro Doc PR has been merged, thank you

…1466) In this PR, we introduce support for new filters for `CLIENT LIST` and `CLIENT KILL` commands. The new filters are: 1. FLAGS `Client must include this flag. This can be a string with bunch of flags present one after the other.` 2. NAME `client name` 3. IDLE `minimum idle time of the client` 4. LIB-NAME `clients with the specified lib name.` 5. LIB-VER `clients with the specified lib version.` 6. DB `clients currently operating on the specified database ID` 7. IP `client ip address` 8. CAPA `client capabilities` Partly Addresses: valkey-io#668 --------- Signed-off-by: Sarthak Aggarwal <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Madelyn Olson <[email protected]> Signed-off-by: Nitai Caro <[email protected]>

…1466) In this PR, we introduce support for new filters for `CLIENT LIST` and `CLIENT KILL` commands. The new filters are: 1. FLAGS `Client must include this flag. This can be a string with bunch of flags present one after the other.` 2. NAME `client name` 3. IDLE `minimum idle time of the client` 4. LIB-NAME `clients with the specified lib name.` 5. LIB-VER `clients with the specified lib version.` 6. DB `clients currently operating on the specified database ID` 7. IP `client ip address` 8. CAPA `client capabilities` Partly Addresses: valkey-io#668 --------- Signed-off-by: Sarthak Aggarwal <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Madelyn Olson <[email protected]>

…1466) In this PR, we introduce support for new filters for `CLIENT LIST` and `CLIENT KILL` commands. The new filters are: 1. FLAGS `Client must include this flag. This can be a string with bunch of flags present one after the other.` 2. NAME `client name` 3. IDLE `minimum idle time of the client` 4. LIB-NAME `clients with the specified lib name.` 5. LIB-VER `clients with the specified lib version.` 6. DB `clients currently operating on the specified database ID` 7. IP `client ip address` 8. CAPA `client capabilities` Partly Addresses: valkey-io#668 --------- Signed-off-by: Sarthak Aggarwal <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Madelyn Olson <[email protected]> Signed-off-by: hwware <[email protected]>

…1466) In this PR, we introduce support for new filters for `CLIENT LIST` and `CLIENT KILL` commands. The new filters are: 1. FLAGS `Client must include this flag. This can be a string with bunch of flags present one after the other.` 2. NAME `client name` 3. IDLE `minimum idle time of the client` 4. LIB-NAME `clients with the specified lib name.` 5. LIB-VER `clients with the specified lib version.` 6. DB `clients currently operating on the specified database ID` 7. IP `client ip address` 8. CAPA `client capabilities` Partly Addresses: valkey-io#668 --------- Signed-off-by: Sarthak Aggarwal <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Harkrishn Patro <[email protected]> Co-authored-by: Madelyn Olson <[email protected]> Signed-off-by: charsyam <[email protected]>

Signed-off-by: Kyle J. Davis <[email protected]>

sarthakaggarwal97 force-pushed the client-extended-filters branch from 6819a68 to c913dcb Compare December 20, 2024 16:36

sarthakaggarwal97 marked this pull request as ready for review December 20, 2024 16:59

sarthakaggarwal97 force-pushed the client-extended-filters branch 3 times, most recently from 094ee75 to e518d93 Compare December 20, 2024 19:49

sarthakaggarwal97 force-pushed the client-extended-filters branch from e518d93 to b5cb71d Compare December 20, 2024 21:51

sarthakaggarwal97 mentioned this pull request Dec 20, 2024

[Client Introspection] Client Count Command #1467

Closed

sarthakaggarwal97 requested review from hpatro and zuiderkwast December 31, 2024 17:07

sarthakaggarwal97 force-pushed the client-extended-filters branch 4 times, most recently from f7ad3a7 to e3fdff0 Compare January 15, 2025 22:14

zuiderkwast added the major-decision-pending Major decision pending by TSC team label Jan 15, 2025

sarthakaggarwal97 force-pushed the client-extended-filters branch 4 times, most recently from 92f685b to c843fb9 Compare January 22, 2025 00:26

sarthakaggarwal97 mentioned this pull request Jan 27, 2025

Extended Valkey client introspection functionality #668

Open

3 tasks

hpatro assigned sarthakaggarwal97 Feb 7, 2025

zuiderkwast reviewed Feb 7, 2025

View reviewed changes

src/networking.c Outdated Show resolved Hide resolved

src/networking.c Outdated Show resolved Hide resolved

src/networking.c Show resolved Hide resolved

hpatro reviewed Feb 11, 2025

View reviewed changes

src/networking.c Outdated Show resolved Hide resolved

tests/unit/introspection.tcl Outdated Show resolved Hide resolved

tests/unit/introspection.tcl Show resolved Hide resolved

sarthakaggarwal97 force-pushed the client-extended-filters branch from c843fb9 to 0ed63c7 Compare March 17, 2025 23:08

sarthakaggarwal97 and others added 12 commits April 14, 2025 13:50

removing total-net-in total-net-out filters

bc355eb

Signed-off-by: Sarthak Aggarwal <[email protected]>

minor nits

ecf51b5

Signed-off-by: Sarthak Aggarwal <[email protected]>

supporting capa and ip filter

1347cdb

Signed-off-by: Sarthak Aggarwal <[email protected]>

help command update

4d71b74

Signed-off-by: Sarthak Aggarwal <[email protected]>

nit fix

98cc88e

Signed-off-by: Sarthak Aggarwal <[email protected]>

ip filter fix

7699f5d

Signed-off-by: Sarthak Aggarwal <[email protected]>

addressing comments

bb8832a

Signed-off-by: Sarthak Aggarwal <[email protected]>

Cleanup idle time filter

ce6af68

Signed-off-by: Harkrishn Patro <[email protected]>

Fix filter by db test

139050b

Signed-off-by: Harkrishn Patro <[email protected]>

Update src/networking.c

0d59586

Co-authored-by: Madelyn Olson <[email protected]> Signed-off-by: Harkrishn Patro <[email protected]>

Set client filters to NULL after free

a670bfc

Signed-off-by: Harkrishn Patro <[email protected]>

tls test fix

4b7d0d7

Signed-off-by: Sarthak Aggarwal <[email protected]>

sarthakaggarwal97 force-pushed the client-extended-filters branch from dd7af47 to 4b7d0d7 Compare April 14, 2025 20:50

hpatro merged commit be60586 into valkey-io:unstable Apr 14, 2025
58 of 59 checks passed

github-project-automation bot moved this from Optional for next release candidate to Done in Valkey 9.0 Apr 14, 2025

sarthakaggarwal97 mentioned this pull request Apr 15, 2025

Documentation for Additional Client Filters valkey-io/valkey-doc#262

Merged

zuiderkwast pushed a commit to valkey-io/valkey-doc that referenced this pull request Apr 16, 2025

Documentation for Additional Client Filters (#262)

bedeb0a

Documentation for additional filters introduced in valkey-io/valkey#1466 Signed-off-by: Sarthak Aggarwal <[email protected]>

zuiderkwast removed the needs-doc-pr This change needs to update a documentation page. Remove label once doc PR is open. label Apr 16, 2025

zuiderkwast removed the to-be-merged Almost ready to merge label May 27, 2025

hpatro mentioned this pull request Aug 13, 2025

Valkey 9.0.0-rc1 release notes and version.h bump #2476

Merged

stockholmux added a commit to stockholmux/valkey that referenced this pull request Aug 13, 2025

adds valkey-io#1466 and valkey-io#2174

300e8ee

Signed-off-by: Kyle J. Davis <[email protected]>

zvi-code mentioned this pull request Sep 10, 2025

Capture 1.1.0 work items needed for Valkey 9.0 valkey-io/valkey-search#364

Closed

[Client Introspection] Client Commands Extended Filtering #1466

[Client Introspection] Client Commands Extended Filtering #1466

Uh oh!

Conversation

sarthakaggarwal97 commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

sarthakaggarwal97 commented Jan 22, 2025

Uh oh!

sarthakaggarwal97 commented Feb 7, 2025

Uh oh!

zuiderkwast left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soloestoy commented Feb 10, 2025

Uh oh!

sarthakaggarwal97 commented Feb 10, 2025

Uh oh!

soloestoy commented Feb 11, 2025

Uh oh!

sarthakaggarwal97 commented Feb 11, 2025

Uh oh!

hpatro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hpatro commented Apr 14, 2025

Uh oh!

hpatro commented Apr 14, 2025

Uh oh!

sarthakaggarwal97 commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

sarthakaggarwal97 commented Dec 20, 2024 •

edited

Loading

codecov bot commented Dec 20, 2024 •

edited

Loading

sarthakaggarwal97 commented Apr 16, 2025 •

edited

Loading