slogtelegram

README

slog: Telegram handler

A Telegram 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

HTTP middlewares:

• slog-gin: Gin middleware for slog logger
• slog-echo: Echo middleware for slog logger
• slog-fiber: Fiber middleware for slog logger
• slog-chi: Chi middleware for slog logger
• slog-http: net/http middleware for slog logger

Loggers:

• slog-zap: A slog handler for Zap
• slog-zerolog: A slog handler for Zerolog
• slog-logrus: A slog handler for Logrus

Log sinks:

• slog-datadog: A slog handler for Datadog
• slog-betterstack: A slog handler for Betterstack
• slog-rollbar: A slog handler for Rollbar
• slog-loki: A slog handler for Loki
• 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-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
• slog-nats: A slog handler for NATS
• slog-parquet: A slog handler for Parquet + Object Storage
• slog-channel: A slog handler for Go channels

🚀 Install

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

Compatibility: go >= 1.21

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

💡 Usage

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

Handler options

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

	// Telegram bot token
	Token string
	// Username of the channel in the form of `@username`
	Username string

	// optional: customize Telegram message builder
	Converter Converter

	// optional: see slog.HandlerOptions
	AddSource   bool
	ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}

Attributes will be injected in message.

Other global parameters:

slogtelegram.SourceKey = "source"

Example

import (
	slogtelegram "github.com/samber/slog-telegram/v2"
	"log/slog"
)

func main() {
	token := "xxxx"
	username := "@xxxx"

	logger := slog.New(slogtelegram.Option{Level: slog.LevelDebug, Token: token, Username: username}.NewTelegramHandler())
	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

• 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

• Variables
• func DefaultConverter(addSource bool, replaceAttr func(groups []string, a slog.Attr) slog.Attr, ...) string
• type Converter
• type MessageConfigurator
• type Option
  • func (o Option) NewTelegramHandler() slog.Handler
• type TelegramHandler
  • func (h *TelegramHandler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *TelegramHandler) Handle(ctx context.Context, record slog.Record) error
  • func (h *TelegramHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *TelegramHandler) WithGroup(name string) slog.Handler

Variables

var SourceKey = "source"

Functions

func DefaultConverter

func DefaultConverter(addSource bool, replaceAttr func(groups []string, a slog.Attr) slog.Attr, loggerAttr []slog.Attr, groups []string, record *slog.Record) string

Types

type Converter

type Converter func(addSource bool, replaceAttr func(groups []string, a slog.Attr) slog.Attr, loggerAttr []slog.Attr, groups []string, record *slog.Record) string

type MessageConfigurator

type MessageConfigurator func(messageConfig tgbotapi.MessageConfig, loggerAttr []slog.Attr) tgbotapi.MessageConfig

type Option

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

	// Telegram bot token
	Token string
	// Username of the channel in the form of `@username`
	Username string

	// optional: customize Telegram message builder
	Converter           Converter
	MessageConfigurator MessageConfigurator

	// optional: see slog.HandlerOptions
	AddSource   bool
	ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}

func (Option) NewTelegramHandler

func (o Option) NewTelegramHandler() slog.Handler

type TelegramHandler

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

func (*TelegramHandler) Enabled

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

func (*TelegramHandler) Handle

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

func (*TelegramHandler) WithAttrs

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

func (*TelegramHandler) WithGroup

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