使用 go-server-timing 实现 HTTP Server-Timing 头信息

Server-Timing 是一个 HTTP 响应头，它允许服务器在响应中发送性能指标信息，客户端可以读取这些信息用于性能分析和监控。下面我将介绍如何使用 go-server-timing 库来实现 Server-Timing 头的添加与解析。

安装 go-server-timing

首先安装 go-server-timing 库：

go get github.com/mitchellh/go-server-timing

基本使用方法

1. 添加 Server-Timing 头信息

package main

import (
	"net/http"
	"time"

	"github.com/mitchellh/go-server-timing"
)

func main() {
	// 创建新的 Server-Timing 中间件
	timing := servertiming.NewMiddleware()

	// 设置处理函数
	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		// 从请求上下文中获取 Server-Timing 对象
		timing := servertiming.FromContext(r.Context())

		// 添加计时指标
		metric := timing.NewMetric("db").WithDesc("Database query").Start()
		time.Sleep(100 * time.Millisecond) // 模拟数据库查询
		metric.Stop()

		// 添加自定义值指标
		timing.NewMetric("cache").WithDesc("Cache hit").WithDur(50 * time.Millisecond)

		w.Write([]byte("Hello, World!"))
	})

	// 使用中间件包装处理函数
	http.Handle("/", timing.Wrap(handler))
	http.ListenAndServe(":8080", nil)
}

2. 解析 Server-Timing 头信息

客户端可以解析 Server-Timing 头信息：

package main

import (
	"fmt"
	"net/http"

	"github.com/mitchellh/go-server-timing"
)

func main() {
	resp, err := http.Get("http://localhost:8080")
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	// 解析 Server-Timing 头
	timingHeader := resp.Header.Get("Server-Timing")
	metrics, err := servertiming.Parse(timingHeader)
	if err != nil {
		panic(err)
	}

	// 打印所有指标
	for _, metric := range metrics {
		fmt.Printf("Metric: %s, Duration: %v, Description: %s\n", 
			metric.Name, metric.Duration, metric.Description)
	}
}

高级用法

1. 嵌套计时

handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
	timing := servertiming.FromContext(r.Context())
	
	// 外层计时
	outer := timing.NewMetric("total").Start()
	defer outer.Stop()
	
	// 内层计时1
	inner1 := timing.NewMetric("step1").Start()
	time.Sleep(50 * time.Millisecond)
	inner1.Stop()
	
	// 内层计时2
	inner2 := timing.NewMetric("step2").Start()
	time.Sleep(30 * time.Millisecond)
	inner2.Stop()
	
	w.Write([]byte("Done"))
})

2. 使用多个中间件

func loggingMiddleware(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		start := time.Now()
		next.ServeHTTP(w, r)
		duration := time.Since(start)
		
		// 添加日志时间到 Server-Timing
		if timing := servertiming.FromContext(r.Context()); timing != nil {
			timing.NewMetric("logging").WithDur(duration).WithDesc("Logging middleware")
		}
	})
}

func main() {
	timing := servertiming.NewMiddleware()
	
	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("Hello with logging!"))
	})
	
	// 组合中间件
	http.Handle("/", loggingMiddleware(timing.Wrap(handler)))
	http.ListenAndServe(":8080", nil)
}

实际应用场景

1. 性能监控：跟踪API请求中各个阶段的耗时
2. 调试：在生产环境中识别性能瓶颈
3. A/B测试：比较不同实现方式的性能差异
4. 客户端分析：让客户端了解服务器端处理时间分布

注意事项

1. Server-Timing 头可能包含敏感信息，生产环境中应考虑过滤或禁用
2. 过多的指标会增加响应头大小，适度使用
3. 浏览器开发者工具可以可视化 Server-Timing 信息

通过 go-server-timing 库，我们可以方便地在 Go 应用中添加和解析 Server-Timing 头信息，这对于性能监控和优化非常有帮助。