-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merging to release-1.8: TT-10564 Splunk backoff retry (#758)
TT-10564 Splunk backoff retry (#758) * splunk backoff retry mechanism to reduce chance of losing logs * only retry for temporary errors * move to separate pkg outside of pumps * set correct collector url * ensure connection can be reused by reading and closing body stream * reset req body to fix error when req body has already been read from previous failed request * tidy up, change retry log to warning as not yet error * add debugging for body bytes sent to splunk & RTT to aid in fine tuning batch size * PR requested changes * fix go linter issue * applying suggested changes * linting --------- Co-authored-by: dominicriordan <[email protected]> Co-authored-by: domsolutions <[email protected]>
- Loading branch information
3 people
authored
Jan 4, 2024
1 parent
9532149
commit dfcff20
Showing
4 changed files
with
303 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| package httpretry | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "net" | ||
| "net/http" | ||
| "net/url" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/cenkalti/backoff/v4" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| type BackoffHTTPRetry struct { | ||
| logger *logrus.Entry | ||
| httpclient *http.Client | ||
| errMsg string | ||
| maxRetries uint64 | ||
| } | ||
|
|
||
| type ( | ||
| conError interface{ ConnectionError() bool } | ||
| tempError interface{ Temporary() bool } | ||
| timeoutError interface{ Timeout() bool } | ||
| ) | ||
|
|
||
| // NewBackoffRetry Creates an exponential backoff retry to use httpClient for connections. Will retry if a temporary error or | ||
| // 5xx or 429 status code in response. | ||
| func NewBackoffRetry(errMsg string, maxRetries uint64, httpClient *http.Client, logger *logrus.Entry) *BackoffHTTPRetry { | ||
| return &BackoffHTTPRetry{errMsg: errMsg, maxRetries: maxRetries, httpclient: httpClient, logger: logger} | ||
| } | ||
|
|
||
| func (s *BackoffHTTPRetry) Send(req *http.Request) error { | ||
| var reqBody []byte | ||
| if req.Body != nil { | ||
| var err error | ||
| reqBody, err = io.ReadAll(req.Body) | ||
| if err != nil { | ||
| s.logger.WithError(err).Error("Failed to read req body") | ||
| return err | ||
| } | ||
| req.Body.Close() // closing the original body | ||
| } | ||
|
|
||
| opFn := func() error { | ||
| // recreating the request body from the buffer for each retry as if first attempt fails and | ||
| // a new conn is created (keep alive disabled on server for example) the req body has already been read, | ||
| // resulting in "http: ContentLength=X with Body length Y" error | ||
| req.Body = io.NopCloser(bytes.NewBuffer(reqBody)) | ||
|
|
||
| t := time.Now() | ||
| resp, err := s.httpclient.Do(req) | ||
| s.logger.Debugf("Req %s took %s", req.URL, time.Since(t)) | ||
|
|
||
| if err != nil { | ||
| return s.handleErr(err) | ||
| } | ||
| defer func() { | ||
| // read all response and discard so http client can | ||
| // reuse connection as per doc on Response.Body | ||
| _, err := io.Copy(io.Discard, resp.Body) | ||
| if err != nil { | ||
| s.logger.WithError(err).Error("Failed to read and discard resp body") | ||
| } | ||
| resp.Body.Close() | ||
| }() | ||
|
|
||
| if resp.StatusCode == http.StatusOK { | ||
| return nil | ||
| } | ||
|
|
||
| body, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| s.logger.WithError(err).Error("Failed to read resp body") | ||
| // attempt retry | ||
| return err | ||
| } | ||
|
|
||
| err = fmt.Errorf("got status code %d and response '%s'", resp.StatusCode, body) | ||
|
|
||
| // server error or rate limit hit - attempt retry | ||
| if resp.StatusCode >= http.StatusInternalServerError || resp.StatusCode == http.StatusTooManyRequests { | ||
| return err | ||
| } | ||
|
|
||
| // any other error treat as permanent (i.e. auth error, invalid request) and don't retry | ||
| return backoff.Permanent(err) | ||
| } | ||
|
|
||
| return backoff.RetryNotify(opFn, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), s.maxRetries), func(err error, t time.Duration) { | ||
| s.logger.WithError(err).Warningf("%s retrying in %s", s.errMsg, t) | ||
| }) | ||
| } | ||
|
|
||
| func (s *BackoffHTTPRetry) handleErr(err error) error { | ||
| if isErrorRetryable(err) { | ||
| return err | ||
| } | ||
| // permanent error - don't retry | ||
| return backoff.Permanent(err) | ||
| } | ||
|
|
||
| func isErrorRetryable(err error) bool { | ||
| if err == nil { | ||
| return false | ||
| } | ||
|
|
||
| var ( | ||
| conErr conError | ||
| tempErr tempError | ||
| timeoutErr timeoutError | ||
| urlErr *url.Error | ||
| netOpErr *net.OpError | ||
| ) | ||
|
|
||
| switch { | ||
| case errors.As(err, &conErr) && conErr.ConnectionError(): | ||
| return true | ||
| case strings.Contains(err.Error(), "connection reset"): | ||
| return true | ||
| case errors.As(err, &urlErr): | ||
| // Refused connections should be retried as the service may not yet be | ||
| // running on the port. Go TCP dial considers refused connections as | ||
| // not temporary. | ||
| if strings.Contains(urlErr.Error(), "connection refused") { | ||
| return true | ||
| } | ||
| return isErrorRetryable(errors.Unwrap(urlErr)) | ||
| case errors.As(err, &netOpErr): | ||
| // Network dial, or temporary network errors are always retryable. | ||
| if strings.EqualFold(netOpErr.Op, "dial") || netOpErr.Temporary() { | ||
| return true | ||
| } | ||
| return isErrorRetryable(errors.Unwrap(netOpErr)) | ||
| case errors.As(err, &tempErr) && tempErr.Temporary(): | ||
| // Fallback to the generic temporary check, with temporary errors | ||
| // retryable. | ||
| return true | ||
| case errors.As(err, &timeoutErr) && timeoutErr.Timeout(): | ||
| // Fallback to the generic timeout check, with timeout errors | ||
| // retryable. | ||
| return true | ||
| } | ||
|
|
||
| return false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.