microsoft/garnet

Support for keyspace notifications

Open

#915 opened on Jan 14, 2025

View on GitHub
 (3 comments) (4 reactions) (0 assignees)C# (11,827 stars) (660 forks)batch import
enhancementhelp wanted

Description

Feature request type

enhancement

Is your feature request related to a problem? Please describe

Keyspace notifications allow clients to subscribe to Pub/Sub channels in order to receive events affecting the Garnet data set in some way.

Describe the solution you'd like

We already have PubSub support, but it is only for user defined channels. It will be nice to support keyspace notification as described here.

Describe alternatives you've considered

N/A

Additional context

No response

Contributor guide

Tech stack
csharpredis
Domain
backenddatabaseapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Redis keyspace notificationsFamiliarity with Garnet's PubSub implementationRedis protocol knowledgeBasic C# experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the existing PubSub implementation in Garnet to understand how channels are managed and messages published. Then implement keyspace notifications as described in Redis documentation (https://redis.io/docs/latest/develop/use/keyspace notifications/). Focus on subscribing to keyspace and keyevent channels and emitting events on data changes. Consider adding a configuration option to enable/disable notifications and to specify which events to notify.