{"id":19288549,"url":"https://github.com/samber/slog-nats","last_synced_at":"2025-04-22T04:33:47.767Z","repository":{"id":209437175,"uuid":"724059346","full_name":"samber/slog-nats","owner":"samber","description":"🚨 slog: NATS handler","archived":false,"fork":false,"pushed_at":"2024-05-01T18:40:45.000Z","size":48,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-02T01:14:01.948Z","etag":null,"topics":["attribute","broker","error","go","golang","handler","log","log-level","logger","middleware","nats","publisher","queue","slog","structured-logging","topic"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/samber/slog-nats","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samber.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["samber"]}},"created_at":"2023-11-27T10:09:10.000Z","updated_at":"2024-06-27T16:15:34.088Z","dependencies_parsed_at":"2023-11-27T11:29:01.688Z","dependency_job_id":"0ba21d6e-4c9c-4e1e-acb8-47fd32951a69","html_url":"https://github.com/samber/slog-nats","commit_stats":null,"previous_names":["samber/slog-nats"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-nats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-nats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-nats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-nats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samber","download_url":"https://codeload.github.com/samber/slog-nats/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223888365,"owners_count":17220083,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["attribute","broker","error","go","golang","handler","log","log-level","logger","middleware","nats","publisher","queue","slog","structured-logging","topic"],"created_at":"2024-11-09T22:09:29.331Z","updated_at":"2024-11-09T22:09:29.864Z","avatar_url":"https://github.com/samber.png","language":"Go","funding_links":["https://github.com/sponsors/samber"],"categories":[],"sub_categories":[],"readme":"\n# slog: NATS handler\n\n[![tag](https://img.shields.io/github/tag/samber/slog-nats.svg)](https://github.com/samber/slog-nats/releases)\n![Go Version](https://img.shields.io/badge/Go-%3E%3D%201.21-%23007d9c)\n[![GoDoc](https://godoc.org/github.com/samber/slog-nats?status.svg)](https://pkg.go.dev/github.com/samber/slog-nats)\n![Build Status](https://github.com/samber/slog-nats/actions/workflows/test.yml/badge.svg)\n[![Go report](https://goreportcard.com/badge/github.com/samber/slog-nats)](https://goreportcard.com/report/github.com/samber/slog-nats)\n[![Coverage](https://img.shields.io/codecov/c/github/samber/slog-nats)](https://codecov.io/gh/samber/slog-nats)\n[![Contributors](https://img.shields.io/github/contributors/samber/slog-nats)](https://github.com/samber/slog-nats/graphs/contributors)\n[![License](https://img.shields.io/github/license/samber/slog-nats)](./LICENSE)\n\nA [NATS](https://nats.io/) Handler for [slog](https://pkg.go.dev/log/slog) Go library.\n\n\u003cdiv align=\"center\"\u003e\n  \u003chr\u003e\n  \u003csup\u003e\u003cb\u003eSponsored by:\u003c/b\u003e\u003c/sup\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://quickwit.io?utm_campaign=github_sponsorship\u0026utm_medium=referral\u0026utm_content=samber-slog-nats\u0026utm_source=github\"\u003e\n    \u003cdiv\u003e\n      \u003cimg src=\"https://github.com/samber/oops/assets/2951285/49aaaa2b-b8c6-4f21-909f-c12577bb6a2e\" width=\"240\" alt=\"Quickwit\"\u003e\n    \u003c/div\u003e\n    \u003cdiv\u003e\n      Cloud-native search engine for observability - An OSS alternative to Splunk, Elasticsearch, Loki, and Tempo.\n    \u003c/div\u003e\n  \u003c/a\u003e\n  \u003chr\u003e\n\u003c/div\u003e\n\n**See also:**\n\n- [slog-multi](https://github.com/samber/slog-multi): `slog.Handler` chaining, fanout, routing, failover, load balancing...\n- [slog-formatter](https://github.com/samber/slog-formatter): `slog` attribute formatting\n- [slog-sampling](https://github.com/samber/slog-sampling): `slog` sampling policy\n- [slog-mock](https://github.com/samber/slog-mock): `slog.Handler` for test purposes\n\n**HTTP middlewares:**\n\n- [slog-gin](https://github.com/samber/slog-gin): Gin middleware for `slog` logger\n- [slog-echo](https://github.com/samber/slog-echo): Echo middleware for `slog` logger\n- [slog-fiber](https://github.com/samber/slog-fiber): Fiber middleware for `slog` logger\n- [slog-chi](https://github.com/samber/slog-chi): Chi middleware for `slog` logger\n- [slog-http](https://github.com/samber/slog-http): `net/http` middleware for `slog` logger\n\n**Loggers:**\n\n- [slog-zap](https://github.com/samber/slog-zap): A `slog` handler for `Zap`\n- [slog-zerolog](https://github.com/samber/slog-zerolog): A `slog` handler for `Zerolog`\n- [slog-logrus](https://github.com/samber/slog-logrus): A `slog` handler for `Logrus`\n\n**Log sinks:**\n\n- [slog-datadog](https://github.com/samber/slog-datadog): A `slog` handler for `Datadog`\n- [slog-betterstack](https://github.com/samber/slog-betterstack): A `slog` handler for `Betterstack`\n- [slog-rollbar](https://github.com/samber/slog-rollbar): A `slog` handler for `Rollbar`\n- [slog-loki](https://github.com/samber/slog-loki): A `slog` handler for `Loki`\n- [slog-sentry](https://github.com/samber/slog-sentry): A `slog` handler for `Sentry`\n- [slog-syslog](https://github.com/samber/slog-syslog): A `slog` handler for `Syslog`\n- [slog-logstash](https://github.com/samber/slog-logstash): A `slog` handler for `Logstash`\n- [slog-fluentd](https://github.com/samber/slog-fluentd): A `slog` handler for `Fluentd`\n- [slog-graylog](https://github.com/samber/slog-graylog): A `slog` handler for `Graylog`\n- [slog-quickwit](https://github.com/samber/slog-quickwit): A `slog` handler for `Quickwit`\n- [slog-slack](https://github.com/samber/slog-slack): A `slog` handler for `Slack`\n- [slog-telegram](https://github.com/samber/slog-telegram): A `slog` handler for `Telegram`\n- [slog-mattermost](https://github.com/samber/slog-mattermost): A `slog` handler for `Mattermost`\n- [slog-microsoft-teams](https://github.com/samber/slog-microsoft-teams): A `slog` handler for `Microsoft Teams`\n- [slog-webhook](https://github.com/samber/slog-webhook): A `slog` handler for `Webhook`\n- [slog-kafka](https://github.com/samber/slog-kafka): A `slog` handler for `Kafka`\n- [slog-nats](https://github.com/samber/slog-nats): A `slog` handler for `NATS`\n- [slog-parquet](https://github.com/samber/slog-parquet): A `slog` handler for `Parquet` + `Object Storage`\n- [slog-channel](https://github.com/samber/slog-channel): A `slog` handler for Go channels\n\n## 🚀 Install\n\n```sh\ngo get github.com/samber/slog-nats\n```\n\n**Compatibility**: go \u003e= 1.21\n\nNo breaking changes will be made to exported APIs before v1.0.0.\n\n## 💡 Usage\n\nGoDoc: [https://pkg.go.dev/github.com/samber/slog-nats](https://pkg.go.dev/github.com/samber/slog-nats)\n\n### Handler options\n\n```go\ntype Option struct {\n\t// log level (default: debug)\n\tLevel     slog.Leveler\n\n\t// NATS client\n\tEncodedConnection *nats.EncodedConn\n\tSubject           string\n\n\t// optional: customize NATS event builder\n\tConverter Converter\n\t// optional: fetch attributes from context\n\tAttrFromContext []func(ctx context.Context) []slog.Attr\n\n\t// optional: see slog.HandlerOptions\n\tAddSource   bool\n\tReplaceAttr func(groups []string, a slog.Attr) slog.Attr\n}\n```\n\nOther global parameters:\n\n```go\nslognats.SourceKey = \"source\"\nslognats.ContextKey = \"extra\"\nslognats.RequestKey = \"request\"\nslognats.ErrorKeys = []string{\"error\", \"err\"}\nslognats.RequestIgnoreHeaders = false\n```\n\n### Supported attributes\n\nThe following attributes are interpreted by `slognats.DefaultConverter`:\n\n| Atribute name    | `slog.Kind`       | Underlying type |\n| ---------------- | ----------------- | --------------- |\n| \"user\"           | group (see below) |                 |\n| \"error\"          | any               | `error`         |\n| \"request\"        | any               | `*http.Request` |\n| other attributes | *                 |                 |\n\nOther attributes will be injected in `extra` field.\n\nUsers must be of type `slog.Group`. Eg:\n\n```go\nslog.Group(\"user\",\n    slog.String(\"id\", \"user-123\"),\n    slog.String(\"username\", \"samber\"),\n    slog.Time(\"created_at\", time.Now()),\n)\n```\n\n### Example\n\n```go\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\tslognats \"github.com/samber/slog-nats\"\n\t\"github.com/nats-io/nats.go\"\n\n\t\"log/slog\"\n)\n\nfunc main() {\n\t// docker-compose up -d\n\t// brew tap nats-io/nats-tools\n\t// brew install nats-io/nats-tools/nats\n\t// nats subscribe test\n\n\turi := \"nats://127.0.0.1:4222\"\n\n\tnc, err := nats.Connect(uri)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tec, err := nats.NewEncodedConn(nc, nats.JSON_ENCODER)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tdefer nc.Flush()\n\tdefer nc.Close()\n\n\tlogger := slog.New(slognats.Option{Level: slog.LevelDebug, EncodedConnection: ec, Subject: \"test\"}.NewNATSHandler())\n\tlogger = logger.With(\"release\", \"v1.0.0\")\n\n\tlogger.\n\t\tWith(\n\t\t\tslog.Group(\"user\",\n\t\t\t\tslog.String(\"id\", \"user-123\"),\n\t\t\t\tslog.Time(\"created_at\", time.Now()),\n\t\t\t),\n\t\t).\n\t\tWith(\"error\", fmt.Errorf(\"an error\")).\n\t\tError(\"a message\")\n}\n```\n\nNATS message:\n\n```json\n{\n  \t\"level\": \"ERROR\",\n\t\"logger.name\": \"samber/slog-nats\",\n\t\"logger.version\": \"1.0.0\",\n\t\"message\": \"a message\",\n\t\"timestamp\": \"2023-04-30T01:33:21.676768Z\",\n\t\"error\": {\n\t\t\"error\": \"an error\",\n\t\t\"kind\": \"*errors.errorString\",\n\t\t\"stack\": null\n\t},\n\t\"extra\": {\n\t\t\"release\": \"v1.0.0\"\n\t},\n\t\"user\": {\n\t\t\"created_at\": \"2023-04-30T01:33:21.676704Z\",\n\t\t\"id\": \"user-123\"\n\t}\n}\n```\n\n### Tracing\n\nImport the samber/slog-otel library.\n\n```go\nimport (\n\tslognats \"github.com/samber/slog-nats\"\n\tslogotel \"github.com/samber/slog-otel\"\n\t\"go.opentelemetry.io/otel/sdk/trace\"\n)\n\nfunc main() {\n\ttp := trace.NewTracerProvider(\n\t\ttrace.WithSampler(trace.AlwaysSample()),\n\t)\n\ttracer := tp.Tracer(\"hello/world\")\n\n\tctx, span := tracer.Start(context.Background(), \"foo\")\n\tdefer span.End()\n\n\tspan.AddEvent(\"bar\")\n\n\tlogger := slog.New(\n\t\tslognats.Option{\n\t\t\t// ...\n\t\t\tAttrFromContext: []func(ctx context.Context) []slog.Attr{\n\t\t\t\tslogotel.ExtractOtelAttrFromContext([]string{\"tracing\"}, \"trace_id\", \"span_id\"),\n\t\t\t},\n\t\t}.NewNATSHandler(),\n\t)\n\n\tlogger.ErrorContext(ctx, \"a message\")\n}\n```\n\n## 🤝 Contributing\n\n- Ping me on twitter [@samuelberthe](https://twitter.com/samuelberthe) (DMs, mentions, whatever :))\n- Fork the [project](https://github.com/samber/slog-nats)\n- Fix [open issues](https://github.com/samber/slog-nats/issues) or request new features\n\nDon't hesitate ;)\n\n```bash\n# Install some dev dependencies\nmake tools\n\n# Run tests\nmake test\n# or\nmake watch-test\n```\n\n## 👤 Contributors\n\n![Contributors](https://contrib.rocks/image?repo=samber/slog-nats)\n\n## 💫 Show your support\n\nGive a ⭐️ if this project helped you!\n\n[![GitHub Sponsors](https://img.shields.io/github/sponsors/samber?style=for-the-badge)](https://github.com/sponsors/samber)\n\n## 📝 License\n\nCopyright © 2023 [Samuel Berthe](https://github.com/samber).\n\nThis project is [MIT](./LICENSE) licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamber%2Fslog-nats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamber%2Fslog-nats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamber%2Fslog-nats/lists"}