go/sktrace/sktrace.go

// sktrace is an EXPERIMENTAL package with utility functions for the go.opencensus.io/trace package.
// Subject to change.
package sktrace

import (
	"net/http"

	"contrib.go.opencensus.io/exporter/stackdriver"
	"go.opencensus.io/trace"
	"go.skia.org/infra/go/sklog"
	"golang.org/x/oauth2"
)

// TODO(stephana): Re-add Jaeger as a local option when the Go package is stable
// again.

// TraceClient wraps the information relevant for tracing of the current host.
// It currently assumes that the node runs one application. This might change in
// the future as the trace api (see https://opencensus.io) evolves.
type TraceClient struct {
	serviceName string
}

// NewTraceClient returns a new trace client instance.
func NewTraceClient(projectID, serviceName string, tokenSrc oauth2.TokenSource) (*TraceClient, error) {
	var exporter trace.Exporter
	var err error

	sdOptions := stackdriver.Options{
		ProjectID: projectID,
	}
	if exporter, err = stackdriver.NewExporter(sdOptions); err != nil {
		return nil, sklog.FmtErrorf("Error creating stackdriver exporter: %s", err)
	}
	sklog.Infof("StackDriver trace exporter created.")

	trace.RegisterExporter(exporter)
	trace.ApplyConfig(trace.Config{DefaultSampler: trace.AlwaysSample()})
	return &TraceClient{
		serviceName: serviceName,
	}, nil
}

// Trace wraps a given pattern and handler function and sets up tracing for it.
// A client should call it like this when they set up their route:
//
//  	router.HandleFunc(tracing.Trace("/url/path", handler)).Methods("GET")
//
// Inside the 'handler' function they can retrieve the contex via r.Context()
// where 'r' is the http.Request object and pass it around for more detailed
// tracing.
func (t *TraceClient) Trace(pattern string, handler func(http.ResponseWriter, *http.Request)) (string, func(http.ResponseWriter, *http.Request)) {
	spanURL := t.serviceName + pattern
	return pattern, func(w http.ResponseWriter, r *http.Request) {
		ctx := r.Context()
		ctx, span := trace.StartSpan(ctx, spanURL)
		span.AddAttributes(trace.StringAttribute("service", t.serviceName))
		defer span.End()

		// If the context was created in the Context() call we need to make sure
		// it's also the context the request carries from here on.
		// Note: This makes a shallow copy of the request.
		handler(w, r.WithContext(ctx))
	}
}