add request id to api error

pkg/models/error.go

@@ -66,6 +66,13 @@ func (ec ErrorCode) Component() string {
 	return ec.component
 }
 
+func (ec ErrorCode) String() string {
+	if ec.httpStatusCode == 0 {
+		return fmt.Sprintf("%s-500", ec.component)
+	}
+	return fmt.Sprintf("%s-%d", ec.component, ec.httpStatusCode)
+}
+
 // BaseError is a custom error type in Go that provides additional fields
 // and methods for more detailed error handling. It implements the error
 // interface, as well as additional interfaces for providing a hint,

pkg/publicapi/apimodels/error.go

@@ -35,6 +35,9 @@ type APIError struct {
 	// message is a short, human-readable description of the error.
 	// it should be concise and provide a clear indication of what went wrong.
 	Message string `json:"message"`
+
+	// RequestID is the request ID of the request that caused the error.
+	RequestID string `json:"request_id"`
 }
 
 // NewAPIError creates a new APIError with the given HTTP status code and message.

pkg/publicapi/middleware/error_handler.go

@@ -28,6 +28,8 @@ func CustomHTTPErrorHandler(err error, c echo.Context) {
 		message = "internal server error"
 	}
 
+	requestID := c.Request().Header.Get(echo.HeaderXRequestID)
+
 	// Don't override the status code if it is already been set.
 	// This is something that is advised by ECHO framework.
 	if !c.Response().Committed {
@@ -38,6 +40,7 @@ func CustomHTTPErrorHandler(err error, c echo.Context) {
 			err = c.JSON(code, apimodels.APIError{
 				HTTPStatusCode: code,
 				Message:        message,
+				RequestID:      requestID,
 			})
 		}
 		if err != nil {