fix(tracing): ignore health endpoints (#189)

tracing/middleware.go

@@ -3,6 +3,7 @@ package tracing
 
 import (
 	"net/http"
+	"strings"
 
 	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/opentracing/opentracing-go/ext"
@@ -13,6 +14,12 @@ func (t *Tracer) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.Ha
 	var span opentracing.Span
 	opName := r.URL.Path
 
+	// Omit health endpoints
+	if strings.HasPrefix(opName, "/health/") {
+		next(rw, r)
+		return
+	}
+
 	// It's very possible that Hydra is fronted by a proxy which could have initiated a trace.
 	// If so, we should attempt to join it.
 	remoteContext, err := opentracing.GlobalTracer().Extract(

tracing/middleware_test.go

@@ -94,3 +94,35 @@ func TestShouldContinueTraceIfAlreadyPresent(t *testing.T) {
 
 	assert.Equal(t, parentSpan.SpanContext.SpanID, span.ParentID)
 }
+
+func TestShouldNotTraceHealthEndpoint(t *testing.T) {
+	testCases := []struct {
+		path            string
+		testDescription string
+	}{
+		{
+			path:            "health/ready",
+			testDescription: "ready",
+		},
+		{
+			path:            "health/alive",
+			testDescription: "alive",
+		},
+	}
+	for _, test := range testCases {
+		t.Run(test.testDescription, func(t *testing.T) {
+			defer mockedTracer.Reset()
+			request := httptest.NewRequest(http.MethodGet, "https://apis.somecompany.com/"+test.path, nil)
+
+			next := func(rw http.ResponseWriter, _ *http.Request) {
+				rw.WriteHeader(http.StatusOK)
+			}
+
+			tracer.ServeHTTP(negroni.NewResponseWriter(httptest.NewRecorder()), request, next)
+
+			spans := mockedTracer.FinishedSpans()
+			assert.Len(t, spans, 0)
+
+		})
+	}
+}