webhook

slog: Webhook 处理器

为 slog 库提供通用格式化器 + 构建自定义格式化器的助手。

🚀 安装

go get github.com/samber/slog-webhook/v2

兼容性: go >= 1.23

在 v3.0.0 之前，不会对导出的 API 进行破坏性更改。

💡 使用方法

GoDoc: https://pkg.go.dev/github.com/samber/slog-webhook/v2

处理器选项

type Option struct {
  // 日志级别 (默认: debug)
  Level     slog.Leveler

  // URL
  Endpoint string
  Timeout  time.Duration // 默认: 10s

  // 可选: 自定义 webhook 事件构建器
  Converter Converter
  // 可选: 自定义序列化器
  Marshaler func(v any) ([]byte, error)
  // 可选: 从上下文获取属性
  AttrFromContext []func(ctx context.Context) []slog.Attr

  // 可选: 参见 slog.HandlerOptions
  AddSource   bool
  ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}

其他全局参数:

slogwebhook.SourceKey = "source"
slogwebhook.ContextKey = "extra"
slogwebhook.ErrorKeys = []string{"error", "err"}
slogwebhook.RequestIgnoreHeaders = false

支持的属性

slogwebhook.DefaultConverter 解释以下属性:

其他属性将被注入到 extra 字段中。

用户必须是 slog.Group 类型。例如:

slog.Group("user",
  slog.String("id", "user-123"),
  slog.String("username", "samber"),
  slog.Time("created_at", time.Now()),
)

示例

import (
	"fmt"
	"net/http"
	"time"

	slogwebhook "github.com/samber/slog-webhook/v2"

	"log/slog"
)

func main() {
  url := "https://webhook.site/xxxxxx"

  logger := slog.New(slogwebhook.Option{Level: slog.LevelDebug, Endpoint: url}.NewWebhookHandler())
  logger = logger.With("release", "v1.0.0")

  req, _ := http.NewRequest(http.MethodGet, "https://api.screeb.app", nil)
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("X-TOKEN", "1234567890")

  logger.
    With(
      slog.Group("user",
        slog.String("id", "user-123"),
        slog.Time("created_at", time.Now()),
      ),
    ).
    With("request", req).
    With("error", fmt.Errorf("an error")).
    Error("a message")
}

输出:

{
  "error": {
    "error": "an error",
    "kind": "*errors.errorString",
    "stack": null
  },
  "extra": {
	"release": "v1.0.0"
  },
  "level": "ERROR",
  "logger": "samber/slog-webhook",
  "message": "a message",
  "request": {
    "headers": {
      "Content-Type": "application/json",
      "X-Token": "1234567890"
    },
    "host": "api.screeb.app",
    "method": "GET",
    "url": {
      "fragment": "",
      "host": "api.screeb.app",
      "path": "",
      "query": {},
      "raw_query": "",
      "scheme": "https",
      "url": "https://api.screeb.app"
    }
  },
  "timestamp": "2023-04-10T14:00:0.000000",
  "user": {
	"id": "user-123",
    "created_at": "2023-04-10T14:00:0.000000"
  }
}

链路追踪

导入 samber/slog-otel 库。

import (
	slogwebhook "github.com/samber/slog-webhook"
	slogotel "github.com/samber/slog-otel"
	"go.opentelemetry.io/otel/sdk/trace"
)

func main() {
	tp := trace.NewTracerProvider(
		trace.WithSampler(trace.AlwaysSample()),
	)
	tracer := tp.Tracer("hello/world")

	ctx, span := tracer.Start(context.Background(), "foo")
	defer span.End()

	span.AddEvent("bar")

	logger := slog.New(
		slogwebhook.Option{
			// ...
			AttrFromContext: []func(ctx context.Context) []slog.Attr{
				slogotel.ExtractOtelAttrFromContext([]string{"tracing"}, "trace_id", "span_id"),
			},
		}.NewWebhookHandler(),
	)

	logger.ErrorContext(ctx, "a message")
}

🤝 贡献

• 在 Twitter 上 ping 我 @samuelberthe (私信、提及，随便什么 :))
• Fork 这个项目
• 修复开放问题或请求新功能

不要犹豫 ;)

# 安装一些开发依赖
make tools

# 运行测试
make test
# 或
make watch-test

👤 贡献者

💫 表达你的支持

如果这个项目对你有帮助，请给一个 ⭐️！

📝 许可证

版权所有 © 2023 Samuel Berthe。

本项目采用 MIT 许可证。