diff --git a/client.go b/client.go index ec6141f8..8376fb77 100644 --- a/client.go +++ b/client.go @@ -11,6 +11,8 @@ import ( "crypto/tls" "crypto/x509" "errors" + "go.opentelemetry.io/otel" + tracesdk "go.opentelemetry.io/otel/sdk/trace" "io" "maps" "net/http" @@ -221,6 +223,7 @@ type Client struct { contentDecompressers map[string]ContentDecompresser certWatcherStopChan chan bool circuitBreaker *CircuitBreaker + tracerProvider *tracesdk.TracerProvider } // CertWatcherOptions allows configuring a watcher that reloads dynamically TLS certs. @@ -2382,3 +2385,13 @@ func (c *Client) debugf(format string, v ...any) { c.Logger().Debugf(format, v...) } } + +func (c *Client) SetJaeger(tp *tracesdk.TracerProvider) { + c.lock.RLock() + defer c.lock.RUnlock() + if !c.IsTrace() { + panic("SetJaeger must depend with SetTrace enabled") + } + c.tracerProvider = tp + otel.SetTracerProvider(tp) +} diff --git a/client_test.go b/client_test.go index 8a5eef50..40388de7 100644 --- a/client_test.go +++ b/client_test.go @@ -14,6 +14,10 @@ import ( "crypto/tls" "errors" "fmt" + "go.opentelemetry.io/otel/exporters/jaeger" + "go.opentelemetry.io/otel/sdk/resource" + tracesdk "go.opentelemetry.io/otel/sdk/trace" + semconv "go.opentelemetry.io/otel/semconv/v1.32.0" "io" "log" "math" @@ -1515,3 +1519,25 @@ func TestClientCircuitBreaker(t *testing.T) { assertError(t, err) assertEqual(t, uint32(1), c.circuitBreaker.failureCount.Load()) } + +func TestRequestWithJaeger(t *testing.T) { + ts := createGetServer(t) + defer ts.Close() + + jaegerURL := "http://localhost:14268/api/traces" + exp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(jaegerURL))) + assertNil(t, err) + tp := tracesdk.NewTracerProvider( + tracesdk.WithBatcher(exp), + tracesdk.WithResource(resource.NewWithAttributes( + semconv.SchemaURL, + semconv.ServiceName("resty"), + )), + ) + c := dcnl() + c.SetTrace(true) + c.SetJaeger(tp) + + fmt.Println(c.R().Get(ts.URL + "/")) + tp.Shutdown(context.Background()) +} diff --git a/go.mod b/go.mod index e8876115..802f2b3e 100644 --- a/go.mod +++ b/go.mod @@ -1,5 +1,23 @@ module resty.dev/v3 -go 1.21 +go 1.23.0 -require golang.org/x/net v0.33.0 +toolchain go1.24.3 + +require ( + go.opentelemetry.io/otel/exporters/jaeger v1.17.0 + golang.org/x/net v0.33.0 +) + +require ( + github.com/go-logr/logr v1.4.3 // indirect + github.com/go-logr/stdr v1.2.2 // indirect + github.com/google/uuid v1.6.0 // indirect + go.opentelemetry.io/auto/sdk v1.1.0 // indirect + go.opentelemetry.io/otel v1.36.0 // indirect + go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.36.0 // indirect + go.opentelemetry.io/otel/metric v1.36.0 // indirect + go.opentelemetry.io/otel/sdk v1.36.0 // indirect + go.opentelemetry.io/otel/trace v1.36.0 // indirect + golang.org/x/sys v0.33.0 // indirect +) diff --git a/go.sum b/go.sum index 16660ab5..515f6247 100644 --- a/go.sum +++ b/go.sum @@ -1,2 +1,43 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= +github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= +github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= +github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= +go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= +go.opentelemetry.io/otel v1.36.0 h1:UumtzIklRBY6cI/lllNZlALOF5nNIzJVb16APdvgTXg= +go.opentelemetry.io/otel v1.36.0/go.mod h1:/TcFMXYjyRNh8khOAO9ybYkqaDBb/70aVwkNML4pP8E= +go.opentelemetry.io/otel/exporters/jaeger v1.17.0 h1:D7UpUy2Xc2wsi1Ras6V40q806WM07rqoCWzXu7Sqy+4= +go.opentelemetry.io/otel/exporters/jaeger v1.17.0/go.mod h1:nPCqOnEH9rNLKqH/+rrUjiMzHJdV1BlpKcTwRTyKkKI= +go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.36.0 h1:G8Xec/SgZQricwWBJF/mHZc7A02YHedfFDENwJEdRA0= +go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.36.0/go.mod h1:PD57idA/AiFD5aqoxGxCvT/ILJPeHy3MjqU/NS7KogY= +go.opentelemetry.io/otel/metric v1.36.0 h1:MoWPKVhQvJ+eeXWHFBOPoBOi20jh6Iq2CcCREuTYufE= +go.opentelemetry.io/otel/metric v1.36.0/go.mod h1:zC7Ks+yeyJt4xig9DEw9kuUFe5C3zLbVjV2PzT6qzbs= +go.opentelemetry.io/otel/sdk v1.17.0 h1:FLN2X66Ke/k5Sg3V623Q7h7nt3cHXaW1FOvKKrW0IpE= +go.opentelemetry.io/otel/sdk v1.17.0/go.mod h1:U87sE0f5vQB7hwUoW98pW5Rz4ZDuCFBZFNUBlSgmDFQ= +go.opentelemetry.io/otel/sdk v1.36.0 h1:b6SYIuLRs88ztox4EyrvRti80uXIFy+Sqzoh9kFULbs= +go.opentelemetry.io/otel/sdk v1.36.0/go.mod h1:+lC+mTgD+MUWfjJubi2vvXWcVxyr9rmlshZni72pXeY= +go.opentelemetry.io/otel/trace v1.36.0 h1:ahxWNuqZjpdiFAyrIoQ4GIiAIhxAunQR6MUoKrsNd4w= +go.opentelemetry.io/otel/trace v1.36.0/go.mod h1:gQ+OnDZzrybY4k4seLzPAWNwVBBVlF2szhehOBB/tGA= golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I= golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= +golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/request.go b/request.go index ed475e52..f2dd5580 100644 --- a/request.go +++ b/request.go @@ -12,6 +12,7 @@ import ( "encoding/xml" "errors" "fmt" + "go.opentelemetry.io/otel/attribute" "io" "maps" "mime/multipart" @@ -1372,6 +1373,18 @@ func (r *Request) Execute(method, url string) (res *Response, err error) { } }() + if r.client.tracerProvider != nil { + tr := r.client.tracerProvider.Tracer("execute") + c, span := tr.Start(r.ctx, fmt.Sprintf("%s %s", method, url)) + r.ctx = c + defer span.End() + + span.SetAttributes( + attribute.String("http.method", method), + attribute.String("http.url", url), + ) + } + r.Method = method if r.RetryCount < 0 { @@ -1474,6 +1487,7 @@ func (r *Request) Execute(method, url string) (res *Response, err error) { break } } + //childSpan.End() } if r.isMultiPart { diff --git a/trace.go b/trace.go index 26db2871..8df00d30 100644 --- a/trace.go +++ b/trace.go @@ -9,6 +9,9 @@ import ( "context" "crypto/tls" "fmt" + "go.opentelemetry.io/otel" + "go.opentelemetry.io/otel/attribute" + "go.opentelemetry.io/otel/trace" "net/http/httptrace" "time" ) @@ -107,42 +110,133 @@ type clientTrace struct { gotConnInfo httptrace.GotConnInfo } +type tracer struct { + ctx context.Context + span trace.Span +} + +type HttpJaegerTracers struct { + RootTracer tracer + DNSTracer tracer + ConnectTracer tracer + GetConnectTracer tracer + TLSHandshakeTracer tracer + WriteRequestTracer tracer + WriteHeaderTracer tracer +} + func (t *clientTrace) createContext(ctx context.Context) context.Context { + + trace := otel.Tracer("trace") + tracers := HttpJaegerTracers{} return httptrace.WithClientTrace( ctx, &httptrace.ClientTrace{ - DNSStart: func(_ httptrace.DNSStartInfo) { + DNSStart: func(info httptrace.DNSStartInfo) { + c, span := trace.Start(tracers.GetConnectTracer.ctx, "DNSTrace") + tracers.DNSTracer = tracer{ + ctx: c, + span: span, + } + span.SetAttributes( + attribute.String("host", info.Host), + ) t.dnsStart = time.Now() }, - DNSDone: func(_ httptrace.DNSDoneInfo) { + DNSDone: func(info httptrace.DNSDoneInfo) { + tracers.DNSTracer.span.SetAttributes( + attribute.String("address", info.Addrs[0].String()), + ) + if info.Err != nil { + attribute.String("error", info.Err.Error()) + } t.dnsDone = time.Now() + tracers.DNSTracer.span.End() }, - ConnectStart: func(_, _ string) { + ConnectStart: func(network, address string) { + c, span := trace.Start(tracers.GetConnectTracer.ctx, "ConnectTrace") + tracers.ConnectTracer = tracer{ + ctx: c, + span: span, + } if t.dnsDone.IsZero() { t.dnsDone = time.Now() } if t.dnsStart.IsZero() { t.dnsStart = t.dnsDone } + span.SetAttributes( + attribute.String("address", address), + attribute.String("network", network), + ) }, ConnectDone: func(net, addr string, err error) { t.connectDone = time.Now() + if err != nil { + tracers.ConnectTracer.span.SetAttributes( + attribute.String("error", err.Error()), + ) + } + tracers.ConnectTracer.span.End() }, - GetConn: func(_ string) { + GetConn: func(hostPort string) { + c, span := trace.Start(ctx, "GetConnectTrace") + tracers.GetConnectTracer = tracer{ + ctx: c, + span: span, + } + tracers.GetConnectTracer.span.SetAttributes( + attribute.String( + "hostPort", hostPort, + ), + ) t.getConn = time.Now() }, GotConn: func(ci httptrace.GotConnInfo) { t.gotConn = time.Now() t.gotConnInfo = ci + tracers.GetConnectTracer.span.End() }, GotFirstResponseByte: func() { + tracers.WriteRequestTracer.span.End() + _, span := trace.Start(ctx, "GotResponse") + defer span.End() t.gotFirstResponseByte = time.Now() }, TLSHandshakeStart: func() { + c, span := trace.Start(tracers.GetConnectTracer.ctx, "TLSHandshakeTrace") + tracers.TLSHandshakeTracer = tracer{ + ctx: c, + span: span, + } t.tlsHandshakeStart = time.Now() }, TLSHandshakeDone: func(_ tls.ConnectionState, _ error) { t.tlsHandshakeDone = time.Now() + tracers.TLSHandshakeTracer.span.End() + }, + WroteRequest: func(info httptrace.WroteRequestInfo) { + c, span := trace.Start(ctx, "WroteRequest") + tracers.WriteRequestTracer = tracer{ + ctx: c, + span: span, + } + }, + WroteHeaderField: func(key string, value []string) { + if tracers.WriteHeaderTracer.span == nil { + c, span := trace.Start(ctx, "WriteHeader") + tracers.WriteHeaderTracer = tracer{ + ctx: c, + span: span, + } + } + tracers.WriteHeaderTracer.span.SetAttributes( + attribute.StringSlice(fmt.Sprintf("headers.%s", key), value), + ) + + }, + WroteHeaders: func() { + tracers.WriteHeaderTracer.span.End() }, }, )