gentleman-retry
![Go Report Card](https://github.com/camo/7354c925f1ab1d3c5818b4edf55fc3ac0f99f8ba7ab0bb6f2e83e4c4ba19bd74/68747470733a2f2f676f7265706f7274636172642e636f6d2f62616467652f6769746875622e636f6d2f68326e6f6e2f67656e746c656d616e2d7265747279)
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
interface which acts like a proxy to http.Transport
, in order to take full control of the response and retry the request if needed.
go get -u gopkg.in/h2non/gentleman-retry.v2
See godoc reference for detailed API documentation.
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
}
}
I would recommend you using go-resiliency package for custom retry estrategies:
go get -u gopkg.in/eapache/go-resiliency.v1/retrier
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
}
}
MIT - Tomas Aparicio