{"id":13830356,"url":"https://github.com/samber/slog-parquet","last_synced_at":"2026-02-02T20:13:52.380Z","repository":{"id":189253479,"uuid":"680345139","full_name":"samber/slog-parquet","owner":"samber","description":"🚨 slog: Parquet handler + Object Storage","archived":false,"fork":false,"pushed_at":"2024-05-01T18:40:44.000Z","size":315,"stargazers_count":9,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-02T01:14:02.253Z","etag":null,"topics":["apache","attribute","broker","error","format","go","golang","handler","log","log-level","logger","middleware","parquet","slog","structured-logging"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/samber/slog-parquet/v2","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-08-19T00:36:56.000Z","updated_at":"2024-05-29T22:52:56.215Z","dependencies_parsed_at":"2023-08-19T02:25:41.124Z","dependency_job_id":"81a0f9df-0abc-428d-bc8c-7e8804ac8117","html_url":"https://github.com/samber/slog-parquet","commit_stats":null,"previous_names":["samber/slog-parquet"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-parquet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-parquet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-parquet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samber%2Fslog-parquet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samber","download_url":"https://codeload.github.com/samber/slog-parquet/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":["apache","attribute","broker","error","format","go","golang","handler","log","log-level","logger","middleware","parquet","slog","structured-logging"],"created_at":"2024-08-04T10:00:58.985Z","updated_at":"2026-02-02T20:13:52.375Z","avatar_url":"https://github.com/samber.png","language":"Go","funding_links":["https://github.com/sponsors/samber"],"categories":["Log forwarding"],"sub_categories":[],"readme":"\n# slog: Parquet handler\n\n[![tag](https://img.shields.io/github/tag/samber/slog-parquet.svg)](https://github.com/samber/slog-parquet/releases)\n![Go Version](https://img.shields.io/badge/Go-%3E%3D%201.22-%23007d9c)\n[![GoDoc](https://godoc.org/github.com/samber/slog-parquet?status.svg)](https://pkg.go.dev/github.com/samber/slog-parquet)\n![Build Status](https://github.com/samber/slog-parquet/actions/workflows/test.yml/badge.svg)\n[![Go report](https://goreportcard.com/badge/github.com/samber/slog-parquet)](https://goreportcard.com/report/github.com/samber/slog-parquet)\n[![Coverage](https://img.shields.io/codecov/c/github/samber/slog-parquet)](https://codecov.io/gh/samber/slog-parquet)\n[![Contributors](https://img.shields.io/github/contributors/samber/slog-parquet)](https://github.com/samber/slog-parquet/graphs/contributors)\n[![License](https://img.shields.io/github/license/samber/slog-parquet)](./LICENSE)\n\nA [parquet](https://www.elastic.co/parquet/) 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://cast.ai/samuel\"\u003e\n    \u003cdiv\u003e\n      \u003cimg src=\"https://github.com/user-attachments/assets/502f8fa8-e7e8-4754-a51f-036d0443e694\" width=\"200\" alt=\"Cast AI\"\u003e\n    \u003c/div\u003e\n    \u003cdiv\u003e\n      Cut Kubernetes \u0026 AI costs, boost application stability\n    \u003c/div\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://www.dash0.com?utm_campaign=148395251-samber%20github%20sponsorship\u0026utm_source=github\u0026utm_medium=sponsorship\u0026utm_content=samber\"\u003e\n    \u003cdiv\u003e\n      \u003cimg src=\"https://github.com/user-attachments/assets/b1f2e876-0954-4dc3-824d-935d29ba8f3f\" width=\"200\" alt=\"Dash0\"\u003e\n    \u003c/div\u003e\n    \u003cdiv\u003e\n      100% OpenTelemetry-native observability platform\u003cbr\u003eSimple to use, built on open standards, and designed for full cost control\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-parquet/v2\n```\n\n**Compatibility**: go \u003e= 1.21\n\nNo breaking changes will be made to exported APIs before v3.0.0.\n\n## 💡 Usage\n\nGoDoc: [https://pkg.go.dev/github.com/samber/slog-parquet/v2](https://pkg.go.dev/github.com/samber/slog-parquet/v2)\n\n### Handler options\n\n```go\ntype Option struct {\n    // log level (default: debug)\n    Level slog.Leveler\n\n    // parquet rows buffer\n    Buffer slogparquet.ParquetBuffer\n\n    // optional: customize json payload builder\n    Converter Converter\n    // optional: fetch attributes from context\n    AttrFromContext []func(ctx context.Context) []slog.Attr\n\n    // optional: see slog.HandlerOptions\n    AddSource   bool\n    ReplaceAttr func(groups []string, a slog.Attr) slog.Attr\n}\n```\n\nOther global parameters:\n\n```go\nslogparquet.SourceKey = \"source\"\nslogparquet.ErrorKeys = []string{\"error\", \"err\"}\n```\n\n### Parquet buffer\n\n```go\nfunc NewParquetBuffer(bucket objstore.Bucket, prefix string, maxRecords int, maxInterval time.Duration) slogparquet.ParquetBuffer\n```\n\nAttributes will be injected in log payload.\n\n### Object storage\n\nSee [github.com/thanos-io/objstore](https://github.com/thanos-io/objstore).\n\n### Example\n\n```go\nimport (\n    \"log/slog\"\n\n    slogparquet \"github.com/samber/slog-parquet/v2\"\n    \"github.com/thanos-io/objstore/providers/s3\"\n)\n\nfunc main() {\n    bucket, _ := s3.NewBucketWithConfig(\n        slogparquet.NewLogger(),\n        s3.Config{\n            Endpoint:  os.Getenv(\"AWS_S3_ENDPOINT\"),\n            Region:    os.Getenv(\"AWS_S3_REGION\"),\n            Bucket:    os.Getenv(\"AWS_S3_BUCKET\"),\n            AccessKey: os.Getenv(\"AWS_ACCESS_KEY\"),\n            SecretKey: os.Getenv(\"AWS_SECRET_KEY\"),\n            PartSize:  16 * 1024 * 1024, // 16MB\n        },\n        \"logger\",\n    )\n\n    buffer := slogparquet.NewParquetBuffer(bucket, \"api/logs\", 10*1024*1024)\n\n    logger := slog.New(slogparquet.Option{Level: slog.LevelDebug, Buffer: buffer}.NewParquetHandler())\n    logger = logger.\n        With(\"environment\", \"dev\").\n        With(\"release\", \"v1.0.0\")\n\n    // log error\n    logger.\n        With(\"category\", \"sql\").\n        With(\"query.statement\", \"SELECT COUNT(*) FROM users;\").\n        With(\"query.duration\", 1*time.Second).\n        With(\"error\", fmt.Errorf(\"could not count users\")).\n        Error(\"caramba!\")\n\n    // log user signup\n    logger.\n        With(\n            slog.Group(\"user\",\n                slog.String(\"id\", \"user-123\"),\n                slog.Time(\"created_at\", time.Now()),\n            ),\n        ).\n        Info(\"user registration\")\n\n    buffer.Flush(true)\n    bucket.Close()\n}\n```\n\nOutput:\n\n```bash\n$ parquet meta ~/Downloads/00_17_08.d4d9f.parquet\n\nFile path:  /Users/samber/Downloads/00_17_08.d4d9f.parquet\nCreated by: github.com/samber/slog-parquet version (devel)(build )\nProperties: (none)\nSchema:\nmessage log {\n  required int64 time (TIMESTAMP(NANOS,true));\n  required binary log_level (STRING);\n  required binary message (STRING);\n  required binary attributes;\n  required binary source (STRING);\n}\n\n\nRow group 0:  count: 2  279.00 B records  start: 51  total(compressed): 558 B total(uncompressed):644 B \n--------------------------------------------------------------------------------\n            type      encodings count     avg size   nulls   min / max\ntime        INT64     F   _     2         22.50 B            \"2023-08-19T00:17:08.14408...\" / \"2023-08-19T00:17:08.14420...\"\nlog_level   BINARY    F         2         26.50 B            \"ERROR\" / \"INFO\"\nmessage     BINARY    F         2         35.00 B            \"caramba!\" / \"user registration\"\nattributes  BINARY    F         2         155.50 B           \"0x7B2263617465676F7279223...\" / \"0x7B22656E7669726F6E6D656...\"\nsource      BINARY    F         2         39.50 B            \"samber/slog-parquet\" / \"samber/slog-parquet\"\n```\n\n### Tracing\n\nImport the samber/slog-otel library.\n\n```go\nimport (\n\tslogparquet \"github.com/samber/slog-parquet\"\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\tslogparquet.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}.NewParquetHandler(),\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-parquet)\n- Fix [open issues](https://github.com/samber/slog-parquet/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-parquet)\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-parquet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamber%2Fslog-parquet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamber%2Fslog-parquet/lists"}