~james/core

core/spindle/observability/tracing_test.go -rw-r--r-- 3.0 KiB
452f17b7 — james chore(import): snapshot james.dad.town/core at f70c71c7696a 16 hours ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
package observability

import (
	"context"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/go-chi/chi/v5"
	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/attribute"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
	"go.opentelemetry.io/otel/sdk/trace/tracetest"
	"go.opentelemetry.io/otel/trace"
)

func TestTraceContextRoundTrip(t *testing.T) {
	want := trace.NewSpanContext(trace.SpanContextConfig{
		TraceID:    trace.TraceID{1},
		SpanID:     trace.SpanID{2},
		TraceFlags: trace.FlagsSampled,
		Remote:     true,
	})
	ctx := trace.ContextWithRemoteSpanContext(context.Background(), want)

	traceparent, tracestate := InjectToTraceparentAndTracestate(ctx)
	if traceparent == "" {
		t.Fatal("traceparent is empty")
	}

	got := trace.SpanContextFromContext(ExtractFromTraceparentAndTracestate(context.Background(), traceparent, tracestate))
	if got.TraceID() != want.TraceID() || got.SpanID() != want.SpanID() || !got.IsSampled() || !got.IsRemote() {
		t.Fatalf("span context = %v, want %v", got, want)
	}
}

func TestOTelRouteMiddlewareUsesRouteTemplate(t *testing.T) {
	oldProvider := otel.GetTracerProvider()
	recorder := tracetest.NewSpanRecorder()
	provider := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(recorder))
	otel.SetTracerProvider(provider)
	t.Cleanup(func() {
		_ = provider.Shutdown(context.Background())
		otel.SetTracerProvider(oldProvider)
	})

	router := chi.NewRouter()
	router.Use(OTelRouteMiddleware)
	router.Get("/things/{id}", func(w http.ResponseWriter, _ *http.Request) {
		w.WriteHeader(http.StatusNoContent)
	})
	handler := otelhttp.NewHandler(router, "HTTP")

	request := httptest.NewRequest(http.MethodGet, "/things/raw-user-id", nil)
	response := httptest.NewRecorder()
	handler.ServeHTTP(response, request)

	spans := recorder.Ended()
	if len(spans) != 1 {
		t.Fatalf("ended spans = %d, want 1", len(spans))
	}
	if got := spans[0].Name(); got != "HTTP /things/{id}" {
		t.Fatalf("span name = %q, want route template", got)
	}
	for _, attr := range spans[0].Attributes() {
		if attr.Key == attribute.Key("http.route") && attr.Value.AsString() == "/things/{id}" {
			return
		}
	}
	t.Fatal("http.route template attribute is missing")
}

func TestTracingConstants(t *testing.T) {
	tests := []struct {
		got  string
		want string
	}{
		{UserDIDKey, "tangled.user.did"},
		{OwnerDIDKey, "tangled.owner.did"},
		{RepoDIDKey, "tangled.repo.did"},
		{TargetRepoDIDKey, "tangled.repo.target.did"},
		{PipelineIDKey, "tangled.pipeline.id"},
		{WorkflowIDKey, "tangled.workflow.id"},
		{WorkflowEngineKey, "tangled.workflow.engine"},
		{LeaseIDKey, "tangled.lease.id"},
		{ExecutorNodeIDKey, "tangled.executor.node_id"},
		{JobIDKey, "tangled.job.id"},
		{RequestIDKey, "tangled.request.id"},
		{CollectionKey, "atproto.collection"},
		{RKeyKey, "atproto.rkey"},
		{StepNameKey, "tangled.step.name"},
		{StepIndexKey, "tangled.step.index"},
	}
	for _, tc := range tests {
		if tc.got != tc.want {
			t.Errorf("got %q, want %q", tc.got, tc.want)
		}
	}
}