feat: add optional logger wherever possible #3560
+277
−110
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,7 +103,7 @@ func (cb *CircuitBreaker) Execute(fn func() error) error { | |
| cb.requests.Store(0) | ||
| cb.successes.Store(0) | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| cb.logf(context.Background(), logs.CircuitBreakerTransitioningToHalfOpen(cb.endpoint)) | ||
| } | ||
| // Fall through to half-open logic | ||
| } else { | ||
|
|
@@ -145,15 +145,15 @@ func (cb *CircuitBreaker) recordFailure() { | |
| if failures >= int64(cb.failureThreshold) { | ||
| if cb.state.CompareAndSwap(int32(CircuitBreakerClosed), int32(CircuitBreakerOpen)) { | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| cb.logf(context.Background(), logs.CircuitBreakerOpened(cb.endpoint, failures)) | ||
| } | ||
| } | ||
| } | ||
| case CircuitBreakerHalfOpen: | ||
| // Any failure in half-open state immediately opens the circuit | ||
| if cb.state.CompareAndSwap(int32(CircuitBreakerHalfOpen), int32(CircuitBreakerOpen)) { | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| cb.logf(context.Background(), logs.CircuitBreakerReopened(cb.endpoint)) | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -177,7 +177,7 @@ func (cb *CircuitBreaker) recordSuccess() { | |
| if cb.state.CompareAndSwap(int32(CircuitBreakerHalfOpen), int32(CircuitBreakerClosed)) { | ||
| cb.failures.Store(0) | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| cb.logf(context.Background(), logs.CircuitBreakerClosed(cb.endpoint, successes)) | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -202,6 +202,14 @@ func (cb *CircuitBreaker) GetStats() CircuitBreakerStats { | |
| } | ||
| } | ||
|
|
||
| func (cb *CircuitBreaker) logf(ctx context.Context, format string, args ...interface{}) { | ||
| logger := internal.Logger | ||
| if cb.config != nil && cb.config.Logger != nil { | ||
| logger = *cb.config.Logger | ||
| } | ||
| logger.Printf(ctx, format, args...) | ||
| } | ||
|
|
||
| // CircuitBreakerStats provides statistics about a circuit breaker | ||
| type CircuitBreakerStats struct { | ||
| Endpoint string | ||
|
|
@@ -326,7 +334,7 @@ func (cbm *CircuitBreakerManager) cleanup() { | |
|
|
||
| // Log cleanup results | ||
| if len(toDelete) > 0 && internal.LogLevel.InfoOrAbove() { | ||
| cbm.logf(context.Background(), logs.CircuitBreakerCleanup(len(toDelete), count)) | ||
| } | ||
|
|
||
| cbm.lastCleanup.Store(now.Unix()) | ||
|
|
@@ -351,3 +359,11 @@ func (cbm *CircuitBreakerManager) Reset() { | |
| return true | ||
| }) | ||
| } | ||
|
|
||
| func (cbm *CircuitBreakerManager) logf(ctx context.Context, format string, args ...interface{}) { | ||
| logger := internal.Logger | ||
| if cbm.config != nil && cbm.config.Logger != nil { | ||
| logger = *cbm.config.Logger | ||
| } | ||
| logger.Printf(ctx, format, args...) | ||
| } | ||
|
Comment on lines
+362
to
+369
There was a problem hiding this comment. Consider changing this similarly to the previous note about |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -128,6 +128,9 @@ type Config struct { | |||||||||||||
| // After this many retries, the connection will be removed from the pool. | ||||||||||||||
| // Default: 3 | ||||||||||||||
| MaxHandoffRetries int | ||||||||||||||
|
|
||||||||||||||
| // Logger is an optional custom logger for maintenance notifications. | ||||||||||||||
| Logger *internal.Logging | ||||||||||||||
|
Comment on lines
+131
to
+133
There was a problem hiding this comment.
Suggested change
|
||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| func (c *Config) IsEnabled() bool { | ||||||||||||||
|
|
@@ -341,6 +344,8 @@ func (c *Config) Clone() *Config { | |||||||||||||
|
|
||||||||||||||
| // Configuration fields | ||||||||||||||
| MaxHandoffRetries: c.MaxHandoffRetries, | ||||||||||||||
|
|
||||||||||||||
| Logger: c.Logger, | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -121,7 +121,7 @@ func (hwm *handoffWorkerManager) onDemandWorker() { | |
| defer func() { | ||
| // Handle panics to ensure proper cleanup | ||
| if r := recover(); r != nil { | ||
| hwm.logf(context.Background(), logs.WorkerPanicRecovered(r)) | ||
| } | ||
|
|
||
| // Decrement active worker count when exiting | ||
|
|
@@ -146,21 +146,21 @@ func (hwm *handoffWorkerManager) onDemandWorker() { | |
| select { | ||
| case <-hwm.shutdown: | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| hwm.logf(context.Background(), logs.WorkerExitingDueToShutdown()) | ||
| } | ||
| return | ||
| case <-timer.C: | ||
| // Worker has been idle for too long, exit to save resources | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| hwm.logf(context.Background(), logs.WorkerExitingDueToInactivityTimeout(hwm.workerTimeout)) | ||
| } | ||
| return | ||
| case request := <-hwm.handoffQueue: | ||
| // Check for shutdown before processing | ||
| select { | ||
| case <-hwm.shutdown: | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| hwm.logf(context.Background(), logs.WorkerExitingDueToShutdownWhileProcessing()) | ||
| } | ||
| // Clean up the request before exiting | ||
| hwm.pending.Delete(request.ConnID) | ||
|
|
@@ -178,7 +178,7 @@ func (hwm *handoffWorkerManager) processHandoffRequest(request HandoffRequest) { | |
| // Remove from pending map | ||
| defer hwm.pending.Delete(request.Conn.GetID()) | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| hwm.logf(context.Background(), logs.HandoffStarted(request.Conn.GetID(), request.Endpoint)) | ||
| } | ||
|
|
||
| // Create a context with handoff timeout from config | ||
|
|
@@ -226,12 +226,12 @@ func (hwm *handoffWorkerManager) processHandoffRequest(request HandoffRequest) { | |
| if hwm.config != nil { | ||
| maxRetries = hwm.config.MaxHandoffRetries | ||
| } | ||
| hwm.logf(context.Background(), logs.HandoffFailed(request.ConnID, request.Endpoint, currentRetries, maxRetries, err)) | ||
| } | ||
| time.AfterFunc(afterTime, func() { | ||
| if err := hwm.queueHandoff(request.Conn); err != nil { | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| hwm.logf(context.Background(), logs.CannotQueueHandoffForRetry(err)) | ||
| } | ||
| hwm.closeConnFromRequest(context.Background(), request, err) | ||
| } | ||
|
|
@@ -259,7 +259,7 @@ func (hwm *handoffWorkerManager) queueHandoff(conn *pool.Conn) error { | |
| // if shouldHandoff is false and retries is 0, then we are not retrying and not do a handoff | ||
| if !shouldHandoff && conn.HandoffRetries() == 0 { | ||
| if internal.LogLevel.InfoOrAbove() { | ||
| hwm.logf(context.Background(), logs.ConnectionNotMarkedForHandoff(conn.GetID())) | ||
| } | ||
| return errors.New(logs.ConnectionNotMarkedForHandoffError(conn.GetID())) | ||
| } | ||
|
|
@@ -302,7 +302,7 @@ func (hwm *handoffWorkerManager) queueHandoff(conn *pool.Conn) error { | |
| queueLen := len(hwm.handoffQueue) | ||
| queueCap := cap(hwm.handoffQueue) | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| hwm.logf(context.Background(), logs.HandoffQueueFull(queueLen, queueCap)) | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -356,7 +356,7 @@ func (hwm *handoffWorkerManager) performConnectionHandoff(ctx context.Context, c | |
|
|
||
| // Check if circuit breaker is open before attempting handoff | ||
| if circuitBreaker.IsOpen() { | ||
| hwm.logf(ctx, logs.CircuitBreakerOpen(connID, newEndpoint)) | ||
| return false, ErrCircuitBreakerOpen // Don't retry when circuit breaker is open | ||
| } | ||
|
|
||
|
|
@@ -385,15 +385,15 @@ func (hwm *handoffWorkerManager) performHandoffInternal( | |
| connID uint64, | ||
| ) (shouldRetry bool, err error) { | ||
| retries := conn.IncrementAndGetHandoffRetries(1) | ||
| hwm.logf(ctx, logs.HandoffRetryAttempt(connID, retries, newEndpoint, conn.RemoteAddr().String())) | ||
| maxRetries := 3 // Default fallback | ||
| if hwm.config != nil { | ||
| maxRetries = hwm.config.MaxHandoffRetries | ||
| } | ||
|
|
||
| if retries > maxRetries { | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| hwm.logf(ctx, logs.ReachedMaxHandoffRetries(connID, newEndpoint, maxRetries)) | ||
| } | ||
| // won't retry on ErrMaxHandoffRetriesReached | ||
| return false, ErrMaxHandoffRetriesReached | ||
|
|
@@ -405,7 +405,7 @@ func (hwm *handoffWorkerManager) performHandoffInternal( | |
| // Create new connection to the new endpoint | ||
| newNetConn, err := endpointDialer(ctx) | ||
| if err != nil { | ||
| hwm.logf(ctx, logs.FailedToDialNewEndpoint(connID, newEndpoint, err)) | ||
| // will retry | ||
| // Maybe a network error - retry after a delay | ||
| return true, err | ||
|
|
@@ -425,7 +425,7 @@ func (hwm *handoffWorkerManager) performHandoffInternal( | |
| conn.SetRelaxedTimeoutWithDeadline(relaxedTimeout, relaxedTimeout, deadline) | ||
|
|
||
| if internal.LogLevel.InfoOrAbove() { | ||
| hwm.logf(context.Background(), logs.ApplyingRelaxedTimeoutDueToPostHandoff(connID, relaxedTimeout, deadline.Format("15:04:05.000"))) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -447,7 +447,7 @@ func (hwm *handoffWorkerManager) performHandoffInternal( | |
| // - clear the handoff state (shouldHandoff, endpoint, seqID) | ||
| // - reset the handoff retries to 0 | ||
| conn.ClearHandoffState() | ||
| hwm.logf(ctx, logs.HandoffSucceeded(connID, newEndpoint)) | ||
|
|
||
| // successfully completed the handoff, no retry needed and no error | ||
| return false, nil | ||
|
|
@@ -478,15 +478,23 @@ func (hwm *handoffWorkerManager) closeConnFromRequest(ctx context.Context, reque | |
| if pooler != nil { | ||
| pooler.Remove(ctx, conn, err) | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| hwm.logf(ctx, logs.RemovingConnectionFromPool(conn.GetID(), err)) | ||
| } | ||
| } else { | ||
| err := conn.Close() // Close the connection if no pool provided | ||
| if err != nil { | ||
| hwm.logf(ctx, "redis: failed to close connection: %v", err) | ||
| } | ||
| if internal.LogLevel.WarnOrAbove() { | ||
| hwm.logf(ctx, logs.NoPoolProvidedCannotRemove(conn.GetID(), err)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (hwm *handoffWorkerManager) logf(ctx context.Context, format string, args ...interface{}) { | ||
| logger := internal.Logger | ||
| if hwm.config != nil && hwm.config.Logger != nil { | ||
| logger = *hwm.config.Logger | ||
| } | ||
| logger.Printf(ctx, format, args...) | ||
| } | ||
|
Comment on lines
+493
to
+500
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this a pointer to an
interface? I the type should be the interface itself.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would have preferred to do not.
I'm unsure why I came to this.
I'll check.