s/hitless/maintnotifications/

Author: ndyakov

example/pubsub/main.go

@@ -19,7 +19,7 @@ var cntSuccess atomic.Int64
 var startTime = time.Now()
 
 // This example is not supposed to be run as is. It is just a test to see how pubsub behaves in relation to pool management.
-// It was used to find regressions in pool management in hitless mode.
+// It was used to find regressions in pool management in maintnotifications mode.
 // Please don't use it as a reference for how to use pubsub.
 func main() {
 	startTime = time.Now()
@@ -35,12 +35,12 @@ func main() {
 		},
 	})
 	_ = rdb.FlushDB(ctx).Err()
-	hitlessManager := rdb.GetMaintNotificationsManager()
-	if hitlessManager == nil {
-		panic("hitless manager is nil")
+	maintnotificationsManager := rdb.GetMaintNotificationsManager()
+	if maintnotificationsManager == nil {
+		panic("maintnotifications manager is nil")
 	}
 	loggingHook := maintnotifications.NewLoggingHook(int(logging.LogLevelDebug))
-	hitlessManager.AddNotificationHook(loggingHook)
+	maintnotificationsManager.AddNotificationHook(loggingHook)
 
 	go func() {
 		for {

internal/interfaces/interfaces.go

@@ -1,5 +1,5 @@
 // Package interfaces provides shared interfaces used by both the main redis package
-// and the hitless upgrade package to avoid circular dependencies.
+// and the maintnotifications upgrade package to avoid circular dependencies.
 package interfaces
 
 import (
@@ -16,7 +16,7 @@ type NotificationProcessor interface {
 	GetHandler(pushNotificationName string) interface{}
 }
 
-// ClientInterface defines the interface that clients must implement for hitless upgrades.
+// ClientInterface defines the interface that clients must implement for maintnotifications upgrades.
 type ClientInterface interface {
 	// GetOptions returns the client options.
 	GetOptions() OptionsInterface

internal/maintnotifications/logs/log_messages.go

@@ -615,7 +615,7 @@ func CircuitBreakerCleanup(removed int, total int) string {
 	return fmt.Sprintf("%s removed %d/%d entries %s", CircuitBreakerCleanupMessage, removed, total, string(data))
 }
 
-// ExtractDataFromLogMessage extracts structured data from hitless log messages
+// ExtractDataFromLogMessage extracts structured data from maintnotifications log messages
 // Returns a map containing the parsed key-value pairs from the structured data section
 // Example: "conn[123] handoff started to localhost:6379 {"connID":123,"endpoint":"localhost:6379"}"
 // Returns: map[string]interface{}{"connID": 123, "endpoint": "localhost:6379"}

maintnotifications/README.md

@@ -1,38 +1,40 @@
-# Hitless Upgrades
+# Maintenance Notifications
 
-Seamless Redis connection handoffs during cluster changes without dropping connections.
+Seamless Redis connection handoffs during cluster maintenance operations without dropping connections.
+
+## ⚠️ **Important Note**
+**Maintenance notifications are currently supported only in standalone Redis clients.** Cluster clients (ClusterClient, FailoverClient, etc.) do not yet support this functionality.
 
 ## Quick Start
 
 ```go
 client := redis.NewClient(&redis.Options{
     Addr:     "localhost:6379",
     Protocol: 3, // RESP3 required
-    HitlessUpgrades: &hitless.Config{
-        Mode: hitless.ModeEnabled,
+    MaintNotifications: &maintnotifications.Config{
+        Mode: maintnotifications.ModeEnabled,
     },
 })
 ```
 
 ## Modes
 
-- **`ModeDisabled`** - Hitless upgrades disabled
+- **`ModeDisabled`** - Maintenance notifications disabled
 - **`ModeEnabled`** - Forcefully enabled (fails if server doesn't support)
 - **`ModeAuto`** - Auto-detect server support (default)
 
 ## Configuration
 
 ```go
-&hitless.Config{
-    Mode:                       hitless.ModeAuto,
-    EndpointType:               hitless.EndpointTypeAuto,
+&maintnotifications.Config{
+    Mode:                       maintnotifications.ModeAuto,
+    EndpointType:               maintnotifications.EndpointTypeAuto,
     RelaxedTimeout:             10 * time.Second,
     HandoffTimeout:             15 * time.Second,
     MaxHandoffRetries:          3,
     MaxWorkers:                 0,    // Auto-calculated
     HandoffQueueSize:           0,    // Auto-calculated
     PostHandoffRelaxedDuration: 0,    // 2 * RelaxedTimeout
-    LogLevel:                   logging.LogLevelError,
 }
 ```
 
@@ -56,7 +58,7 @@ client := redis.NewClient(&redis.Options{
 
 ## How It Works
 
-1. Redis sends push notifications about cluster changes
+1. Redis sends push notifications about cluster maintenance operations
 2. Client creates new connections to updated endpoints
 3. Active operations transfer to new connections
 4. Old connections close gracefully
@@ -71,7 +73,7 @@ client := redis.NewClient(&redis.Options{
 
 ## Hooks (Optional)
 
-Monitor and customize hitless operations:
+Monitor and customize maintenance notification operations:
 
 ```go
 type NotificationHook interface {
@@ -87,7 +89,7 @@ manager.AddNotificationHook(&MyHook{})
 
 ```go
 // Create metrics hook
-metricsHook := hitless.NewMetricsHook()
+metricsHook := maintnotifications.NewMetricsHook()
 manager.AddNotificationHook(metricsHook)
 
 // Access collected metrics

maintnotifications/e2e/notiftracker_test.go

@@ -236,11 +236,11 @@ func setupNotificationHooks(client redis.UniversalClient, hooks ...maintnotifica
 
 // setupRegularClientNotificationHook sets up notification hook for regular clients
 func setupRegularClientNotificationHook(client *redis.Client, hook maintnotifications.NotificationHook) {
-	hitlessManager := client.GetMaintNotificationsManager()
-	if hitlessManager != nil {
-		hitlessManager.AddNotificationHook(hook)
+	maintnotificationsManager := client.GetMaintNotificationsManager()
+	if maintnotificationsManager != nil {
+		maintnotificationsManager.AddNotificationHook(hook)
 	} else {
-		fmt.Printf("[TNH] Warning: Hitless manager not available for tracking\n")
+		fmt.Printf("[TNH] Warning: Maintenance notifications manager not available for tracking\n")
 	}
 }
 
@@ -250,11 +250,11 @@ func setupClusterClientNotificationHook(client *redis.ClusterClient, hook maintn
 
 	// Register hook on existing nodes
 	err := client.ForEachShard(ctx, func(ctx context.Context, nodeClient *redis.Client) error {
-		hitlessManager := nodeClient.GetMaintNotificationsManager()
-		if hitlessManager != nil {
-			hitlessManager.AddNotificationHook(hook)
+		maintnotificationsManager := nodeClient.GetMaintNotificationsManager()
+		if maintnotificationsManager != nil {
+			maintnotificationsManager.AddNotificationHook(hook)
 		} else {
-			fmt.Printf("[TNH] Warning: Hitless manager not available for tracking on node: %s\n", nodeClient.Options().Addr)
+			fmt.Printf("[TNH] Warning: Maintenance notifications manager not available for tracking on node: %s\n", nodeClient.Options().Addr)
 		}
 		return nil
 	})
@@ -265,11 +265,11 @@ func setupClusterClientNotificationHook(client *redis.ClusterClient, hook maintn
 
 	// Register hook on new nodes
 	client.OnNewNode(func(nodeClient *redis.Client) {
-		hitlessManager := nodeClient.GetMaintNotificationsManager()
-		if hitlessManager != nil {
-			hitlessManager.AddNotificationHook(hook)
+		maintnotificationsManager := nodeClient.GetMaintNotificationsManager()
+		if maintnotificationsManager != nil {
+			maintnotificationsManager.AddNotificationHook(hook)
 		} else {
-			fmt.Printf("[TNH] Warning: Hitless manager not available for tracking on new node: %s\n", nodeClient.Options().Addr)
+			fmt.Printf("[TNH] Warning: Maintenance notifications manager not available for tracking on new node: %s\n", nodeClient.Options().Addr)
 		}
 	})
 }