116 lines
3.8 KiB
Go
116 lines
3.8 KiB
Go
// feerror_handler.go Day 53(runbook §6.4 P0):前端错误上报端点。
|
|
// - POST /fe-errors 上报(public:登录页 JS 错误/网络层 5xx 也须可达;引擎级 IP 限流兜底)
|
|
// - GET /fe-errors 排障查询(admin/ops;kind 过滤+分页,id DESC 最新在前)
|
|
//
|
|
// 采集侧:web/src/utils/error-reporter.ts(window.onerror/unhandledrejection)+
|
|
// request.ts 响应拦截器(5xx/网络错误,带 X-Trace-Id 关联后端日志链)。
|
|
package v1
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"gorm.io/gorm"
|
|
|
|
"go-sms/internal/middleware"
|
|
"go-sms/internal/model/entity"
|
|
"go-sms/internal/pkg/response"
|
|
)
|
|
|
|
// feErrorPayload 上报体(前端单条;批量由多次上报承担,保持接口最小)。
|
|
type feErrorPayload struct {
|
|
Kind string `json:"kind"` // js|http|unhandled
|
|
PageURL string `json:"page_url"` // window.location.href
|
|
Message string `json:"message"`
|
|
Stack string `json:"stack"`
|
|
UA string `json:"ua"` // navigator.userAgent
|
|
TraceID string `json:"trace_id"` // 请求 X-Trace-Id(HTTP 类错误关联后端)
|
|
}
|
|
|
|
// feErrorFieldMax 字段截断上限(与实体列宽一致,防超长栈打爆 INSERT)。
|
|
var feErrorFieldMax = map[string]int{"page_url": 512, "message": 1024, "stack": 8192, "ua": 512, "trace_id": 64}
|
|
|
|
func feTrunc(field, s string) string {
|
|
if max, ok := feErrorFieldMax[field]; ok && len(s) > max {
|
|
return s[:max]
|
|
}
|
|
return s
|
|
}
|
|
|
|
// feKindAllowed 上报类型白名单(未知值归一 js,防标签基数滥用)。
|
|
func feKindAllowed(k string) string {
|
|
switch k {
|
|
case "http", "unhandled":
|
|
return k
|
|
default:
|
|
return "js"
|
|
}
|
|
}
|
|
|
|
type feErrorHandler struct{ db *gorm.DB }
|
|
|
|
// registerFeErrorRoutes 挂载前端错误上报路由。
|
|
func registerFeErrorRoutes(rg *gin.RouterGroup, protected *gin.RouterGroup, db *gorm.DB, perm middleware.PermissionChecker) {
|
|
if db == nil {
|
|
return
|
|
}
|
|
h := &feErrorHandler{db: db}
|
|
rg.POST("/fe-errors", h.report)
|
|
protected.GET("/fe-errors",
|
|
middleware.RequirePermission(perm, "system", "read"), h.list)
|
|
}
|
|
|
|
// report POST /fe-errors:落库即成功(上报通道自身永不抛业务错,防前端重试风暴)。
|
|
func (h *feErrorHandler) report(c *gin.Context) {
|
|
var p feErrorPayload
|
|
if err := c.ShouldBindJSON(&p); err != nil {
|
|
// 畸形体也按成功应答:错误上报是尽力而为通道,客户端无需重试
|
|
response.Success(c, nil)
|
|
return
|
|
}
|
|
row := entity.FeErrorLog{
|
|
Kind: feKindAllowed(p.Kind),
|
|
PageURL: feTrunc("page_url", strings.TrimSpace(p.PageURL)),
|
|
Message: feTrunc("message", strings.TrimSpace(p.Message)),
|
|
Stack: feTrunc("stack", p.Stack),
|
|
UA: feTrunc("ua", p.UA),
|
|
TraceID: feTrunc("trace_id", strings.TrimSpace(p.TraceID)),
|
|
}
|
|
if row.Message == "" && row.Stack == "" {
|
|
response.Success(c, nil) // 空上报不落库
|
|
return
|
|
}
|
|
if err := h.db.WithContext(c.Request.Context()).Create(&row).Error; err != nil {
|
|
// 落库失败也不回错误码:前端侧静默(runbook:上报失败不阻塞业务)
|
|
_ = c.Error(err)
|
|
}
|
|
response.Success(c, nil)
|
|
}
|
|
|
|
// list GET /fe-errors:排障查询(kind 过滤+分页,id DESC)。
|
|
func (h *feErrorHandler) list(c *gin.Context) {
|
|
page := atoiDefault(c.Query("page"), 1)
|
|
pageSize := atoiDefault(c.Query("page_size"), 20)
|
|
if pageSize > 100 {
|
|
pageSize = 100
|
|
}
|
|
q := h.db.WithContext(c.Request.Context()).Model(&entity.FeErrorLog{})
|
|
if kind := strings.TrimSpace(c.Query("kind")); kind != "" {
|
|
q = q.Where("kind = ?", kind)
|
|
}
|
|
if tid := strings.TrimSpace(c.Query("trace_id")); tid != "" {
|
|
q = q.Where("trace_id = ?", tid)
|
|
}
|
|
var total int64
|
|
if err := q.Count(&total).Error; err != nil {
|
|
bizResp(c, err)
|
|
return
|
|
}
|
|
var rows []entity.FeErrorLog
|
|
if err := q.Order("id DESC").Offset((page - 1) * pageSize).Limit(pageSize).Find(&rows).Error; err != nil {
|
|
bizResp(c, err)
|
|
return
|
|
}
|
|
response.Success(c, gin.H{"list": rows, "total": total})
|
|
}
|