improve shim layer, add event support

Author: wxiaoguang

modules/gtprof/event.go

@@ -0,0 +1,32 @@
+// Copyright 2025 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package gtprof
+
+type EventConfig struct {
+	attributes []*TraceAttribute
+}
+
+type EventOption interface {
+	applyEvent(*EventConfig)
+}
+
+type applyEventFunc func(*EventConfig)
+
+func (f applyEventFunc) applyEvent(cfg *EventConfig) {
+	f(cfg)
+}
+
+func WithAttributes(attrs ...*TraceAttribute) EventOption {
+	return applyEventFunc(func(cfg *EventConfig) {
+		cfg.attributes = append(cfg.attributes, attrs...)
+	})
+}
+
+func eventConfigFromOptions(options ...EventOption) *EventConfig {
+	cfg := &EventConfig{}
+	for _, opt := range options {
+		opt.applyEvent(cfg)
+	}
+	return cfg
+}

modules/gtprof/trace.go

@@ -23,6 +23,8 @@ type traceStarter interface {
 }
 
 type traceSpanInternal interface {
+	addEvent(name string, cfg *EventConfig)
+	recordError(err error, cfg *EventConfig)
 	end()
 }
 
@@ -35,9 +37,11 @@ type TraceSpan struct {
 	// mutable, must be protected by mutex
 	mu         sync.RWMutex
 	name       string
+	statusCode uint32
+	statusDesc string
 	startTime  time.Time
 	endTime    time.Time
-	attributes []TraceAttribute
+	attributes []*TraceAttribute
 	children   []*TraceSpan
 }
 
@@ -70,11 +74,31 @@ type Tracer struct {
 	starters []traceStarter
 }
 
+func (s *TraceSpan) SetStatus(code uint32, desc string) {
+	s.mu.Lock()
+	defer s.mu.Unlock()
+	s.statusCode, s.statusDesc = code, desc
+}
+
+func (s *TraceSpan) AddEvent(name string, options ...EventOption) {
+	cfg := eventConfigFromOptions(options...)
+	for _, tsp := range s.internalSpans {
+		tsp.addEvent(name, cfg)
+	}
+}
+
+func (s *TraceSpan) RecordError(err error, options ...EventOption) {
+	cfg := eventConfigFromOptions(options...)
+	for _, tsp := range s.internalSpans {
+		tsp.recordError(err, cfg)
+	}
+}
+
 func (s *TraceSpan) SetAttributeString(key, value string) *TraceSpan {
 	s.mu.Lock()
 	defer s.mu.Unlock()
 
-	s.attributes = append(s.attributes, TraceAttribute{Key: key, Value: TraceValue{v: value}})
+	s.attributes = append(s.attributes, &TraceAttribute{Key: key, Value: TraceValue{v: value}})
 	return s
 }
 

modules/gtprof/trace_builtin.go

@@ -21,6 +21,16 @@ type traceBuiltinSpan struct {
 	internalSpanIdx int
 }
 
+func (t *traceBuiltinSpan) addEvent(name string, cfg *EventConfig) {
+	// No-op because builtin tracer doesn't need it.
+	// In the future we might use it to mark the time point between backend logic and network response.
+}
+
+func (t *traceBuiltinSpan) recordError(err error, cfg *EventConfig) {
+	// No-op because builtin tracer doesn't need it.
+	// Actually Gitea doesn't handle err this way in most cases
+}
+
 func (t *traceBuiltinSpan) toString(out *strings.Builder, indent int) {
 	t.ts.mu.RLock()
 	defer t.ts.mu.RUnlock()

modules/gtprof/trace_test.go

@@ -35,6 +35,10 @@ type testTraceSpan struct {
 	vendorSpan *vendorSpan
 }
 
+func (t *testTraceSpan) addEvent(name string, cfg *EventConfig) {}
+
+func (t *testTraceSpan) recordError(err error, cfg *EventConfig) {}
+
 func (t *testTraceSpan) end() {}
 
 type testTraceStarter struct{}