feat(telemetry): implement request tracing identifier

Introduce a middleware layer to attach a unique identifier to each HTTP request for observability purposes. The identifier is propagated via the X-Request-ID header, allowing for correlation of logs and events across distributed system components.
This commit is contained in:
zenfun
2025-12-13 23:49:58 +08:00
parent a6b4306d08
commit 531ac6e5a8
8 changed files with 30 additions and 224 deletions

View File

@@ -8,6 +8,7 @@ import (
"github.com/ez-api/ez-api/internal/dto"
"github.com/ez-api/ez-api/internal/model"
"github.com/ez-api/ez-api/internal/service"
"github.com/ez-api/foundation/provider"
"github.com/gin-gonic/gin"
"gorm.io/gorm"
)
@@ -43,6 +44,9 @@ func (h *Handler) CreateProvider(c *gin.Context) {
return
}
providerType := provider.NormalizeType(req.Type)
googleLocation := provider.DefaultGoogleLocation(providerType, req.GoogleLocation)
group := strings.TrimSpace(req.Group)
if group == "" {
group = "default"
@@ -59,11 +63,11 @@ func (h *Handler) CreateProvider(c *gin.Context) {
provider := model.Provider{
Name: req.Name,
Type: req.Type,
Type: strings.TrimSpace(req.Type),
BaseURL: req.BaseURL,
APIKey: req.APIKey,
GoogleProject: strings.TrimSpace(req.GoogleProject),
GoogleLocation: strings.TrimSpace(req.GoogleLocation),
GoogleLocation: googleLocation,
Group: group,
Models: strings.Join(req.Models, ","),
Status: status,
@@ -122,12 +126,18 @@ func (h *Handler) UpdateProvider(c *gin.Context) {
return
}
nextType := strings.TrimSpace(existing.Type)
if t := strings.TrimSpace(req.Type); t != "" {
nextType = t
}
nextTypeLower := provider.NormalizeType(nextType)
update := map[string]any{}
if strings.TrimSpace(req.Name) != "" {
update["name"] = req.Name
}
if strings.TrimSpace(req.Type) != "" {
update["type"] = req.Type
update["type"] = strings.TrimSpace(req.Type)
}
if strings.TrimSpace(req.BaseURL) != "" {
update["base_url"] = req.BaseURL
@@ -140,6 +150,8 @@ func (h *Handler) UpdateProvider(c *gin.Context) {
}
if strings.TrimSpace(req.GoogleLocation) != "" {
update["google_location"] = strings.TrimSpace(req.GoogleLocation)
} else if provider.IsVertexFamily(nextTypeLower) && strings.TrimSpace(existing.GoogleLocation) == "" {
update["google_location"] = provider.DefaultGoogleLocation(nextTypeLower, "")
}
if req.Models != nil {
update["models"] = strings.Join(req.Models, ",")

View File

@@ -1,17 +0,0 @@
package jsoncodec
import (
"io"
"github.com/bytedance/sonic"
)
func Marshal(v any) ([]byte, error) { return sonic.Marshal(v) }
func Unmarshal(data []byte, v any) error { return sonic.Unmarshal(data, v) }
func UnmarshalString(data string, v any) error { return sonic.UnmarshalString(data, v) }
func NewEncoder(w io.Writer) sonic.Encoder { return sonic.ConfigDefault.NewEncoder(w) }
func NewDecoder(r io.Reader) sonic.Decoder { return sonic.ConfigDefault.NewDecoder(r) }

View File

@@ -1,63 +0,0 @@
package logging
import (
"log/slog"
"os"
"strings"
"time"
"github.com/rs/zerolog"
)
type Options struct {
Service string
}
func New(opts Options) (*slog.Logger, zerolog.Logger) {
level := parseLevel(strings.TrimSpace(os.Getenv("EZ_LOG_LEVEL")))
zerolog.SetGlobalLevel(toZerologLevel(level))
output := zerolog.ConsoleWriter{
Out: os.Stdout,
TimeFormat: time.RFC3339,
}
zl := zerolog.New(output).
Level(toZerologLevel(level)).
With().
Timestamp().
Str("service", strings.TrimSpace(opts.Service)).
Logger()
sl := slog.New(NewZerologHandler(zl, level))
slog.SetDefault(sl)
return sl, zl
}
func parseLevel(raw string) slog.Level {
switch strings.ToLower(raw) {
case "debug":
return slog.LevelDebug
case "warn", "warning":
return slog.LevelWarn
case "error":
return slog.LevelError
case "info", "":
return slog.LevelInfo
default:
return slog.LevelInfo
}
}
func toZerologLevel(level slog.Level) zerolog.Level {
switch {
case level <= slog.LevelDebug:
return zerolog.DebugLevel
case level <= slog.LevelInfo:
return zerolog.InfoLevel
case level <= slog.LevelWarn:
return zerolog.WarnLevel
default:
return zerolog.ErrorLevel
}
}

View File

@@ -1,133 +0,0 @@
package logging
import (
"context"
"fmt"
"log/slog"
"strings"
"github.com/rs/zerolog"
)
type ZerologHandler struct {
logger zerolog.Logger
level slog.Level
attrs []slog.Attr
groups []string
}
func NewZerologHandler(logger zerolog.Logger, level slog.Level) *ZerologHandler {
return &ZerologHandler{
logger: logger,
level: level,
}
}
func (h *ZerologHandler) Enabled(_ context.Context, level slog.Level) bool {
return level >= h.level
}
func (h *ZerologHandler) Handle(_ context.Context, record slog.Record) error {
event := h.eventFor(record.Level)
if event == nil {
return nil
}
for _, attr := range h.attrs {
h.addAttr(event, h.key(attr.Key), attr.Value)
}
record.Attrs(func(attr slog.Attr) bool {
h.addAttr(event, h.key(attr.Key), attr.Value)
return true
})
event.Msg(record.Message)
return nil
}
func (h *ZerologHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
cp := h.clone()
cp.attrs = append(cp.attrs, attrs...)
return cp
}
func (h *ZerologHandler) WithGroup(name string) slog.Handler {
if strings.TrimSpace(name) == "" {
return h
}
cp := h.clone()
cp.groups = append(cp.groups, name)
return cp
}
func (h *ZerologHandler) clone() *ZerologHandler {
cp := *h
cp.attrs = append([]slog.Attr(nil), h.attrs...)
cp.groups = append([]string(nil), h.groups...)
return &cp
}
func (h *ZerologHandler) key(k string) string {
k = strings.TrimSpace(k)
if k == "" {
return ""
}
if len(h.groups) == 0 {
return k
}
return strings.Join(h.groups, ".") + "." + k
}
func (h *ZerologHandler) eventFor(level slog.Level) *zerolog.Event {
switch {
case level >= slog.LevelError:
return h.logger.Error()
case level >= slog.LevelWarn:
return h.logger.Warn()
case level >= slog.LevelInfo:
return h.logger.Info()
default:
return h.logger.Debug()
}
}
func (h *ZerologHandler) addAttr(event *zerolog.Event, key string, value slog.Value) {
if event == nil || strings.TrimSpace(key) == "" {
return
}
value = value.Resolve()
switch value.Kind() {
case slog.KindGroup:
for _, groupAttr := range value.Group() {
groupKey := h.key(key + "." + groupAttr.Key)
h.addAttr(event, groupKey, groupAttr.Value.Resolve())
}
case slog.KindString:
event.Str(key, value.String())
case slog.KindBool:
event.Bool(key, value.Bool())
case slog.KindInt64:
event.Int64(key, value.Int64())
case slog.KindUint64:
event.Uint64(key, value.Uint64())
case slog.KindFloat64:
event.Float64(key, value.Float64())
case slog.KindDuration:
event.Dur(key, value.Duration())
case slog.KindTime:
event.Time(key, value.Time())
default:
anyValue := value.Any()
if err, ok := anyValue.(error); ok {
event.AnErr(key, err)
return
}
if stringer, ok := anyValue.(fmt.Stringer); ok {
event.Str(key, stringer.String())
return
}
event.Interface(key, anyValue)
}
}

View File

@@ -6,9 +6,9 @@ import (
"strings"
"time"
"github.com/ez-api/ez-api/internal/jsoncodec"
"github.com/ez-api/ez-api/internal/model"
"github.com/ez-api/ez-api/internal/util"
"github.com/ez-api/foundation/jsoncodec"
"github.com/redis/go-redis/v9"
"gorm.io/gorm"
)