Go实现Datadog追踪时如何记录仅含占位符无实参的URL路由

核心逻辑：*http.Request对象本身仅存储实际发起请求的真实路径，不会保留你注册路由时定义的带占位符的模板字符串，这个模板值由你使用的Web路由框架在路由匹配阶段持有，需要从对应框架的上下文接口获取，不同常用框架的获取方式如下：

• 基于gorilla/mux路由的场景：匹配路由后直接调用mux提供的方法读取当前路由的路径模板

func yourHandler(w http.ResponseWriter, r *http.Request) {
    currentRoute := mux.CurrentRoute(r)
    pathTemplate, err := currentRoute.GetPathTemplate()
    if err == nil {
        // 拿到的pathTemplate就是/user/{user_id}/profile格式的带占位符路径，直接用于日志记录、Datadog span属性赋值即可
    }
}

• 基于Gin框架的场景：调用Gin上下文自带的FullPath()方法即可

func yourHandler(c *gin.Context) {
    pathTemplate := c.FullPath()
    // 返回值为注册路由时定义的带占位符路径，比如/user/:user_id/profile
}

• 基于Echo框架的场景：调用Echo上下文的Path()方法即可

func yourHandler(c echo.Context) error {
    pathTemplate := c.Path()
    // 拿到对应路由的模板字符串
    return nil
}

• 基于Chi路由的场景：从请求上下文中取Chi的路由上下文，读取路由模式字段

func yourHandler(w http.ResponseWriter, r *http.Request) {
    routeContext := chi.RouteContext(r.Context())
    pathTemplate := routeContext.RoutePattern()
}

Datadog链路适配注意事项 #

• 拿到带占位符的路径模板后，直接将该值赋值给对应span的resource.name属性即可，不要使用r.URL.Path这类带实际参数值的路径，否则会导致链路按不同参数值拆分，无法按路由聚合，日志也会泄露参数实际取值。
• 如果你已经引入了Datadog官方对应Web框架的追踪集成包，新版本的集成包默认已经实现了自动读取路由模板设置span属性的逻辑，可以先升级tracer版本确认是否无需手动编码实现。

内容的提问来源于stack exchange，提问作者user782400