chore: include request id in debug logs and diagnostics

client/client.go

@@ -141,7 +141,7 @@ func NewClientWithConfig(config *Config) (*Client, error) {
 		// if enabled we log all requests and responses to sterr
 		client.httpClient.Logger = log.New(os.Stderr, "", log.LstdFlags)
 		client.httpClient.ResponseLogHook = func(l retryablehttp.Logger, resp *http.Response) {
-			l.Printf("[DEBUG] Response: %s %s", resp.Request.Method, resp.Request.URL.String())
+			l.Printf("[DEBUG] Request: %s \"%s\" %s %s", resp.Request.Method, resp.Request.URL.String(), resp.Status, resp.Header.Get("Request-Id"))
 		}
 	}
 

client/errors.go

@@ -14,6 +14,8 @@ type DetailedError struct {
 	Status int `json:"status,omitempty"`
 	// The error message
 	Message string `json:"error,omitempty"`
+	// ID unique ID of the HTTP request that caused this error.
+	ID string `json:"request_id,omitempty"`
 	// Type is a URI used to uniquely identify the type of error.
 	Type string `json:"type,omitempty"`
 	// Title is a human-readable summary that explains the type of the problem.
@@ -87,6 +89,8 @@ func ErrorFromResponse(r *http.Response) error {
 		return errors.New("invalid response")
 	}
 
+	requestID := r.Header.Get("Request-Id")
+
 	switch r.Header.Get("Content-Type") {
 	case jsonapi.MediaType:
 		var detailedError DetailedError
@@ -97,10 +101,12 @@ func ErrorFromResponse(r *http.Response) error {
 			return DetailedError{
 				Status:  r.StatusCode,
 				Message: r.Status,
+				ID:      requestID,
 			}
 		}
 
 		detailedError = DetailedError{
+			ID:     requestID,
 			Status: r.StatusCode,
 			Title:  errPayload.Errors[0].Title,
 		}
@@ -130,6 +136,7 @@ func ErrorFromResponse(r *http.Response) error {
 		if err := json.NewDecoder(r.Body).Decode(&detailedError); err != nil {
 			// If we can't decode the error, return a generic error
 			return DetailedError{
+				ID:      requestID,
 				Status:  r.StatusCode,
 				Message: r.Status,
 			}

go.mod

@@ -21,6 +21,7 @@ require (
 	github.com/ProtonMail/go-crypto v1.1.0-alpha.2 // indirect
 	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
 	github.com/cloudflare/circl v1.3.7 // indirect
+	github.com/tidwall/pretty v1.2.1 // indirect
 	golang.org/x/sync v0.8.0 // indirect
 	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240814211410-ddb44dafa142 // indirect

honeycombio/type_helpers.go

@@ -251,6 +251,7 @@ func diagFromDetailedErr(err honeycombio.DetailedError) diag.Diagnostics {
 				detail += d.Field + " "
 			}
 			detail += d.Description
+			detail += fmt.Sprintf(" - ID: %s", err.ID)
 
 			diags = append(diags, diag.Diagnostic{
 				Severity: diag.Error,

internal/helper/diag.go

@@ -53,8 +53,8 @@ func AddDiagnosticOnError(diag *diag.Diagnostics, summary string, err error) boo
 }
 
 func (d DetailedErrorDiagnostic) Detail() string {
+	response := fmt.Sprintf("ID: %s\n", d.e.ID)
 	if len(d.e.Details) > 0 {
-		var response string
 		for i, dt := range d.e.Details {
 			response += dt.Code + " - " + dt.Description
 
@@ -65,7 +65,7 @@ func (d DetailedErrorDiagnostic) Detail() string {
 		return response
 	}
 
-	return d.e.Message
+	return response + d.e.Message
 }
 
 func (d DetailedErrorDiagnostic) Summary() string {