Files
open-im-server/pkg/common/trace_log/ctx.go
T

193 lines
5.2 KiB
Go
Raw Normal View History

2022-12-30 18:46:02 +08:00
package trace_log
import (
"Open_IM/pkg/common/constant"
"Open_IM/pkg/common/log"
"context"
2023-01-11 19:26:17 +08:00
"google.golang.org/grpc/status"
"strings"
//"errors"
2022-12-30 18:46:02 +08:00
"fmt"
"github.com/gin-gonic/gin"
2022-12-30 19:46:26 +08:00
"net/http"
2022-12-30 18:46:02 +08:00
)
const TraceLogKey = "trace_log"
func NewCtx(c *gin.Context, api string) context.Context {
2023-01-03 14:08:29 +08:00
req := &ApiInfo{ApiName: api, GinCtx: c, Funcs: &[]FuncInfo{}}
return context.WithValue(c, TraceLogKey, req)
}
2023-01-12 10:07:08 +08:00
func NewCtx1(c *gin.Context, api, operationID string) context.Context {
req := &ApiInfo{ApiName: api, GinCtx: c, OperationID: operationID, Funcs: &[]FuncInfo{}}
return context.WithValue(c, TraceLogKey, req)
}
2023-01-04 11:06:28 +08:00
func NewRpcCtx(c context.Context, rpc string, operationID string) context.Context {
req := &ApiInfo{ApiName: rpc, Funcs: &[]FuncInfo{}}
ctx := context.WithValue(c, TraceLogKey, req)
SetOperationID(ctx, operationID)
return ctx
}
2023-01-03 14:08:29 +08:00
func SetOperationID(ctx context.Context, operationID string) {
ctx.Value(TraceLogKey).(*ApiInfo).OperationID = operationID
2022-12-30 18:46:02 +08:00
}
2023-01-09 16:37:33 +08:00
func GetOperationID(ctx context.Context) string {
return ctx.Value(TraceLogKey).(*ApiInfo).OperationID
}
2022-12-30 18:46:02 +08:00
func ShowLog(ctx context.Context) {
2023-01-03 14:08:29 +08:00
t := ctx.Value(TraceLogKey).(*ApiInfo)
2023-01-04 11:26:35 +08:00
if ctx.Value(TraceLogKey).(*ApiInfo).GinCtx != nil {
log.Info(t.OperationID, "api: ", t.ApiName)
} else {
log.Info(t.OperationID, "rpc: ", t.ApiName)
}
2023-01-03 14:08:29 +08:00
for _, v := range *t.Funcs {
2022-12-30 18:46:02 +08:00
if v.Err != nil {
2023-01-03 14:08:29 +08:00
log.Error(t.OperationID, "func: ", v.FuncName, " args: ", v.Args, v.Err.Error())
2022-12-30 18:46:02 +08:00
} else {
2023-01-03 14:08:29 +08:00
log.Info(t.OperationID, "func: ", v.FuncName, " args: ", v.Args)
2022-12-30 18:46:02 +08:00
}
}
}
2023-01-03 14:08:29 +08:00
func WriteErrorResponse(ctx context.Context, funcName string, err error, args ...interface{}) {
SetContextInfo(ctx, funcName, err, args)
2023-01-11 19:26:17 +08:00
e := Unwrap(err)
switch t := e.(type) {
case *constant.ErrInfo:
ctx.Value(TraceLogKey).(*ApiInfo).GinCtx.JSON(http.StatusOK, gin.H{"errCode": t.ErrCode, "errMsg": t.ErrMsg, "errDtl": t.DetailErrMsg})
2022-12-30 19:46:26 +08:00
return
default:
2023-01-11 19:26:17 +08:00
s, ok := status.FromError(err)
if !ok {
ctx.Value(TraceLogKey).(*ApiInfo).GinCtx.JSON(http.StatusOK, gin.H{"errCode": constant.ErrDefaultOther.ErrCode, "errMsg": err.Error(), "errDtl": fmt.Sprintf("%+v", err)})
return
}
var details []string
if err != e {
details = append(details, fmt.Sprintf("%+v", err))
}
for _, s := range s.Details() {
details = append(details, fmt.Sprintf("%+v", s))
}
2023-01-12 10:42:27 +08:00
ctx.Value(TraceLogKey).(*ApiInfo).GinCtx.JSON(http.StatusOK, gin.H{"errCode": s.Code(), "errMsg": s.Message(), "errDtl": strings.Join(details, "\n")})
2022-12-30 19:46:26 +08:00
return
2022-12-30 18:46:02 +08:00
}
}
2023-01-11 19:26:17 +08:00
//func WriteErrorResponse(ctx context.Context, funcName string, err error, args ...interface{}) {
// SetContextInfo(ctx, funcName, err, args)
// e := new(constant.ErrInfo)
// switch {
// case errors.As(err, &e):
// ctx.Value(TraceLogKey).(*ApiInfo).GinCtx.JSON(http.StatusOK, gin.H{"errCode": e.ErrCode, "errMsg": e.ErrMsg})
// return
// default:
// ctx.Value(TraceLogKey).(*ApiInfo).GinCtx.JSON(http.StatusOK, gin.H{"errCode": constant.ErrDefaultOther.ErrCode, "errMsg": constant.ErrDefaultOther.ErrMsg, "errDtl": err.Error()})
// return
// }
//}
func Unwrap(err error) error {
for err != nil {
unwrap, ok := err.(interface {
Unwrap() error
})
if !ok {
break
}
err = unwrap.Unwrap()
}
return err
}
2022-12-30 18:46:02 +08:00
type ApiInfo struct {
ApiName string
OperationID string
2023-01-03 14:08:29 +08:00
Funcs *[]FuncInfo
2022-12-30 19:46:26 +08:00
GinCtx *gin.Context
}
type FuncInfo struct {
FuncName string
2023-01-12 10:48:02 +08:00
Args Args
2022-12-30 19:46:26 +08:00
Err error
2022-12-30 18:46:02 +08:00
}
2023-01-12 10:48:02 +08:00
type Args map[string]interface{}
2023-01-12 11:14:37 +08:00
func (a Args) String() string {
var s string
var hasElement bool
for k, v := range a {
if !hasElement {
s += "{"
hasElement = true
}
2023-01-12 11:19:25 +08:00
s += fmt.Sprintf("%s:%v", k, v)
2023-01-12 11:14:37 +08:00
}
if hasElement {
s += "}"
}
return s
}
2022-12-30 18:46:02 +08:00
func SetContextInfo(ctx context.Context, funcName string, err error, args ...interface{}) {
2023-01-03 14:08:29 +08:00
t := ctx.Value(TraceLogKey).(*ApiInfo)
2022-12-30 19:46:26 +08:00
var funcInfo FuncInfo
funcInfo.Args = make(map[string]interface{})
argsHandle(args, funcInfo.Args)
2023-01-06 13:41:50 +08:00
funcInfo.FuncName = funcName
2022-12-30 19:46:26 +08:00
funcInfo.Err = err
2023-01-03 14:08:29 +08:00
*t.Funcs = append(*t.Funcs, funcInfo)
}
2023-01-04 11:06:28 +08:00
func SetRpcReqInfo(ctx context.Context, funcName string, req string) {
t := ctx.Value(TraceLogKey).(*ApiInfo)
var funcInfo FuncInfo
funcInfo.Args = make(map[string]interface{})
var args []interface{}
args = append(args, " rpc req ", req)
argsHandle(args, funcInfo.Args)
funcInfo.FuncName = funcName
*t.Funcs = append(*t.Funcs, funcInfo)
}
func SetRpcRespInfo(ctx context.Context, funcName string, resp string) {
t := ctx.Value(TraceLogKey).(*ApiInfo)
var funcInfo FuncInfo
funcInfo.Args = make(map[string]interface{})
var args []interface{}
args = append(args, " rpc resp ", resp)
argsHandle(args, funcInfo.Args)
funcInfo.FuncName = funcName
*t.Funcs = append(*t.Funcs, funcInfo)
}
2023-01-03 14:08:29 +08:00
func SetSuccess(ctx context.Context, funcName string, data interface{}) {
SetContextInfo(ctx, funcName, nil, "data", data)
2023-01-12 10:48:02 +08:00
ctx.Value(TraceLogKey).(*ApiInfo).GinCtx.JSON(http.StatusOK, gin.H{"errCode": 0, "errMsg": "", "errDtl": "", "data": data})
2022-12-30 18:46:02 +08:00
}
func argsHandle(args []interface{}, fields map[string]interface{}) {
for i := 0; i < len(args); i += 2 {
if i+1 < len(args) {
2023-01-03 14:08:29 +08:00
fields[fmt.Sprintf("%v", args[i])] = fmt.Sprintf("%+v", args[i+1])
2022-12-30 18:46:02 +08:00
} else {
fields[fmt.Sprintf("%v", args[i])] = ""
}
}
}
2023-01-03 14:08:29 +08:00
2023-01-03 14:09:51 +08:00
func GetApiErr(errCode int32, errMsg string) constant.ErrInfo {
2023-01-11 19:33:25 +08:00
2023-01-03 14:09:51 +08:00
return constant.ErrInfo{ErrCode: errCode, ErrMsg: errMsg}
2023-01-03 14:08:29 +08:00
}