Go v1.19集成Bugsnag触发invalid api key空值错误问题排查

问题根源 #

1. 全局Bugsnag配置未初始化：你调用bugsnag.Notify时使用的是Bugsnag的全局默认客户端，但并没有通过bugsnag.Configure()对其进行配置，导致APIKey为空。
2. AutoNotify中间件未挂载：你的BugsnagAutoNotify()函数仅返回了中间件实例，但没有将其添加到Gin路由中，该中间件的配置仅对自身生效，无法作用于全局的bugsnag.Notify调用。

修复代码 #

方式一：初始化全局配置 + 挂载中间件 #

修改init函数和路由初始化逻辑，先配置全局Bugsnag，再挂载中间件：

package main

import (
    "fmt"
    "github.com/bugsnag/bugsnag-go"
    bugsnaggin "github.com/bugsnag/bugsnag-go-gin"
    "github.com/gin-gonic/gin"
)

// 假设这两个变量已通过环境变量/配置文件正确赋值
var (
    bugsnagApiKey     string
    bugsnagAppVersion string
)

func init() {
    // 初始化全局Bugsnag配置，让bugsnag.Notify可以直接使用
    bugsnag.Configure(bugsnag.Configuration{
        APIKey:          bugsnagApiKey,
        ProjectPackages: []string{"main"},
        AppVersion:      bugsnagAppVersion,
    })
}

func main() {
    InitRoutes()
}

type Route struct {
    Method     string
    Url        string
    HandlerFunc gin.HandlerFunc
}

var routes = []Route{
    {"GET", "/test", test},
}

func InitRoutes() {
    router := gin.Default()
    // 挂载Bugsnag的AutoNotify中间件到全局路由
    router.Use(bugsnaggin.AutoNotify())
    for _, route := range routes {
        switch route.Method {
        case "GET":
            router.GET(route.Url, route.HandlerFunc)
        case "POST":
            router.POST(route.Url, route.HandlerFunc)
        default:
            router.GET(route.Url, func(c *gin.Context) {
                c.JSON(200, gin.H{
                    "result": "Specify a valid http method with this route.",
                })
            })
        }
    }
    router.Run(":8080")
}

// 示例test处理器
func test(c *gin.Context) {
    err := someErrorFunc()
    if err != nil {
        // 现在可以正常调用全局的bugsnag.Notify
        metadata := bugsnag.Metadata{"test": {"path": c.Request.URL.Path}}
        bugsnag.Notify(err, metadata)
        c.JSON(500, gin.H{"error": "something went wrong"})
    }
}

func someErrorFunc() error {
    return fmt.Errorf("test error")
}

方式二：从Gin Context获取Bugsnag客户端（不依赖全局配置） #

如果不想初始化全局配置，可在处理器中通过Context获取中间件的Bugsnag客户端：

// 修改test处理器
func test(c *gin.Context) {
    err := someErrorFunc()
    if err != nil {
        // 从gin context中获取Bugsnag客户端
        bugsnagClient := bugsnaggin.Client(c)
        metadata := bugsnag.Metadata{"test": {"path": c.Request.URL.Path}}
        bugsnagClient.Notify(err, metadata)
        c.JSON(500, gin.H{"error": "something went wrong"})
    }
}

额外注意事项 #

• 确保bugsnagApiKey和bugsnagAppVersion已被正确赋值（比如通过环境变量、配置文件读取），避免为空。
• 若通过Linux service运行应用，需确保环境变量（如果用来配置APIKey）在service文件中正确设置，避免因环境变量未加载导致APIKey为空。

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