https://github.com/globocom/reliable-request
A golang opinionated library to provide reliable request using hystrix-go, go-cache, and go-resiliency.
https://github.com/globocom/reliable-request
caching circuit-breaker golang http http-client reliability requests retry-library
Last synced: 28 days ago
JSON representation
A golang opinionated library to provide reliable request using hystrix-go, go-cache, and go-resiliency.
- Host: GitHub
- URL: https://github.com/globocom/reliable-request
- Owner: globocom
- License: bsd-3-clause
- Created: 2019-07-12T14:41:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-28T11:56:17.000Z (about 5 years ago)
- Last Synced: 2025-05-18T11:42:41.128Z (5 months ago)
- Topics: caching, circuit-breaker, golang, http, http-client, reliability, requests, retry-library
- Language: Go
- Homepage: https://github.com/globocom/reliable-request
- Size: 40 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Reliablereq
[](https://travis-ci.org/globocom/reliable-request) [](https://goreportcard.com/report/github.com/globocom/reliable-request)
A golang opinionated library to provide reliable request using [hystrix-go](https://github.com/afex/hystrix-go), [go-cache](https://github.com/patrickmn/go-cache), and [go-resiliency](https://github.com/eapache/go-resiliency).
When you do a `Get`, it provides:
* an HTTP client configured with timeouts and [keepalive](https://en.wikipedia.org/wiki/HTTP_persistent_connection),
* a [circuit breaker](https://martinfowler.com/bliki/CircuitBreaker.html) and
* a proper [caching system](https://en.wikipedia.org/wiki/Cache_(computing)).
# Usage
```golang
req := reliablereq.NewReliableRequest()
req.TTLCache = 1 * time.Second
req.EnableStaleCache = false
body, err := req.Get("http://example.com/list")
// passing authentication/authorization bearer token
req := reliablereq.NewReliableRequest()
req.Headers = map[string]string{"Authorization": "Bearer foobar"}
body, err := req.Get("http://example.com/list")
// creating a different hystrix command
req := reliablereq.NewReliableRequest()
req.UpdateHystrixConfig("api2command", hystrix.CommandConfig{
Timeout: 800 + 100,
MaxConcurrentRequests: 100,
ErrorPercentThreshold: 50,
RequestVolumeThreshold: 20,
SleepWindow: 5000,
})
body, err := req.Get("http://example.com/list")
```
## WARNING
Make sure you use different Hystrix commands for other endpoint APIs or separated Circuit Breaker contexts, otherwise, an endpoint may open the circuit breaker and all other requests will fail.
# Opinionated defaults
```golang
// reliable request defaults
rr := ReliableRequest{
EnableCache: true,
TTLCache: 1 * time.Minute,
EnableStaleCache: true,
TTLStaleCache: 24 * time.Hour,
}
// hystrix
var defaultHystrixConfiguration = hystrix.CommandConfig{
Timeout: 800 + 100, // the defaultTimeout http client + a small gap
MaxConcurrentRequests: 100,
ErrorPercentThreshold: 50,
RequestVolumeThreshold: 3,
SleepWindow: 5000,
}
// http client
client := &http.Client{
Transport: &http.Transport{
DialContext: (&net.Dialer{
Timeout: 800 * time.Millisecond,
KeepAlive: 30 * time.Second,
}).DialContext,
MaxIdleConns: 100,
MaxIdleConnsPerHost: 100,
TLSHandshakeTimeout: 800 * time.Millisecond,
},
Timeout: 800 * time.Millisecond,
}
```
# Future
* provide a proxy to setup hystrix
* add retry logic (by go-resiliency)
* add more examples, like token header requests and more
* discuss the adopted defaults
* discuss whether async hystrix is better (Go instead of Do)
* understand and test the simultaneous client req hystrix config to see its implications
* add go api documentation
* add hooks (callbacks) to provides means for metrics gathering
* add more HTTP verbs?
* add load stress