Merge pull request #121 from foomo/add-telemetry-option

add http client telemetry option

Author: franklinkim

example/roundtripwares/requestid/main.go

@@ -53,8 +53,11 @@ func main() {
 
 	svr.AddService(
 		keel.NewServiceHTTP(l, "demo", "localhost:8080", svs,
+			// add middleware
 			middleware.RequestID(),
+			// add middleware
 			middleware.SessionID(),
+			// add middleware
 			middleware.TrackingID(),
 		),
 	)

net/http/client.go

@@ -8,6 +8,7 @@ import (
 	"net/url"
 	"time"
 
+	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
 	"go.uber.org/zap"
 
 	"github.com/foomo/keel/net/http/roundtripware"
@@ -225,6 +226,12 @@ func HTTPClientWithRoundTripware(l *zap.Logger, roundTripware ...roundtripware.R
 	}
 }
 
+func HTTPClientWithTelemetry(opts ...otelhttp.Option) HTTPClientOption {
+	return func(v *http.Client) {
+		v.Transport = otelhttp.NewTransport(v.Transport, opts...)
+	}
+}
+
 func NewHTTPClient(opts ...HTTPClientOption) *http.Client {
 	transport := &http.Transport{
 		Proxy: http.ProxyFromEnvironment,

net/http/middleware/requestid.go

@@ -3,34 +3,28 @@ package middleware
 import (
 	"net/http"
 
-	"github.com/google/uuid"
 	"go.uber.org/zap"
 
 	keelhttpcontext "github.com/foomo/keel/net/http/context"
+	"github.com/foomo/keel/net/http/provider"
 )
 
 type (
 	RequestIDOptions struct {
-		Generator         RequestIDGenerator
+		Provider          provider.RequestID
 		RequestHeader     []string
 		ResponseHeader    string
 		SetRequestHeader  bool
 		SetResponseHeader bool
 		SetContext        bool
 	}
-	RequestIDOption    func(*RequestIDOptions)
-	RequestIDGenerator func() string
+	RequestIDOption func(*RequestIDOptions)
 )
 
-// DefaultRequestIDGenerator function
-func DefaultRequestIDGenerator() string {
-	return uuid.New().String()
-}
-
 // GetDefaultRequestIDOptions returns the default options
 func GetDefaultRequestIDOptions() RequestIDOptions {
 	return RequestIDOptions{
-		Generator:         DefaultRequestIDGenerator,
+		Provider:          provider.DefaultRequestID,
 		RequestHeader:     []string{"X-Request-ID", "Cf-Ray"},
 		ResponseHeader:    "X-Request-ID",
 		SetRequestHeader:  true,
@@ -68,9 +62,9 @@ func RequestIDWithSetResponseHeader(v bool) RequestIDOption {
 }
 
 // RequestIDWithGenerator middleware option
-func RequestIDWithGenerator(v RequestIDGenerator) RequestIDOption {
+func RequestIDWithGenerator(v provider.RequestID) RequestIDOption {
 	return func(o *RequestIDOptions) {
-		o.Generator = v
+		o.Provider = v
 	}
 }
 
@@ -103,7 +97,7 @@ func RequestIDWithOptions(opts RequestIDOptions) Middleware {
 				}
 			}
 			if requestID == "" {
-				requestID = opts.Generator()
+				requestID = opts.Provider()
 			}
 			if requestID != "" && opts.SetContext {
 				r = r.WithContext(keelhttpcontext.SetRequestID(r.Context(), requestID))

net/http/provider/requestidprovider.go

@@ -0,0 +1,12 @@
+package provider
+
+import (
+	"github.com/google/uuid"
+)
+
+type RequestID func() string
+
+// DefaultRequestID function
+func DefaultRequestID() string {
+	return uuid.New().String()
+}

net/http/roundtripware/requestid.go

@@ -6,20 +6,23 @@ import (
 	"go.uber.org/zap"
 
 	keelhttpcontext "github.com/foomo/keel/net/http/context"
+	"github.com/foomo/keel/net/http/provider"
 )
 
 type (
 	RequestIDOptions struct {
-		Header string
+		Header    string
+		Provider  provider.RequestID
+		SetHeader bool
 	}
-	RequestIDOption    func(*RequestIDOptions)
-	RequestIDGenerator func() string
+	RequestIDOption func(*RequestIDOptions)
 )
 
 // GetDefaultRequestIDOptions returns the default options
 func GetDefaultRequestIDOptions() RequestIDOptions {
 	return RequestIDOptions{
-		Header: "X-Request-ID",
+		Header:   "X-Request-ID",
+		Provider: provider.DefaultRequestID,
 	}
 }
 
@@ -30,6 +33,13 @@ func RequestIDWithHeader(v string) RequestIDOption {
 	}
 }
 
+// RequestIDWithProvider middleware option
+func RequestIDWithProvider(v provider.RequestID) RequestIDOption {
+	return func(o *RequestIDOptions) {
+		o.Provider = v
+	}
+}
+
 // RequestID returns a RoundTripper which prints out the request & response object
 func RequestID(opts ...RequestIDOption) RoundTripware {
 	o := GetDefaultRequestIDOptions()
@@ -41,8 +51,15 @@ func RequestID(opts ...RequestIDOption) RoundTripware {
 	return func(l *zap.Logger, next Handler) Handler {
 		return func(r *http.Request) (*http.Response, error) {
 			if value := r.Header.Get(o.Header); value == "" {
+				var requestID string
 				if value, ok := keelhttpcontext.GetRequestID(r.Context()); ok && value != "" {
-					r.Header.Set(o.Header, value)
+					requestID = value
+				}
+				if requestID == "" {
+					requestID = o.Provider()
+				}
+				if requestID != "" {
+					r.Header.Set(o.Header, requestID)
 				}
 			}
 			return next(r)

net/http/roundtripware/requestid_test.go

@@ -0,0 +1,61 @@
+package roundtripware_test
+
+import (
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.uber.org/zap/zaptest"
+
+	keelhttp "github.com/foomo/keel/net/http"
+	keelhttpcontext "github.com/foomo/keel/net/http/context"
+	"github.com/foomo/keel/net/http/roundtripware"
+)
+
+func TestRequestID(t *testing.T) {
+	l := zaptest.NewLogger(t)
+	svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+	}))
+	defer svr.Close()
+
+	client := keelhttp.NewHTTPClient(
+		keelhttp.HTTPClientWithRoundTripware(l,
+			roundtripware.RequestID(),
+		),
+	)
+	req, err := http.NewRequestWithContext(context.Background(), http.MethodGet, svr.URL, nil)
+	require.NoError(t, err)
+	assert.Empty(t, req.Header.Get(keelhttp.HeaderXRequestID))
+
+	resp, err := client.Do(req)
+	require.NoError(t, err)
+	defer resp.Body.Close()
+	assert.NotEmpty(t, req.Header.Get(keelhttp.HeaderXRequestID))
+}
+
+func TestRequestID_Context(t *testing.T) {
+	l := zaptest.NewLogger(t)
+	svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+	}))
+	defer svr.Close()
+
+	client := keelhttp.NewHTTPClient(
+		keelhttp.HTTPClientWithRoundTripware(l,
+			roundtripware.RequestID(),
+		),
+	)
+	ctx := keelhttpcontext.SetRequestID(context.Background(), "123456")
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, svr.URL, nil)
+	require.NoError(t, err)
+	assert.Empty(t, req.Header.Get(keelhttp.HeaderXRequestID))
+
+	resp, err := client.Do(req)
+	require.NoError(t, err)
+	defer resp.Body.Close()
+	assert.Equal(t, "123456", req.Header.Get(keelhttp.HeaderXRequestID))
+}