Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/samber/slog-microsoft-teams

🚨 slog: Microsoft Teams handler
https://github.com/samber/slog-microsoft-teams

attribute error go golang handler log log-level logger microsoft microsoft-teams middleware slog structured-logging teams

Last synced: 3 months ago
JSON representation

🚨 slog: Microsoft Teams handler

Awesome Lists containing this project

README

        

# slog: Microsoft Teams handler

[![tag](https://img.shields.io/github/tag/samber/slog-microsoft-teams.svg)](https://github.com/samber/slog-microsoft-teams/releases)
![Go Version](https://img.shields.io/badge/Go-%3E%3D%201.21-%23007d9c)
[![GoDoc](https://godoc.org/github.com/samber/slog-microsoft-teams?status.svg)](https://pkg.go.dev/github.com/samber/slog-microsoft-teams)
![Build Status](https://github.com/samber/slog-microsoft-teams/actions/workflows/test.yml/badge.svg)
[![Go report](https://goreportcard.com/badge/github.com/samber/slog-microsoft-teams)](https://goreportcard.com/report/github.com/samber/slog-microsoft-teams)
[![Coverage](https://img.shields.io/codecov/c/github/samber/slog-microsoft-teams)](https://codecov.io/gh/samber/slog-microsoft-teams)
[![Contributors](https://img.shields.io/github/contributors/samber/slog-microsoft-teams)](https://github.com/samber/slog-microsoft-teams/graphs/contributors)
[![License](https://img.shields.io/github/license/samber/slog-microsoft-teams)](./LICENSE)

A [Teams](https://www.microsoft.com/en/microsoft-teams) Handler for [slog](https://pkg.go.dev/log/slog) Go library.




Sponsored by:




Quickwit


Cloud-native search engine for observability - An OSS alternative to Splunk, Elasticsearch, Loki, and Tempo.




**See also:**

- [slog-multi](https://github.com/samber/slog-multi): `slog.Handler` chaining, fanout, routing, failover, load balancing...
- [slog-formatter](https://github.com/samber/slog-formatter): `slog` attribute formatting
- [slog-sampling](https://github.com/samber/slog-sampling): `slog` sampling policy

**HTTP middlewares:**

- [slog-gin](https://github.com/samber/slog-gin): Gin middleware for `slog` logger
- [slog-echo](https://github.com/samber/slog-echo): Echo middleware for `slog` logger
- [slog-fiber](https://github.com/samber/slog-fiber): Fiber middleware for `slog` logger
- [slog-chi](https://github.com/samber/slog-chi): Chi middleware for `slog` logger
- [slog-http](https://github.com/samber/slog-http): `net/http` middleware for `slog` logger

**Loggers:**

- [slog-zap](https://github.com/samber/slog-zap): A `slog` handler for `Zap`
- [slog-zerolog](https://github.com/samber/slog-zerolog): A `slog` handler for `Zerolog`
- [slog-logrus](https://github.com/samber/slog-logrus): A `slog` handler for `Logrus`

**Log sinks:**

- [slog-datadog](https://github.com/samber/slog-datadog): A `slog` handler for `Datadog`
- [slog-betterstack](https://github.com/samber/slog-betterstack): A `slog` handler for `Betterstack`
- [slog-rollbar](https://github.com/samber/slog-rollbar): A `slog` handler for `Rollbar`
- [slog-loki](https://github.com/samber/slog-loki): A `slog` handler for `Loki`
- [slog-sentry](https://github.com/samber/slog-sentry): A `slog` handler for `Sentry`
- [slog-syslog](https://github.com/samber/slog-syslog): A `slog` handler for `Syslog`
- [slog-logstash](https://github.com/samber/slog-logstash): A `slog` handler for `Logstash`
- [slog-fluentd](https://github.com/samber/slog-fluentd): A `slog` handler for `Fluentd`
- [slog-graylog](https://github.com/samber/slog-graylog): A `slog` handler for `Graylog`
- [slog-quickwit](https://github.com/samber/slog-quickwit): A `slog` handler for `Quickwit`
- [slog-slack](https://github.com/samber/slog-slack): A `slog` handler for `Slack`
- [slog-telegram](https://github.com/samber/slog-telegram): A `slog` handler for `Telegram`
- [slog-mattermost](https://github.com/samber/slog-mattermost): A `slog` handler for `Mattermost`
- [slog-microsoft-teams](https://github.com/samber/slog-microsoft-teams): A `slog` handler for `Microsoft Teams`
- [slog-webhook](https://github.com/samber/slog-webhook): A `slog` handler for `Webhook`
- [slog-kafka](https://github.com/samber/slog-kafka): A `slog` handler for `Kafka`
- [slog-nats](https://github.com/samber/slog-nats): A `slog` handler for `NATS`
- [slog-parquet](https://github.com/samber/slog-parquet): A `slog` handler for `Parquet` + `Object Storage`
- [slog-channel](https://github.com/samber/slog-channel): A `slog` handler for Go channels

## 🚀 Install

```sh
go get github.com/samber/slog-microsoft-teams/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-microsoft-teams/v2](https://pkg.go.dev/github.com/samber/slog-microsoft-teams/v2)

### Handler options

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

// Teams webhook url
WebhookURL string
Timeout time.Duration // default: 10s

// optional: customize Teams event builder
Converter Converter

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

Other global parameters:

```go
slogmicrosoftteams.SourceKey = "source"
slogmicrosoftteams.ColorMapping = map[slog.Level]string{...}
```

### Example

```go
import (
slogmicrosoftteams "github.com/samber/slog-microsoft-teams/v2"
"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

- Ping me on twitter [@samuelberthe](https://twitter.com/samuelberthe) (DMs, mentions, whatever :))
- Fork the [project](https://github.com/samber/slog-microsoft-teams)
- Fix [open issues](https://github.com/samber/slog-microsoft-teams/issues) or request new features

Don't hesitate ;)

```bash
# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test
```

## 👤 Contributors

![Contributors](https://contrib.rocks/image?repo=samber/slog-microsoft-teams)

## 💫 Show your support

Give a ⭐️ if this project helped you!

[![GitHub Sponsors](https://img.shields.io/github/sponsors/samber?style=for-the-badge)](https://github.com/sponsors/samber)

## 📝 License

Copyright © 2023 [Samuel Berthe](https://github.com/samber).

This project is [MIT](./LICENSE) licensed.