Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/h2non/gentleman-retry
gentleman's plugin providing retry policy capabilities in your HTTP clients
https://github.com/h2non/gentleman-retry
backoffice client gentleman http retry toolkit
Last synced: 28 days ago
JSON representation
gentleman's plugin providing retry policy capabilities in your HTTP clients
- Host: GitHub
- URL: https://github.com/h2non/gentleman-retry
- Owner: h2non
- License: mit
- Created: 2016-02-26T01:11:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-11T08:44:28.000Z (about 7 years ago)
- Last Synced: 2024-10-07T17:41:13.111Z (about 1 month ago)
- Topics: backoffice, client, gentleman, http, retry, toolkit
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [gentleman](https://github.com/h2non/gentleman)-retry [](https://travis-ci.org/h2non/gentleman-retry) [](https://godoc.org/github.com/h2non/gentleman-retry) [](https://coveralls.io/github/h2non/gentleman-retry?branch=master) [](https://goreportcard.com/report/github.com/h2non/gentleman-retry)
[gentleman](https://github.com/h2non/gentleman)'s v2 plugin providing retry policy capabilities to your HTTP clients.
Constant backoff strategy will be used by default with a maximum of 3 attempts, but you use a custom or third-party retry strategies.
Request bodies will be cached in the stack in order to re-send them if needed.
By default, retry will happen in case of network error or server response error (>= 500 || = 429).
You can use a custom `Evaluator` function to determine with custom logic when should retry or not.
Behind the scenes it implements a custom [http.RoundTripper](https://golang.org/pkg/net/http/#RoundTripper)
interface which acts like a proxy to `http.Transport`, in order to take full control of the response and retry the request if needed.
## Installation
```bash
go get -u gopkg.in/h2non/gentleman-retry.v2
```
## Versions
- **[v1](https://github.com/h2non/gentleman-retry/tree/v1)** - First version, uses `gentleman@v1`.
- **[v2](https://github.com/h2non/gentleman-retry/tree/master)** - Latest version, uses `gentleman@v2`.
## API
See [godoc reference](https://godoc.org/github.com/h2non/gentleman-retry) for detailed API documentation.
## Examples
#### Default retry strategy
```go
package main
import (
"fmt"
"gopkg.in/h2non/gentleman.v2"
"gopkg.in/h2non/gentleman-retry.v2"
)
func main() {
// Create a new client
cli := gentleman.New()
// Define base URL
cli.URL("http://httpbin.org")
// Register the retry plugin, using the built-in constant back off strategy
cli.Use(retry.New(retry.ConstantBackoff))
// Create a new request based on the current client
req := cli.Request()
// Define the URL path at request level
req.Path("/status/503")
// Set a new header field
req.SetHeader("Client", "gentleman")
// Perform the request
res, err := req.Send()
if err != nil {
fmt.Printf("Request error: %s\n", err)
return
}
if !res.Ok {
fmt.Printf("Invalid server response: %d\n", res.StatusCode)
return
}
}
```
#### Exponential retry strategy
I would recommend you using [go-resiliency](https://github.com/eapache/go-resiliency/tree/master/retrier) package for custom retry estrategies:
```go
go get -u gopkg.in/eapache/go-resiliency.v1/retrier
```
```go
package main
import (
"fmt"
"time"
"gopkg.in/h2non/gentleman.v2"
"gopkg.in/h2non/gentleman-retry.v2"
"gopkg.in/eapache/go-resiliency.v1/retrier"
)
func main() {
// Create a new client
cli := gentleman.New()
// Define base URL
cli.URL("http://httpbin.org")
// Register the retry plugin, using a custom exponential retry strategy
cli.Use(retry.New(retrier.New(retrier.ExponentialBackoff(3, 100*time.Millisecond), nil)))
// Create a new request based on the current client
req := cli.Request()
// Define the URL path at request level
req.Path("/status/503")
// Set a new header field
req.SetHeader("Client", "gentleman")
// Perform the request
res, err := req.Send()
if err != nil {
fmt.Printf("Request error: %s\n", err)
return
}
if !res.Ok {
fmt.Printf("Invalid server response: %d\n", res.StatusCode)
return
}
}
```
## License
MIT - Tomas Aparicio