{"id":13830435,"url":"https://github.com/samber/slog-chi","last_synced_at":"2025-04-22T04:33:39.164Z","repository":{"id":200360377,"uuid":"705345905","full_name":"samber/slog-chi","owner":"samber","description":"🚨 Chi middleware for slog logger","archived":false,"fork":false,"pushed_at":"2024-11-04T23:23:16.000Z","size":97,"stargazers_count":48,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-05T00:20:37.474Z","etag":null,"topics":["attribute","chi","error","errors","go","golang","handler","http","log","log-level","logger","middleware","slog","structured-logging"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/samber/slog-chi","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-10-15T18:53:29.000Z","updated_at":"2024-11-04T23:15:07.000Z","dependencies_parsed_at":"2023-10-25T21:33:22.378Z","dependency_job_id":"bb9b86c5-7f2c-49ef-8b8d-f3ab99fe64b1","html_url":"https://github.com/samber/slog-chi","commit_stats":null,"previous_names":["samber/slog-chi"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-chi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-chi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-chi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-chi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samber","download_url":"https://codeload.github.com/samber/slog-chi/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","chi","error","errors","go","golang","handler","http","log","log-level","logger","middleware","slog","structured-logging"],"created_at":"2024-08-04T10:00:59.863Z","updated_at":"2025-04-22T04:33:39.153Z","avatar_url":"https://github.com/samber.png","language":"Go","readme":"\n# slog: Chi middleware\n\n[![tag](https://img.shields.io/github/tag/samber/slog-chi.svg)](https://github.com/samber/slog-chi/releases)\n![Go Version](https://img.shields.io/badge/Go-%3E%3D%201.21-%23007d9c)\n[![GoDoc](https://godoc.org/github.com/samber/slog-chi?status.svg)](https://pkg.go.dev/github.com/samber/slog-chi)\n![Build Status](https://github.com/samber/slog-chi/actions/workflows/test.yml/badge.svg)\n[![Go report](https://goreportcard.com/badge/github.com/samber/slog-chi)](https://goreportcard.com/report/github.com/samber/slog-chi)\n[![Coverage](https://img.shields.io/codecov/c/github/samber/slog-chi)](https://codecov.io/gh/samber/slog-chi)\n[![Contributors](https://img.shields.io/github/contributors/samber/slog-chi)](https://github.com/samber/slog-chi/graphs/contributors)\n[![License](https://img.shields.io/github/license/samber/slog-chi)](./LICENSE)\n\n[Chi](https://github.com/go-chi/chi) middleware to log http requests using [slog](https://pkg.go.dev/log/slog).\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-chi\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-chi\n```\n\n**Compatibility**: go \u003e= 1.21\n\nNo breaking changes will be made to exported APIs before v2.0.0.\n\n## 💡 Usage\n\n### Handler options\n\n```go\ntype Config struct {\n\tDefaultLevel     slog.Level\n\tClientErrorLevel slog.Level\n\tServerErrorLevel slog.Level\n\n\tWithUserAgent      bool\n\tWithRequestID      bool\n\tWithRequestBody    bool\n\tWithRequestHeader  bool\n\tWithResponseBody   bool\n\tWithResponseHeader bool\n\tWithSpanID         bool\n\tWithTraceID        bool\n\n\tFilters []Filter\n}\n```\n\nAttributes will be injected in log payload.\n\nOther global parameters:\n\n```go\nslogchi.TraceIDKey = \"trace_id\"\nslogchi.SpanIDKey = \"span_id\"\nslogchi.RequestIDKey = \"id\"\nslogchi.RequestBodyMaxSize  = 64 * 1024 // 64KB\nslogchi.ResponseBodyMaxSize = 64 * 1024 // 64KB\nslogchi.HiddenRequestHeaders = map[string]struct{}{ ... }\nslogchi.HiddenResponseHeaders = map[string]struct{}{ ... }\n```\n\n### Minimal\n\n```go\nimport (\n\t\"net/http\"\n\t\"os\"\n\t\"time\"\n\n\t\"github.com/go-chi/chi/v5\"\n\t\"github.com/go-chi/chi/v5/middleware\"\n\tslogchi \"github.com/samber/slog-chi\"\n\t\"log/slog\"\n)\n\n// Create a slog logger, which:\n//   - Logs to stdout.\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\n// Chi instance\nrouter := chi.NewRouter()\n\n// Middleware\nrouter.Use(slogchi.New(logger))\nrouter.Use(middleware.Recoverer)\n\n// Routes\nrouter.GET(\"/\", func(w http.ResponseWriter, r *http.Request) {\n\tw.Write([]byte(\"Hello, World!\"))\n})\nrouter.GET(\"/error\", func(w http.ResponseWriter, r *http.Request) {\n\thttp.Error(w, http.StatusText(400), 400)\n})\n\n// Start server\nerr := http.ListenAndServe(\":4242\", router)\n\n// output:\n// time=2023-10-15T20:32:58.926+02:00 level=INFO msg=\"200: OK\" env=production request.time=2023-10-15T20:32:58.626+02:00 request.method=GET request.path=/ request.route=\"\" request.ip=127.0.0.1:63932 request.length=0 response.time=2023-10-15T20:32:58.926+02:00 response.latency=100ms response.status=200 response.length=7 id=\"\"\n```\n\n### OTEL\n\n```go\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\nconfig := slogchi.Config{\n\tWithSpanID:  true,\n\tWithTraceID: true,\n}\n\nrouter := chi.NewRouter()\nrouter.Use(slogchi.NewWithConfig(logger, config))\nrouter.Use(middleware.Recoverer)\n```\n\n### Custom log levels\n\n```go\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\nconfig := slogchi.Config{\n\tDefaultLevel:     slog.LevelInfo,\n\tClientErrorLevel: slog.LevelWarn,\n\tServerErrorLevel: slog.LevelError,\n}\n\nrouter := chi.NewRouter()\nrouter.Use(slogchi.NewWithConfig(logger, config))\nrouter.Use(middleware.Recoverer)\n```\n\n### Verbose\n\n```go\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\nconfig := slogchi.Config{\n\tWithRequestBody: true,\n\tWithResponseBody: true,\n\tWithRequestHeader: true,\n\tWithResponseHeader: true,\n}\n\nrouter := chi.NewRouter()\nrouter.Use(slogchi.NewWithConfig(logger, config))\nrouter.Use(middleware.Recoverer)\n```\n\n### Filters\n\n```go\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\nrouter := chi.NewRouter()\nrouter.Use(\n\tslogchi.NewWithFilters(\n\t\tlogger,\n\t\tslogchi.Accept(func (ww middleware.WrapResponseWriter, r *http.Request) bool {\n\t\t\treturn xxx\n\t\t}),\n\t\tslogchi.IgnoreStatus(401, 404),\n\t),\n)\nrouter.Use(middleware.Recoverer)\n```\n\nAvailable filters:\n- Accept / Ignore\n- AcceptMethod / IgnoreMethod\n- AcceptStatus / IgnoreStatus\n- AcceptStatusGreaterThan / IgnoreStatusGreaterThan\n- AcceptStatusLessThan / IgnoreStatusLessThan\n- AcceptStatusGreaterThanOrEqual / IgnoreStatusGreaterThanOrEqual\n- AcceptStatusLessThanOrEqual / IgnoreStatusLessThanOrEqual\n- AcceptPath / IgnorePath\n- AcceptPathContains / IgnorePathContains\n- AcceptPathPrefix / IgnorePathPrefix\n- AcceptPathSuffix / IgnorePathSuffix\n- AcceptPathMatch / IgnorePathMatch\n- AcceptHost / IgnoreHost\n- AcceptHostContains / IgnoreHostContains\n- AcceptHostPrefix / IgnoreHostPrefix\n- AcceptHostSuffix / IgnoreHostSuffix\n- AcceptHostMatch / IgnoreHostMatch\n\n### Using custom time formatters\n\n```go\nimport (\n\t\"github.com/go-chi/chi/v5\"\n\t\"github.com/go-chi/chi/v5/middleware\"\n\tslogchi \"github.com/samber/slog-chi\"\n\tslogformatter \"github.com/samber/slog-formatter\"\n\t\"log/slog\"\n)\n\n// Create a slog logger, which:\n//   - Logs to stdout.\n//   - RFC3339 with UTC time format.\nlogger := slog.New(\n\tslogformatter.NewFormatterHandler(\n\t\tslogformatter.TimezoneConverter(time.UTC),\n\t\tslogformatter.TimeFormatter(time.DateTime, nil),\n\t)(\n\t\tslog.NewTextHandler(os.Stdout, nil),\n\t),\n)\n\n// Chi instance\nrouter := chi.NewRouter()\n\n// Middleware\nrouter.Use(slogchi.New(logger))\nrouter.Use(middleware.Recoverer)\n\n// Routes\nrouter.GET(\"/\", func(w http.ResponseWriter, r *http.Request) {\n\tw.Write([]byte(\"Hello, World!\"))\n})\nrouter.GET(\"/error\", func(w http.ResponseWriter, r *http.Request) {\n\thttp.Error(w, http.StatusText(400), 400)\n})\n\n// Start server\nerr := http.ListenAndServe(\":4242\", router)\n\n// output:\n// time=2023-10-15T20:32:58.926+02:00 level=INFO msg=\"200: OK\" env=production request.time=2023-10-15T20:32:58.626Z request.method=GET request.path=/ request.route=\"\" request.ip=127.0.0.1:63932 request.length=0 response.time=2023-10-15T20:32:58Z response.latency=100ms response.status=200 response.length=7 id=\"\"\n```\n\n### Using custom logger sub-group\n\n```go\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\n// Chi instance\nrouter := chi.NewRouter()\n\n// Middleware\nrouter.Use(slogchi.New(logger.WithGroup(\"http\")))\nrouter.Use(middleware.Recoverer)\n\n// Routes\nrouter.GET(\"/\", func(w http.ResponseWriter, r *http.Request) {\n\tw.Write([]byte(\"Hello, World!\"))\n})\nrouter.GET(\"/error\", func(w http.ResponseWriter, r *http.Request) {\n\thttp.Error(w, http.StatusText(400), 400)\n})\n\n// Start server\nerr := http.ListenAndServe(\":4242\", router)\n\n// output:\n// time=2023-10-15T20:32:58.926+02:00 level=INFO msg=\"200: OK\" env=production http.request.time=2023-10-15T20:32:58.626+02:00 http.request.method=GET http.request.path=/ http.request.route=\"\" http.request.ip=127.0.0.1:63932 http.request.length=0 http.response.time=2023-10-15T20:32:58.926+02:00 http.response.latency=100ms http.response.status=200 http.response.length=7 http.id=\"\"\n```\n\n### Adding custom attributes\n\n```go\nlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))\n\n// Add an attribute to all log entries made through this logger.\nlogger = logger.With(\"env\", \"production\")\n\n// Chi instance\nrouter := chi.NewRouter()\n\n// Middleware\nrouter.Use(slogchi.New(logger))\nrouter.Use(middleware.Recoverer)\n\n// Routes\nrouter.GET(\"/\", func(w http.ResponseWriter, r *http.Request) {\n\t// Add an attribute to a single log entry.\n\tslogchi.AddCustomAttributes(r, slog.String(\"foo\", \"bar\"))\n\tw.Write([]byte(\"Hello, World!\"))\n})\n\n// Start server\nerr := http.ListenAndServe(\":4242\", router)\n\n// output:\n// time=2023-10-15T20:32:58.926+02:00 level=INFO msg=\"200: OK\" env=production request.time=2023-10-15T20:32:58.626+02:00 request.method=GET request.path=/ request.route=\"\" request.ip=127.0.0.1:63932 request.length=0 response.time=2023-10-15T20:32:58.926+02:00 response.latency=100ms response.status=200 response.length=7 id=\"\" foo=bar\n```\n\n### JSON output\n\n```go\nlogger := slog.New(slog.NewJSONHandler(os.Stdout, nil))\n\n// Chi instance\nrouter := chi.NewRouter()\n\n// Middleware\nrouter.Use(slogchi.New(logger))\nrouter.Use(middleware.Recoverer)\n\n// Routes\nrouter.GET(\"/\", func(w http.ResponseWriter, r *http.Request) {\n\tw.Write([]byte(\"Hello, World!\"))\n})\n\n// Start server\nerr := http.ListenAndServe(\":4242\", router)\n\n// output:\n// {\"time\":\"2023-10-15T20:32:58.926+02:00\",\"level\":\"INFO\",\"msg\":\"200: OK\",\"env\":\"production\",\"http\":{\"request\":{\"time\":\"2023-10-15T20:32:58.626+02:00\",\"method\":\"GET\",\"path\":\"/\",\"route\":\"\",\"ip\":\"127.0.0.1:55296\",\"length\":0},\"response\":{\"time\":\"2023-10-15T20:32:58.926+02:00\",\"latency\":100000,\"status\":200,\"length\":7},\"id\":\"\"}}\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-chi)\n- Fix [open issues](https://github.com/samber/slog-chi/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-chi)\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","funding_links":["https://github.com/sponsors/samber"],"categories":["Integrations"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamber%2Fslog-chi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamber%2Fslog-chi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamber%2Fslog-chi/lists"}