Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add debug info for retry call #571

Merged
merged 10 commits into from
Aug 12, 2024
Merged

Add debug info for retry call #571

Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ad60253
add debug info for retry call
vmanilo Aug 7, 2024
2ff1413
Merge branch 'main' into feature/add-debug-info
vmanilo Aug 7, 2024
280c1df
added error context
vmanilo Aug 8, 2024
fe459e3
set uuid for each request
vmanilo Aug 8, 2024
2f541b6
added error and ctx error info
vmanilo Aug 8, 2024
a72daaf
add req id to headers
vmanilo Aug 8, 2024
1a5f3e5
remove test log
vmanilo Aug 8, 2024
d4e0798
fix tests
vmanilo Aug 8, 2024
ff13873
fix header name
vmanilo Aug 9, 2024
cda6f9e
Merge branch 'main' into feature/add-debug-info
ekampf Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 44 additions & 2 deletions twingate/internal/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ const (
headerAgent = "User-Agent"
headerCorrelationID = "X-Correlation-Id"

ctxReqIDKey = "Ctx_req_id_key"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets give this a decent name - X-Twingate-Request-Id

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, updated it


defaultPageLimit = 50
extendedPageLimit = 100

Expand Down Expand Up @@ -121,7 +123,21 @@ func newServerURL(network, url string) serverURL {
}
}

//nolint:cyclop
func customRetryPolicy(ctx context.Context, resp *http.Response, err error) (bool, error) {
reqID := "test_id"
if resp != nil {
reqID = resp.Request.Header.Get(ctxReqIDKey)
}

if err != nil {
log.Printf("[WARN] [RETRY_POLICY] [id:%s] error: %s", reqID, err.Error())
}

if ctx.Err() != nil {
log.Printf("[WARN] [RETRY_POLICY] [id:%s] context error: %s", reqID, ctx.Err().Error())
}

// do not retry if API token not set
if errors.Is(err, ErrAPITokenNoSet) {
return false, err
Expand All @@ -137,7 +153,28 @@ func customRetryPolicy(ctx context.Context, resp *http.Response, err error) (boo
}
}

return retryablehttp.DefaultRetryPolicy(ctx, resp, err) //nolint
shouldRetry, resultErr := retryablehttp.DefaultRetryPolicy(ctx, resp, err)
if !shouldRetry {
return false, resultErr //nolint
}

if resp != nil {
log.Printf("[WARN] [RETRY_POLICY] [id:%s] going to retry call %s, status %s", reqID, resp.Request.URL.String(), resp.Status)

reqBody, _ := resp.Request.GetBody()
if reqBody != nil {
reqBodyBytes, _ := io.ReadAll(reqBody)
log.Printf("[WARN] [RETRY_POLICY] [id:%s] request: %s", reqID, string(reqBodyBytes))
}

body, bodyErr := io.ReadAll(resp.Body)
if bodyErr == nil {
resp.Body = io.NopCloser(bytes.NewBuffer(body))
log.Printf("[WARN] [RETRY_POLICY] [id:%s] response: %s", reqID, string(body))
}
}

return true, nil
vmanilo marked this conversation as resolved.
Show resolved Hide resolved
}

func NewClient(url string, apiToken string, network string, httpTimeout time.Duration, httpRetryMax int, agent, version string) *Client {
Expand All @@ -149,7 +186,12 @@ func NewClient(url string, apiToken string, network string, httpTimeout time.Dur
retryableClient.CheckRetry = customRetryPolicy
retryableClient.RetryMax = httpRetryMax
retryableClient.RequestLogHook = func(logger retryablehttp.Logger, req *http.Request, retryNumber int) {
log.Printf("[WARN] Failed to call %s (retry %d)", req.URL.String(), retryNumber)
reqID, _ := uuid.GenerateUUID()
req.Header.Set(ctxReqIDKey, reqID)

if retryNumber > 0 {
log.Printf("[WARN] [id:%s] Failed to call %s (retry %d)", reqID, req.URL.String(), retryNumber)
}
}
retryableClient.HTTPClient.Timeout = httpTimeout
retryableClient.HTTPClient.Transport = newTransport(retryableClient.HTTPClient.Transport, apiToken, agent, version, correlationID)
Expand Down