https://github.com/hueristiq/hq-go-retrier
A Go (Golang) package designed to manage retries for operations that might temporarily fail. It allows developers to customize how retries are handled using different strategies, such as increasing the wait time between each attempt - backoffs and jitters.
https://github.com/hueristiq/hq-go-retrier
backoff backoff-algorithm backoff-algorithms backoff-strategy go golang golang-package jitter retry
Last synced: 2 months ago
JSON representation
A Go (Golang) package designed to manage retries for operations that might temporarily fail. It allows developers to customize how retries are handled using different strategies, such as increasing the wait time between each attempt - backoffs and jitters.
- Host: GitHub
- URL: https://github.com/hueristiq/hq-go-retrier
- Owner: hueristiq
- License: mit
- Created: 2024-09-29T18:35:43.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T11:10:05.000Z (8 months ago)
- Last Synced: 2024-10-25T03:44:08.727Z (8 months ago)
- Topics: backoff, backoff-algorithm, backoff-algorithms, backoff-strategy, go, golang, golang-package, jitter, retry
- Language: Go
- Homepage: https://pkg.go.dev/github.com/hueristiq/hq-go-retrier
- Size: 31.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# hq-go-retrier
 [](https://goreportcard.com/report/github.com/hueristiq/hq-go-retrier) [](https://github.com/hueristiq/hq-go-retrier/blob/master/LICENSE)  [](https://github.com/hueristiq/hq-go-retrier/issues?q=is:issue+is:open) [](https://github.com/hueristiq/hq-go-retrier/issues?q=is:issue+is:closed) [](https://github.com/hueristiq/hq-go-retrier/blob/master/CONTRIBUTING.md)
`hq-go-retrier` is a [Go (Golang)](http://golang.org/) package for managing retries for operations that might temporarily fail. It provides a flexible and configurable retry mechanism that allows developers to define how many times an operation should be retried, set minimum and maximum delays between attempts, and even choose from various backoff and jitter strategies to avoid overwhelming your systems during high load or in distributed environments.
## Resource
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Basic Retry](#basic-retry)
- [Retry With Data](#retry-with-data)
- [Contributing](#contributing)
- [Licensing](#licensing)
## Features
- **Configurable Retry Mechanism:** Supports number of retries, as well as the delay between retries configuration.
- **Flexible Backoff Strategies:** Supports various backoffs strategies to dynamically increase the wait time between retries.
- **Context Support:** Supports Go's `context`, enabling graceful cancellation and timeout management.
- **Data Handling:** In addition to simple error retries, it supports operations that return data once they succeeds.
- **Notifier Callback:** Supports defination of a notifier callback to receive real-time notifications on each retry attempt.
## Installation
To install `hq-go-retrier`, run:
```bash
go get -v -u github.com/hueristiq/hq-go-retrier
```
Make sure your Go environment is set up properly (Go 1.x or later is recommended).
## Usage
### Basic Retry
For operations that simply return an error, you can use the `Retry` function:
```go
package main
import (
"context"
"fmt"
"time"
hqgoretrier "github.com/hueristiq/hq-go-retrier"
"github.com/hueristiq/hq-go-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 := hqgoretrier.Retry(ctx, operation,
hqgoretrier.WithRetryMax(5),
hqgoretrier.WithRetryWaitMin(100*time.Millisecond),
hqgoretrier.WithRetryWaitMax(2*time.Second),
hqgoretrier.WithRetryBackoff(backoff.ExponentialWithFullJitter()),
hqgoretrier.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!")
}
}
```
### Retry With Data
For operations that return both data and an error, `RetryWithData` ensures that you can retrieve the data once the operation finally succeeds:
```go
package main
import (
"context"
"fmt"
"time"
hqgoretrier "github.com/hueristiq/hq-go-retrier"
"github.com/hueristiq/hq-go-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 := hqgoretrier.RetryWithData(ctx, fetchData,
hqgoretrier.WithRetryMax(5),
hqgoretrier.WithRetryWaitMin(200*time.Millisecond),
hqgoretrier.WithRetryWaitMax(3*time.Second),
hqgoretrier.WithRetryBackoff(backoff.Exponential()),
hqgoretrier.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)
}
```
## Contributing
Contributions are welcome and encouraged! Feel free to submit [Pull Requests](https://github.com/hueristiq/hq-go-retrier/pulls) or report [Issues](https://github.com/hueristiq/hq-go-retrier/issues). For more details, check out the [contribution guidelines](https://github.com/hueristiq/hq-go-retrier/blob/master/CONTRIBUTING.md).
A big thank you to all the [contributors](https://github.com/hueristiq/hq-go-retrier/graphs/contributors) for your ongoing support!
## Licensing
This package is licensed under the [MIT license](https://opensource.org/license/mit). 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](https://github.com/hueristiq/hq-go-retrier/blob/master/LICENSE).