slogmicrosoftteams

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2023 License: MIT Imports: 8 Imported by: 0

README

slog: Microsoft Teams handler

tag Go Version GoDoc Build Status Go report Coverage Contributors License

A Teams Handler for slog Go library.

See also:

🚀 Install

go get github.com/samber/slog-microsoft-teams

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-microsoft-teams

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

	// Teams webhook url
	WebhookURL string

	// optional: customize Teams event builder
	Converter Converter
}
Example
import (
	slogmicrosoftteams "github.com/samber/slog-microsoft-teams"
	"log/slog"
)

func main() {
	url := "https://xxxxxx.webhook.office.com/webhookb2/xxxxx@xxxxx/IncomingWebhook/xxxxx/xxxxx"

	logger := slog.New(slogmicrosoftteams.Option{Level: slog.LevelDebug, WebhookURL: url}.NewMicrosoftTeamsHandler())
	logger = logger.With("release", "v1.0.0")

	logger.
		With(
			slog.Group("user",
				slog.String("id", "user-123"),
				slog.Time("created_at", time.Now().AddDate(0, 0, -1)),
			),
		).
		With("environment", "dev").
		With("error", fmt.Errorf("an error")).
		Error("A message")
}

🤝 Contributing

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

GitHub Sponsors

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultConverter

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

Types

type Converter

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

type MicrosoftTeamsHandler

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

func (*MicrosoftTeamsHandler) Enabled

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

func (*MicrosoftTeamsHandler) Handle

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

func (*MicrosoftTeamsHandler) WithAttrs

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

func (*MicrosoftTeamsHandler) WithGroup

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

type Option

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

	// Teams webhook url
	WebhookURL string

	// optional: customize Teams event builder
	Converter Converter
}

func (Option) NewMicrosoftTeamsHandler

func (o Option) NewMicrosoftTeamsHandler() slog.Handler

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL