feat: [#726] Add HTTP server and client telemetry instrumentation [5]

contracts/telemetry/telemetry.go

@@ -9,6 +9,8 @@ import (
 	oteltrace "go.opentelemetry.io/otel/trace"
 )
 
+type Resolver = func() Telemetry
+
 type Telemetry interface {
 	// Logger returns a log.Logger instance for emitting structured log records under the given instrumentation name.
 	// Optional log.LoggerOption parameters allow customization of logger behavior.

go.mod

@@ -30,6 +30,7 @@ require (
 	github.com/stretchr/testify v1.11.1
 	github.com/urfave/cli/v3 v3.6.2
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.64.0
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.64.0
 	go.opentelemetry.io/contrib/propagators/b3 v1.39.0
 	go.opentelemetry.io/otel v1.39.0
 	go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc v0.15.0
@@ -62,6 +63,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/chigopher/pathlib v0.19.1 // indirect
 	github.com/clipperhouse/uax29/v2 v2.2.0 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/google/go-cmp v0.7.0 // indirect

go.sum

@@ -91,6 +91,8 @@ github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkp
 github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
 github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
 github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
+github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
+github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
 github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
 github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=
@@ -274,6 +276,8 @@ go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ
 go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
 go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.64.0 h1:RN3ifU8y4prNWeEnQp2kRRHz8UwonAEYZl8tUzHEXAk=
 go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.64.0/go.mod h1:habDz3tEWiFANTo6oUE99EmaFUrCNYAAg3wiVmusm70=
+go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.64.0 h1:ssfIgGNANqpVFCndZvcuyKbl0g+UAVcbBcqGkG28H0Y=
+go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.64.0/go.mod h1:GQ/474YrbE4Jx8gZ4q5I4hrhUzM6UPzyrqJYV2AqPoQ=
 go.opentelemetry.io/contrib/propagators/b3 v1.39.0 h1:PI7pt9pkSnimWcp5sQhUA9OzLbc3Ba4sL+VEUTNsxrk=
 go.opentelemetry.io/contrib/propagators/b3 v1.39.0/go.mod h1:5gV/EzPnfYIwjzj+6y8tbGW2PKWhcsz5e/7twptRVQY=
 go.opentelemetry.io/otel v1.39.0 h1:8yPrr/S0ND9QEfTfdP9V+SiwT4E0G7Y5MO7p85nis48=

http/client/config.go

@@ -33,4 +33,7 @@ type Config struct {
 	// IdleConnTimeout is the maximum amount of time an idle (keep-alive) connection
 	// will remain idle before closing itself.
 	IdleConnTimeout time.Duration `json:"idle_conn_timeout"`
+
+	// EnableTelemetry determines if OpenTelemetry tracing/metrics are enabled for this client.
+	EnableTelemetry bool `json:"enable_telemetry"`
 }

http/client/factory.go

@@ -4,18 +4,24 @@ import (
 	"net/http"
 	"sync"
 
+	contractsconfig "github.com/goravel/framework/contracts/config"
 	"github.com/goravel/framework/contracts/foundation"
 	"github.com/goravel/framework/contracts/http/client"
+	contractstelemetry "github.com/goravel/framework/contracts/telemetry"
 	"github.com/goravel/framework/errors"
+	telemetryhttp "github.com/goravel/framework/telemetry/instrumentation/http"
 )
 
 var _ client.Factory = (*Factory)(nil)
 
 type Factory struct {
 	client.Request
 
-	json    foundation.Json
-	config  *FactoryConfig
+	factoryConfig     *FactoryConfig
+	config            contractsconfig.Config
+	json              foundation.Json
+	telemetryResolver contractstelemetry.Resolver
+
 	clients sync.Map
 	mu      sync.RWMutex
 
@@ -24,14 +30,21 @@ type Factory struct {
 	stray     []string
 }
 
-func NewFactory(config *FactoryConfig, json foundation.Json) (*Factory, error) {
-	if config == nil {
+func NewFactory(
+	factoryConfig *FactoryConfig,
+	config contractsconfig.Config,
+	json foundation.Json,
+	telemetryResolver contractstelemetry.Resolver,
+) (*Factory, error) {
+	if factoryConfig == nil {
 		return nil, errors.HttpClientConfigNotSet
 	}
 
 	factory := &Factory{
-		config: config,
-		json:   json,
+		factoryConfig:     factoryConfig,
+		config:            config,
+		json:              json,
+		telemetryResolver: telemetryResolver,
 	}
 
 	if err := factory.bindDefault(); err != nil {
@@ -81,7 +94,7 @@ func (r *Factory) AssertSentCount(count int) bool {
 }
 
 func (r *Factory) Client(names ...string) client.Request {
-	name := r.config.Default
+	name := r.factoryConfig.Default
 	if len(names) > 0 && names[0] != "" {
 		name = names[0]
 	}
@@ -95,7 +108,7 @@ func (r *Factory) Client(names ...string) client.Request {
 		return newRequestWithError(err)
 	}
 
-	cfg := r.config.Clients[name]
+	cfg := r.factoryConfig.Clients[name]
 	return NewRequest(httpClient, r.json, cfg.BaseUrl, name)
 }
 
@@ -151,15 +164,15 @@ func (r *Factory) Sequence() client.FakeSequence {
 }
 
 func (r *Factory) bindDefault() error {
-	name := r.config.Default
+	name := r.factoryConfig.Default
 	c, err := r.resolveClient(name, r.fakeState)
 	if err != nil {
 		return err
 	}
 
 	// Bind the default client to the embedded Request implementation
 	// so that methods like Http.Get() use the default configuration.
-	r.Request = NewRequest(c, r.json, r.config.Clients[name].BaseUrl, name)
+	r.Request = NewRequest(c, r.json, r.factoryConfig.Clients[name].BaseUrl, name)
 
 	return nil
 }
@@ -184,7 +197,7 @@ func (r *Factory) resolveClient(name string, state *FakeState) (*http.Client, er
 		return val.(*http.Client), nil
 	}
 
-	cfg, ok := r.config.Clients[name]
+	cfg, ok := r.factoryConfig.Clients[name]
 	if !ok {
 		return nil, errors.HttpClientConnectionNotFound.Args(name)
 	}
@@ -198,6 +211,10 @@ func (r *Factory) resolveClient(name string, state *FakeState) (*http.Client, er
 	baseTransport.IdleConnTimeout = cfg.IdleConnTimeout
 
 	var transport http.RoundTripper = baseTransport
+	if cfg.EnableTelemetry && r.telemetryResolver != nil {
+		transport = telemetryhttp.NewTransport(r.config, r.telemetryResolver(), transport)
+	}
+
 	if state != nil {
 		// If testing mode is active, wrap the real transport with our interceptor.
 		transport = NewFakeTransport(state, baseTransport, r.json)

http/client/factory_test.go

@@ -10,18 +10,28 @@ import (
 	"time"
 
 	"github.com/stretchr/testify/suite"
+	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
+	metricnoop "go.opentelemetry.io/otel/metric/noop"
+	"go.opentelemetry.io/otel/propagation"
+	tracenoop "go.opentelemetry.io/otel/trace/noop"
 
 	"github.com/goravel/framework/contracts/foundation"
 	"github.com/goravel/framework/contracts/http/client"
+	contractstelemetry "github.com/goravel/framework/contracts/telemetry"
 	"github.com/goravel/framework/errors"
 	"github.com/goravel/framework/foundation/json"
+	mocksconfig "github.com/goravel/framework/mocks/config"
+	mockstelemetry "github.com/goravel/framework/mocks/telemetry"
 )
 
 type FactoryTestSuite struct {
 	suite.Suite
-	json    foundation.Json
-	factory *Factory
-	config  *FactoryConfig
+	json          foundation.Json
+	factory       *Factory
+	factoryConfig *FactoryConfig
+	mockConfig    *mocksconfig.Config
+	mockTelemetry *mockstelemetry.Telemetry
+	mockResolver  contractstelemetry.Resolver
 }
 
 func TestFactoryTestSuite(t *testing.T) {
@@ -30,7 +40,14 @@ func TestFactoryTestSuite(t *testing.T) {
 
 func (s *FactoryTestSuite) SetupTest() {
 	s.json = json.New()
-	s.config = &FactoryConfig{
+	s.mockConfig = mocksconfig.NewConfig(s.T())
+	s.mockTelemetry = mockstelemetry.NewTelemetry(s.T())
+
+	s.mockResolver = func() contractstelemetry.Telemetry {
+		return s.mockTelemetry
+	}
+
+	s.factoryConfig = &FactoryConfig{
 		Default: "main",
 		Clients: map[string]Config{
 			"main": {
@@ -48,7 +65,7 @@ func (s *FactoryTestSuite) SetupTest() {
 		},
 	}
 	var err error
-	s.factory, err = NewFactory(s.config, s.json)
+	s.factory, err = NewFactory(s.factoryConfig, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 }
 
@@ -77,8 +94,8 @@ func (s *FactoryTestSuite) TestClient_Resolution() {
 }
 
 func (s *FactoryTestSuite) TestErrorHandling() {
-	s.Run("handles nil config safely", func() {
-		f, err := NewFactory(nil, s.json)
+	s.Run("handles nil factoryConfig safely", func() {
+		f, err := NewFactory(nil, s.mockConfig, s.json, s.mockResolver)
 		s.Nil(f)
 		s.ErrorIs(err, errors.HttpClientConfigNotSet)
 	})
@@ -93,12 +110,12 @@ func (s *FactoryTestSuite) TestErrorHandling() {
 		s.Contains(err.Error(), "[missing_client]")
 	})
 
-	s.Run("returns lazy error when default is empty in config", func() {
+	s.Run("returns lazy error when default is empty in factoryConfig", func() {
 		cfg := &FactoryConfig{
 			Default: "",
 			Clients: map[string]Config{"main": {}},
 		}
-		f, err := NewFactory(cfg, s.json)
+		f, err := NewFactory(cfg, s.mockConfig, s.json, s.mockResolver)
 		s.ErrorIs(err, errors.HttpClientDefaultNotSet)
 		s.Nil(f)
 	})
@@ -113,7 +130,7 @@ func (s *FactoryTestSuite) TestConcurrency() {
 			"new2": {BaseUrl: "https://new2.com", Timeout: 3 * time.Second},
 		},
 	}
-	f, err := NewFactory(cfg, s.json)
+	f, err := NewFactory(cfg, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	var wg sync.WaitGroup
@@ -163,7 +180,7 @@ func (s *FactoryTestSuite) TestBaseUrl_Override() {
 			"main": {BaseUrl: "https://wrong-url.com"},
 		},
 	}
-	f, err := NewFactory(cfg, s.json)
+	f, err := NewFactory(cfg, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	s.Run("overrides config base url", func() {
@@ -182,7 +199,12 @@ func (s *FactoryTestSuite) TestProxy_HttpMethods() {
 	}))
 	defer server.Close()
 
-	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.json)
+	f, err := NewFactory(
+		&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}},
+		s.mockConfig,
+		s.json,
+		s.mockResolver,
+	)
 	s.NoError(err)
 
 	tests := []struct {
@@ -229,7 +251,12 @@ func (s *FactoryTestSuite) TestProxy_Headers() {
 	}))
 	defer server.Close()
 
-	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.json)
+	f, err := NewFactory(
+		&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}},
+		s.mockConfig,
+		s.json,
+		s.mockResolver,
+	)
 	s.NoError(err)
 
 	s.Run("WithHeader & WithHeaders", func() {
@@ -306,7 +333,7 @@ func (s *FactoryTestSuite) TestProxy_QueryParameters() {
 	}))
 	defer server.Close()
 
-	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.json)
+	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	s.Run("WithQueryParameter", func() {
@@ -342,7 +369,7 @@ func (s *FactoryTestSuite) TestProxy_UrlParameters() {
 	}))
 	defer server.Close()
 
-	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.json)
+	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	s.Run("WithUrlParameter", func() {
@@ -371,7 +398,7 @@ func (s *FactoryTestSuite) TestProxy_Cookies() {
 	}))
 	defer server.Close()
 
-	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.json)
+	f, err := NewFactory(&FactoryConfig{Default: "test", Clients: map[string]Config{"test": {BaseUrl: server.URL}}}, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	s.Run("WithCookie", func() {
@@ -423,7 +450,7 @@ func (s *FactoryTestSuite) TestRouting_Integration() {
 			"server_b": {BaseUrl: serverB.URL},
 		},
 	}
-	f, err := NewFactory(cfg, s.json)
+	f, err := NewFactory(cfg, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	s.Run("proxy methods hit default server", func() {
@@ -443,6 +470,41 @@ func (s *FactoryTestSuite) TestRouting_Integration() {
 	})
 }
 
+func (s *FactoryTestSuite) TestTelemetry_Integration() {
+	factoryConfig := &FactoryConfig{
+		Default: "telemetry_client",
+		Clients: map[string]Config{
+			"telemetry_client": {
+				BaseUrl:         "https://example.com",
+				EnableTelemetry: true,
+			},
+		},
+	}
+
+	s.mockConfig.EXPECT().GetBool("telemetry.instrumentation.http_client", true).
+		Return(true).Once()
+
+	s.mockTelemetry.EXPECT().TracerProvider().Return(tracenoop.NewTracerProvider()).Once()
+	s.mockTelemetry.EXPECT().MeterProvider().Return(metricnoop.NewMeterProvider()).Once()
+	s.mockTelemetry.EXPECT().Propagator().Return(propagation.NewCompositeTextMapPropagator()).Once()
+
+	factory, err := NewFactory(factoryConfig, s.mockConfig, s.json, s.mockResolver)
+	s.NoError(err)
+
+	req := factory.Client("telemetry_client")
+	s.NotNil(req)
+
+	concreteReq, ok := req.(*Request)
+	s.True(ok, "Request should be of type *client.Request")
+
+	httpClient := concreteReq.HttpClient()
+	s.NotNil(httpClient.Transport)
+	s.IsType(&otelhttp.Transport{}, httpClient.Transport)
+
+	_, isPlainTransport := httpClient.Transport.(*http.Transport)
+	s.False(isPlainTransport)
+}
+
 func (s *FactoryTestSuite) TestFake_GithubUserProfile() {
 	userMap := map[string]any{
 		"login": "goravel",
@@ -547,7 +609,7 @@ func (s *FactoryTestSuite) TestFactory_AllowStrayRequests() {
 	}))
 	defer server.Close()
 
-	s.factory.config.Clients["github"] = Config{BaseUrl: server.URL}
+	s.factory.factoryConfig.Clients["github"] = Config{BaseUrl: server.URL}
 	s.factory.Reset()
 
 	s.factory.Fake(nil).PreventStrayRequests().AllowStrayRequests([]string{server.URL + "/*"})
@@ -593,7 +655,7 @@ func (s *FactoryTestSuite) TestIntegration_RealServer() {
 			"local": {BaseUrl: server.URL},
 		},
 	}
-	factory, err := NewFactory(cfg, s.json)
+	factory, err := NewFactory(cfg, s.mockConfig, s.json, s.mockResolver)
 	s.NoError(err)
 
 	resp, err := factory.Post("/repos", nil)