hq-go-retrier is a Go (Golang) package for managing retries for operations that might temporarily fail. It allows you to easily implement retry logic with customizable parameters such as the number of retries, delays between retries, backoff strategies, and notifications on retry attempts.
- Configurable Retry Mechanism: Customize the maximum number of retries, as well as the delay durations between retries.
- Flexible Backoff Strategies: Choose from various backoff and jitter strategies.
- Context Support: Integrates with Go's context package to support cancellation and timeouts.
- Data Handling: Use retry functions for both simple error-handling and operations that return valuable data.
- Notifier Callback: Get real-time notifications on each retry attempt to log errors or trigger custom actions.
To install hq-go-retrier, run:
go get -v -u go.source.hueristiq.com/retrierMake sure your Go environment is set up properly (Go 1.x or later is recommended).
The simplest usage of hq-go-retrier is to retry an operation that only returns an error. Use the Retry function along with any optional configuration options:
package main
import (
"context"
"fmt"
"time"
"go.source.hueristiq.com/retrier"
"go.source.hueristiq.com/retrier/backoff"
)
func main() {
operation := func() error {
return fmt.Errorf("an error occurred")
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
err := retrier.Retry(ctx, operation,
retrier.WithRetryMax(5),
retrier.WithRetryWaitMin(100*time.Millisecond),
retrier.WithRetryWaitMax(2*time.Second),
retrier.WithRetryBackoff(backoff.ExponentialWithFullJitter()),
retrier.WithNotifier(func(err error, b time.Duration) {
fmt.Printf("Retry due to error: %v. Next attempt in %v.\n", err, b)
}),
)
if err != nil {
fmt.Printf("Operation failed after retries: %v\n", err)
} else {
fmt.Println("Operation succeeded!")
}
}If the operation returns data along with an error, use RetryWithData. This function allows to obtain the result from the operation once it succeeds.
package main
import (
"context"
"fmt"
"time"
"go.source.hueristiq.com/retrier"
"go.source.hueristiq.com/retrier/backoff"
)
func fetchData() (string, error) {
return "", fmt.Errorf("failed to fetch data")
}
func main() {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result, err := retrier.RetryWithData(ctx, fetchData,
retrier.WithRetryMax(5),
retrier.WithRetryWaitMin(200*time.Millisecond),
retrier.WithRetryWaitMax(3*time.Second),
retrier.WithRetryBackoff(backoff.Exponential()),
retrier.WithNotifier(func(err error, b time.Duration) {
fmt.Printf("Retrying after error: %v, waiting: %v\n", err, b)
}),
)
if err != nil {
fmt.Printf("Failed to fetch data after retries: %v\n", err)
return
}
fmt.Printf("Data fetched successfully: %s\n", result)
}Contributions are welcome and encouraged! Feel free to submit Pull Requests or report Issues. For more details, check out the contribution guidelines.
A big thank you to all the contributors for your support!
This package is licensed under the MIT license. You are free to use, modify, and distribute it, as long as you follow the terms of the license. You can find the full license text in the repository - Full MIT license text.