spannerotel

spannerotel

OpenTelemetry helpers for cloud.google.com/go/spanner:

• interceptor/ — gRPC stream interceptor that decorates spans with query stats and GFE timing
• internal/plantotrace/ — PROFILE plan node spans (requires query plan in ResultSetStats)
• tracing/ — TracerProvider setup for Cloud Trace, OTLP/gRPC, or stderr JSON export

Spanner v1.90+ emits traces via OpenTelemetry natively; an OpenCensus bridge is not required.

Usage

import (
	"cloud.google.com/go/spanner"
	"github.com/apstndb/spannerotel/interceptor"
	"github.com/apstndb/spannerotel/tracing"
	"google.golang.org/api/option"
	"google.golang.org/grpc"
)

tp, err := tracing.NewTracerProvider(tracing.Config{
	Exporter:    tracing.ExporterOTLP,
	ServiceName: "my-app",
	OTLPEndpoint: "localhost:4317",
	OTLPInsecure: true,
})
if err != nil {
	// handle error
}
defer tracing.Shutdown(ctx, tp)

client, err := spanner.NewClientWithConfig(ctx, database, spanner.ClientConfig{},
	option.WithGRPCDialOption(grpc.WithChainStreamInterceptor(
		interceptor.StreamInterceptor(interceptor.WithDefaultDecorators()),
	)),
)

Exporters

Plan node spans from plantotrace appear only when the Spanner client returns a PROFILE query plan in stats.

See example/query for a PROFILE query with stderr tracing.