slogwebhook

README

slog: Webhook handler

A webhook Handler for slog Go library.

See also:

• slog-multi: slog.Handler chaining, fanout, routing, failover, load balancing...
• slog-formatter: slog attribute formatting
• slog-sampling: slog sampling policy
• slog-gin: Gin middleware for slog logger
• slog-echo: Echo middleware for slog logger
• slog-fiber: Fiber middleware for slog logger
• slog-datadog: A slog handler for Datadog
• slog-rollbar: A slog handler for Rollbar
• slog-sentry: A slog handler for Sentry
• slog-syslog: A slog handler for Syslog
• slog-logstash: A slog handler for Logstash
• slog-fluentd: A slog handler for Fluentd
• slog-graylog: A slog handler for Graylog
• slog-loki: A slog handler for Loki
• slog-slack: A slog handler for Slack
• slog-telegram: A slog handler for Telegram
• slog-mattermost: A slog handler for Mattermost
• slog-microsoft-teams: A slog handler for Microsoft Teams
• slog-webhook: A slog handler for Webhook
• slog-kafka: A slog handler for Kafka

🚀 Install

go get github.com/samber/slog-webhook

Compatibility: go >= 1.21

No breaking changes will be made to exported APIs before v2.0.0.

💡 Usage

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

Handler options

type Option struct {
    // log level (default: debug)
	Level     slog.Leveler

	// URL
	Endpoint string

	// optional: customize webhook event builder
	Converter Converter
}

Supported attributes

The following attributes are interpreted by slogwebhook.DefaultConverter:

Atribute name	slog.Kind	Underlying type
"user"	group (see below)
"error"	any	error
"request"	any	*http.Request
other attributes	*

Other attributes will be injected in extra field.

Users must be of type slog.Group. Eg:

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

Example

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

	slogwebhhok "github.com/samber/slog-webhook"

	"log/slog"
)

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

	logger := slog.New(slogwebhhok.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")
}

Output:

{
  "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"
  }
}

🤝 Contributing

• Ping me on twitter @samuelberthe (DMs, mentions, whatever :))
• Fork the project
• Fix open issues or request new features

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

• func DefaultConverter(loggerAttr []slog.Attr, record slog.Record) map[string]any
• type Converter
• type Option
  • func (o Option) NewWebhookHandler() slog.Handler
• type WebhookHandler
  • func (h *WebhookHandler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *WebhookHandler) Handle(ctx context.Context, record slog.Record) error
  • func (h *WebhookHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *WebhookHandler) WithGroup(name string) slog.Handler

Functions

func DefaultConverter

func DefaultConverter(loggerAttr []slog.Attr, record slog.Record) map[string]any

Types

type Converter

type Converter func(loggerAttr []slog.Attr, record slog.Record) map[string]any

type Option

type Option struct {
	// log level (default: debug)
	Level slog.Leveler

	// URL
	Endpoint string

	// optional: customize webhook event builder
	Converter Converter
}

func (Option) NewWebhookHandler

func (o Option) NewWebhookHandler() slog.Handler

type WebhookHandler

type WebhookHandler struct {
	// contains filtered or unexported fields
}

func (*WebhookHandler) Enabled

func (h *WebhookHandler) Enabled(_ context.Context, level slog.Level) bool

func (*WebhookHandler) Handle

func (h *WebhookHandler) Handle(ctx context.Context, record slog.Record) error

func (*WebhookHandler) WithAttrs

func (h *WebhookHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (*WebhookHandler) WithGroup

func (h *WebhookHandler) WithGroup(name string) slog.Handler