A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://pkg.go.dev/github.com/samber/slog-webhook below:

slogwebhook package - github.com/samber/slog-webhook - Go Packages

slog: Webhook handler

A webhook Handler for slog Go library.

See also:

🚀 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

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.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4