[SLT-331] feat(omnirpc): omnirpc request tracing

services/omnirpc/http/capture_client.go

@@ -3,21 +3,26 @@ package http
 import (
 	"context"
 
+	"github.com/ethereum/go-ethereum/common"
 	"github.com/synapsecns/sanguine/core/bytemap"
+	"github.com/synapsecns/sanguine/core/metrics"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 // CaptureClient is a mock client used for checking response values.
 type CaptureClient struct {
 	requests     []*CapturedRequest
 	responseFunc MakeResponseFunc
+	handler      metrics.Handler
 }
 
 // MakeResponseFunc is used for mocking responses.
 type MakeResponseFunc func(c *CapturedRequest) (Response, error)
 
 // NewCaptureClient creates  anew client for testing.
-func NewCaptureClient(responseFunc MakeResponseFunc) *CaptureClient {
-	return &CaptureClient{requests: []*CapturedRequest{}, responseFunc: responseFunc}
+func NewCaptureClient(handler metrics.Handler, responseFunc MakeResponseFunc) *CaptureClient {
+	return &CaptureClient{requests: []*CapturedRequest{}, responseFunc: responseFunc, handler: handler}
 }
 
 // Requests turns a list of sent requests. These are not mutation safe.
@@ -30,6 +35,7 @@ func (c *CaptureClient) NewRequest() Request {
 	request := CapturedRequest{
 		Client:        c,
 		StringHeaders: make(map[string]string),
+		Handler:       c.handler,
 	}
 	c.requests = append(c.requests, &request)
 	return &request
@@ -56,44 +62,102 @@ type CapturedRequest struct {
 	// RequestURIBytes is the request uri bytes. Notably, this will not include
 	// RequestURI's set by SetRequestURI
 	RequestURIBytes []byte
+	// Metrics is the metrics handler
+	Handler metrics.Handler
 }
 
 var _ Client = &CaptureClient{}
 
 // SetBody stores the body for testing.
 func (c *CapturedRequest) SetBody(body []byte) Request {
+	_, span := c.Handler.Tracer().Start(
+		c.Context,
+		"SetBody",
+		trace.WithAttributes(attribute.String("SetBody", common.Bytes2Hex(body))),
+	)
+	defer func() {
+		metrics.EndSpan(span)
+	}()
 	c.Body = body
 	return c
 }
 
 // SetContext stores the context for testing.
 func (c *CapturedRequest) SetContext(ctx context.Context) Request {
+	_, span := c.Handler.Tracer().Start(
+		ctx,
+		"SetContext",
+	)
+	span.AddEvent("SetContext")
+	defer func() {
+		metrics.EndSpan(span)
+	}()
 	c.Context = ctx
 	return c
 }
 
 // SetHeader sets the header for testing.
 func (c *CapturedRequest) SetHeader(key, value string) Request {
+	_, span := c.Handler.Tracer().Start(
+		c.Context,
+		"SetHeader",
+		trace.WithAttributes(attribute.String("SetHeader", key)),
+		trace.WithAttributes(attribute.String("value", value)),
+	)
+	defer func() {
+		metrics.EndSpan(span)
+	}()
 	c.StringHeaders[key] = value
 	return c
 }
 
 // SetHeaderBytes sets header bytes for testing.
 func (c *CapturedRequest) SetHeaderBytes(key, value []byte) Request {
+	_, span := c.Handler.Tracer().Start(
+		c.Context,
+		"SetHeaderBytes",
+		trace.WithAttributes(attribute.String("key", common.Bytes2Hex(key))),
+		trace.WithAttributes(attribute.String("value", common.Bytes2Hex(value))),
+	)
+	defer func() {
+		metrics.EndSpan(span)
+	}()
 	c.ByteHeaders.Put(key, value)
 	return c
 }
 
 // SetRequestURI stores the request uri.
 func (c *CapturedRequest) SetRequestURI(uri string) Request {
+	_, span := c.Handler.Tracer().Start(
+		c.Context,
+		"SetRequestURI",
+		trace.WithAttributes(attribute.String("uri", uri)),
+	)
+	defer func() {
+		metrics.EndSpan(span)
+	}()
 	c.RequestURI = uri
 	return c
 }
 
 // Do calls responseFunc for testing.
 func (c *CapturedRequest) Do() (Response, error) {
-	//nolint: wrapcheck
-	return c.Client.responseFunc(c)
+	_, span := c.Handler.Tracer().Start(
+		c.Context,
+		"Do",
+	)
+	defer func() {
+		metrics.EndSpan(span)
+	}()
+
+	resp, err := c.Client.responseFunc(c)
+	if err != nil {
+		return nil, err
+	}
+
+	span.SetAttributes(attribute.String("response", common.Bytes2Hex(resp.Body())))
+
+	return resp, err
 }
 
 var _ Request = &CapturedRequest{}

services/omnirpc/http/capture_client_test.go

@@ -2,23 +2,27 @@ package http_test
 
 import (
 	"context"
+	"testing"
+
 	"github.com/brianvoe/gofakeit/v6"
 	. "github.com/stretchr/testify/assert"
+	"github.com/synapsecns/sanguine/core/metrics"
 	"github.com/synapsecns/sanguine/services/omnirpc/http"
 	"github.com/synapsecns/sanguine/services/omnirpc/http/mocks"
-	"testing"
 )
 
 func TestCaptureClient(t *testing.T) {
 	testRes := gofakeit.ImageJpeg(50, 50)
 	testBody := gofakeit.ImageJpeg(50, 50)
 
-	client := http.NewCaptureClient(func(c *http.CapturedRequest) (http.Response, error) {
-		bodyRes := new(mocks.Response)
-		bodyRes.On("Body").Return(testRes)
+	client := http.NewCaptureClient(
+		metrics.NewNullHandler(),
+		func(c *http.CapturedRequest) (http.Response, error) {
+			bodyRes := new(mocks.Response)
+			bodyRes.On("Body").Return(testRes)
 
-		return bodyRes, nil
-	})
+			return bodyRes, nil
+		})
 
 	testCtx := context.Background()
 
@@ -31,8 +35,8 @@ func TestCaptureClient(t *testing.T) {
 	testURL := gofakeit.URL()
 
 	testReq := client.NewRequest()
-	testReq.SetBody(testBody)
 	testReq.SetContext(testCtx)
+	testReq.SetBody(testBody)
 	testReq.SetHeaderBytes(byteHeaderK, byteHeaderV)
 	testReq.SetHeader(strHeaderK, strHeaderV)
 	testReq.SetRequestURI(testURL)

services/omnirpc/http/client.go

@@ -3,6 +3,8 @@ package http
 import (
 	"context"
 	"strings"
+
+	"github.com/synapsecns/sanguine/core/metrics"
 )
 
 // Client contains a post client for interacting with json rpc servers.
@@ -62,14 +64,14 @@ func init() {
 
 // NewClient creates a client from the client type
 // defaults to fast http.
-func NewClient(clientType ClientType) Client {
+func NewClient(handler metrics.Handler, clientType ClientType) Client {
 	switch clientType {
 	case FastHTTP:
-		return NewFastHTTPClient()
+		return NewFastHTTPClient(handler)
 	case Resty:
-		return NewRestyClient()
+		return NewRestyClient(handler)
 	default:
-		return NewRestyClient()
+		return NewRestyClient(handler)
 	}
 }
 

services/omnirpc/http/client_test.go

@@ -1,11 +1,12 @@
 package http_test
 
 import (
-	"github.com/brianvoe/gofakeit/v6"
-	. "github.com/stretchr/testify/assert"
 	"io"
 	"net/http"
 	"net/http/httptest"
+
+	"github.com/brianvoe/gofakeit/v6"
+	. "github.com/stretchr/testify/assert"
 )
 
 var jsonOptions = &gofakeit.JSONOptions{
@@ -42,9 +43,9 @@ func (c *HTTPSuite) TestClient() {
 		}))
 
 		req := client.NewRequest()
+		req.SetContext(c.GetTestContext())
 		req.SetRequestURI(svr.URL)
 		req.SetBody(mockBody)
-		req.SetContext(c.GetTestContext())
 		for key, val := range headers {
 			if gofakeit.Bool() {
 				req.SetHeader(key, val)