Move into generic coder/tracer package

f0ssel · f0ssel · commit 9ce5328ef5a5 · 2022-03-25T15:27:27.000Z
diff --git a/cli/start.go b/cli/start.go
@@ -36,7 +36,7 @@ import (
 	"github.com/coder/coder/provisionerd"
 	"github.com/coder/coder/provisionersdk"
 	"github.com/coder/coder/provisionersdk/proto"
-	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
+	"github.com/coder/coder/tracer"
 )
 
 func start() *cobra.Command {
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -14,7 +14,7 @@ import (
 	"github.com/coder/coder/httpapi"
 	"github.com/coder/coder/httpmw"
 	"github.com/coder/coder/site"
-	chitrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/go-chi/chi.v5"
+	"github.com/coder/coder/tracer"
 )
 
 // Options are requires parameters for Coder to start.
@@ -42,7 +42,7 @@ func New(options *Options) (http.Handler, func()) {
 
 	r := chi.NewRouter()
 	r.Route("/api/v2", func(r chi.Router) {
-		r.Use(chitrace.Middleware())
+		r.Use(tracer.Middleware())
 		r.Get("/", func(w http.ResponseWriter, r *http.Request) {
 			httpapi.Write(w, http.StatusOK, httpapi.Response{
 				Message: "👋",
diff --git a/tracer/tracer.go b/tracer/tracer.go
@@ -0,0 +1,33 @@
+// Package tracer provides application tracing and performance monitoring utilities.
+package tracer
+
+import (
+	"net/http"
+
+	chitrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/go-chi/chi.v5"
+	ddtracer "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
+)
+
+// Starts the global tracer.
+// Call as early as possible in the application to capture the most data.
+// You must call Stop() to ensure all spans are properly flushed before exit.
+//
+// Common Usage:
+//
+// tracer.Start()
+// defer tracer.Stop()
+//
+func Start() {
+	ddtracer.Start()
+}
+
+// Stops the global tracer.
+// Should be called at the end of the program to flush the remaining traces.
+func Stop() {
+	ddtracer.Stop()
+}
+
+// Middleware will wrap a trace span around the next http.Handler.
+func Middleware() func(next http.Handler) http.Handler {
+	return chitrace.Middleware()
+}

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ import (`
`36`	`36`	`"github.com/coder/coder/provisionerd"`
`37`	`37`	`"github.com/coder/coder/provisionersdk"`
`38`	`38`	`"github.com/coder/coder/provisionersdk/proto"`
`39`		`- "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"`
	`39`	`+ "github.com/coder/coder/tracer"`
`40`	`40`	`)`
`41`	`41`
`42`	`42`	`func start() *cobra.Command {`