Better debugging

Author: kalverra

parrot/parrot.go

@@ -479,9 +479,9 @@ func (p *Server) dynamicHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	requestID := uuid.New().String()[0:8]
+	routeCallID := uuid.New().String()[0:8]
 	dynamicLogger.UpdateContext(func(c zerolog.Context) zerolog.Context {
-		return c.Str("Request ID", requestID).Str("Route ID", route.ID())
+		return c.Str("Route Call ID", routeCallID).Str("Route ID", route.ID())
 	})
 
 	requestBody, err := io.ReadAll(r.Body)
@@ -494,12 +494,14 @@ func (p *Server) dynamicHandler(w http.ResponseWriter, r *http.Request) {
 	}
 
 	routeCall := &RouteCall{
-		RouteID: r.Method + ":" + r.URL.Path,
+		RouteCallID: routeCallID,
+		RouteID:     r.Method + ":" + r.URL.Path,
 		Request: &RouteCallRequest{
-			Method: r.Method,
-			URL:    r.URL,
-			Header: r.Header,
-			Body:   requestBody,
+			Method:     r.Method,
+			URL:        r.URL,
+			Header:     r.Header,
+			Body:       requestBody,
+			RemoteAddr: r.RemoteAddr,
 		},
 	}
 	recordingWriter := newResponseWriterRecorder(w)

parrot/recorder.go

@@ -20,19 +20,25 @@ type Recorder struct {
 	errChan    chan error
 }
 
-// RouteCall records that a route was called
+// RouteCall records when a route is called, the request and response
 type RouteCall struct {
-	RouteID  string             `json:"route_id"`
-	Request  *RouteCallRequest  `json:"request"`
+	// RouteCallID is a unique identifier for the route call for help with debugging
+	RouteCallID string `json:"route_call_id"`
+	// RouteID is the identifier of the route that was called
+	RouteID string `json:"route_id"`
+	// Request is the request made to the route
+	Request *RouteCallRequest `json:"request"`
+	// Response is the response from the route
 	Response *RouteCallResponse `json:"response"`
 }
 
 // RouteCallRequest records the request made to a route
 type RouteCallRequest struct {
-	Method string      `json:"method"`
-	URL    *url.URL    `json:"url"`
-	Header http.Header `json:"header"`
-	Body   []byte      `json:"body"`
+	Method     string      `json:"method"`
+	URL        *url.URL    `json:"url"`
+	RemoteAddr string      `json:"caller"`
+	Header     http.Header `json:"header"`
+	Body       []byte      `json:"body"`
 }
 
 // RouteCallResponse records the response from a route