https://github.com/keisku/retry

⏳A simple retry library provides constant, jitter and exponential backoff algorithms⌛️
https://github.com/keisku/retry

go golang

Last synced: 28 days ago
JSON representation

⏳A simple retry library provides constant, jitter and exponential backoff algorithms⌛️

• Host: GitHub
• URL: https://github.com/keisku/retry
• Owner: keisku
• License: mit
• Created: 2022-02-02T13:57:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-21T13:48:37.000Z (over 2 years ago)
• Last Synced: 2023-09-05T02:40:39.817Z (about 1 year ago)
• Topics: go, golang
• Language: Go
• Homepage: https://pkg.go.dev/github.com/kei6u/retry
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# retry

[![.github/workflows/test.yaml](https://github.com/keisku/retry/actions/workflows/test.yaml/badge.svg)](https://github.com/keisku/retry/actions/workflows/test.yaml)

[![GoDoc](https://godoc.org/github.com/keisku/retry?status.svg&style=flat-square)](http://godoc.org/github.com/keisku/retry)

This Go library is made from only standard libraries and provides retry functionality for general operations.

You can choose a retry algorithm from constant intervals, decorrelated jitter algorithm, exponential backoff algorithm.

## Motivation

- I would like to use retry algorithms inspired by [Exponential Backoff And Jitter | AWS Architecture Blog](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) in Go.

- A number of [retry library](https://pkg.go.dev/search?q=retry&m=package) are already available for Go, but I wanted more straightforward API.

## Use cases

Here are some possible use cases.

- When the database returns internal errors, your application will retry to run SQL with this library.

- When the API returns 5xx errors, your application will retry to call it with this library.

## Usage

See the [document](https://pkg.go.dev/github.com/keisku/retry) and run [examples](https://pkg.go.dev/github.com/keisku/retry#pkg-examples).

```bash

go get github.com/keisku/retry

```

```go

r := retry.New(retry.Jitter{})

for r.Next() {

	resp, err := http.Get("http://example.com")

	if err != nil {

		_ = resp.Body.Close()

		return err

	}

	if 500 <= resp.StatusCode && resp.StatusCode < 600 {

		_ = resp.Body.Close()

		continue

	}

	if resp.StatusCode == 200 {

		_ = resp.Body.Close()

		return nil

	}

}

```

## Algorithms

### Jitter (Recommended)

This algorithm provides retries with "Decorrelated Jitter" from [Exponential Backoff And Jitter | AWS Architecture Blog](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/). This blog introduces this algorithm as better. You can run the [example](https://pkg.go.dev/github.com/keisku/retry#example-Jitter) on your browser.

### Constant

This algorithm provides retries at constant intervals. You can run the [example](https://pkg.go.dev/github.com/keisku/retry#example-Constant) on your browser.

### Exponential backoff

This algorithm provides retries with the exponential backoff algorithm. You can run the [example](https://pkg.go.dev/github.com/keisku/retry#example-ExponentialBackoff) on your browser.

> Exponential backoff is an algorithm that uses feedback to multiplicatively decrease the rate of some process, in order to gradually find an acceptable rate. These algorithms find usage in a wide range of systems and processes, with radio networks and computer networks being particularly notable.

> https://en.wikipedia.org/wiki/Exponential_backoff