slog

Author: ma91n

source/_posts/20250730a_Go_1.25リリース連載始まります_&_trace.FlightRecorder.md

@@ -20,7 +20,7 @@ Go 1.25 のリリースが近づいてきました。今回は比較的シンプ
 | Date | Title            | Author     |
 | :--: | :--------------- | :--------- |
 | 7/30 | この記事         | 渋川       |
-| 7/31 | log/slog         | 武田さん   |
+| 7/31 | [log/slog](/articles/20250731a/)         | 武田さん   |
 | 8/1  | sync             | 辻さん     |
 | 8/4  | net/http         | 島ノ江さん |
 | 8/5  | testing/synctest | 市川燿さん |
@@ -188,3 +188,5 @@ func main() {
 いままでも便利な Trace はありましたが、FlightRecorder の「いつでもしておく」というのはオブザーバービリティ的な考えで良いですね。常に回しておける、というのは今までになかった使い方も出てくると思います。
 
 特定のエンドポイントやシグナルでダンプをどこかに出力するような仕組みを作ってみたり、ダウンロードできるエンドポイントを作っておく、というのも良いかもしれません。「なんか goroutine がブロックしているな」とか「なんかメモリ消費量が跳ね上がったな」みたいなタイミングで、過去 1 分間分のトレースをダウンロードして分析してみる、といったことができると、問題の分析の役に立つ気がします。
+
+次は武田さんの [log/slog](/articles/20250731a/) です。

source/_posts/20250731a_Go_1.25_リリース連載_log／slog.md

@@ -0,0 +1,168 @@
+---
+title: "Go 1.25 リリース連載 log/slog"
+date: 2025/07/31 00:00:00
+postid: a
+tag:
+  - Go
+  - Go1.25
+  - 構造化ログ
+  - ログ
+category:
+  - Programming
+thumbnail: /images/20250731a/thumbnail.jpg
+author: 武田大輝
+lede: "log/slog パッケージのアップデートについて紹介します。Go の log/slog パッケージは、Go 1.21 で導入された構造化ロギングをサポートする標準ライブラリです。"
+---
+
+<img src="/images/20250731a/top.jpg" alt="" width="512" height="512">
+
+# はじめに
+
+[Go 1.25 リリース連載](/articles/20250730a/) の 2 本目です。
+
+本記事では [log/slog パッケージ](https://pkg.go.dev/log/slog@go1.25rc2) のアップデートについて紹介します。
+Go の log/slog パッケージは、Go 1.21 で導入された構造化ロギングをサポートする標準ライブラリです。
+
+本記事では slog についての基本的は割愛しますが、slog の概要やこれまでのアップデート経緯をつかみたい方は、過去のリリース連載記事を参照してください。
+
+- [Go 1.21 連載始まります＆slog をどう使うべきか](/articles/20230731a/)
+- [Go 1.22 リリース連載 vet, log/slog, testing/slogtest](/articles/20240205a/)
+
+# アップデートの概要
+
+[リリースノート](https://go.dev/doc/go1.25#logslogpkglogslog) を参照してみましょう。
+
+> GroupAttrs creates a group Attr from a slice of Attr values.
+>
+> Record now has a Source method, returning its source location or nil if unavailable.
+
+- **`slog.GroupAttrs` の追加**
+   複数の属性 (`[]slog.Attr`) を簡潔にグルーピングできるようになりました。
+- **`Record.Source()` の公開**
+   ログエントリの発生元（ファイル・行番号・関数名）を取得できるようになりました。
+
+それぞれ詳細な内容を見ていきましょう。
+
+# アップデートの詳細
+
+## slog.GroupAttrs による属性のグルーピング（[#66365](https://github.com/golang/go/issues/66365)）
+
+`slog.GroupAttrs` を使用して構造化ログの属性（要素）をグルーピングできるようになりました。
+
+```go
+    g := slog.GroupAttrs("user",
+        slog.String("id", "00001"),
+        slog.String("name", "Bob"),
+    )
+    // {"level":"INFO","msg":"GroupAttrs","user":{"id":"00001","name":"Bob"}}
+    logger.Info("GroupAttrs", g)
+```
+
+属性のグルーピング自体はもともと `slog.Group` を使用して実現できましたが、属性を動的に生成する場合にいくつか使用上の問題がありました。
+
+### 属性が静的な場合
+
+```go
+    g := slog.Group("user",
+        slog.String("id", "00001"),
+        slog.String("name", "Bob"),
+    )
+    // {"level":"INFO","msg":"Group","user":{"id":"00001","name":"Bob"}}
+    logger.Info("Group", g)
+```
+
+### 属性が動的な場合
+
+条件に応じて属性を追加する場合などは `slog.Group` がうまく機能しません。
+
+```go
+    attrs := []slog.Attr{
+        slog.String("id", "00001"),
+        slog.String("name", "Bob"),
+    }
+
+    // 条件に応じて属性を追加
+    if showAge {
+        attrs = append(attrs, slog.Int("age", 36))
+    }
+
+    // []slog.Attr doesn't match []any となり動かない
+    g := slog.Group("user", attrs...)
+```
+
+そのためこれまでは `slog.Any` を利用したり、`[]slog.Attr` を `[]any` に変換したりして対応してきた背景があります。
+
+```go
+    // slog.Any を使用する
+    g := slog.Any("user", slog.GroupValue(attrs...))
+
+    // ヘルパーファンクションを用意して []any に変換する
+    g := slog.Group("key", attr2any(attrs)...)
+
+    // []any を使用する
+    var attrs []any
+    ...
+    g := slog.Group("key", attrs...)
+```
+
+このアプローチは any の使用が避けられず、適切なコードサジェストがなされないなど直感的ではないということで `[]slog.Attr` を引数として渡せる `slog.GroupAttrs` が生まれました。
+
+## record.Source によるソース情報の取得（[#70280](https://github.com/golang/go/issues/70280)）
+
+Go の log/slog では、1 件のログエントリを内部では `slog.Record` という構造体で表現しています。
+Go1.25 で追加された `record.Source` はレコードからログの発生元（ファイル名・行番号・関数名）を返します。
+ソースの [Diff](https://github.com/golang/go/commit/044ca4e5c878c785e2c69e5ebcb3d44bf97abc9f) を見るとはもともとパッケージ内限定（unexported）だったものが公開された（export）された形になります。
+
+これにより、自作のカスタムハンドラなどからもログのソース情報にアクセスできます。
+サンプルソースは次の通りです。
+
+```go
+func main() {
+    logger := slog.New(NewSourceHandler(slog.NewJSONHandler(os.Stdout, nil)))
+    g := slog.Group("user",
+        slog.String("id", "00001"),
+        slog.String("name", "Bob"),
+    )
+    // LOG from /xxx/main.go:61 (main)
+    logger.Info("Group", g)
+}
+
+
+type SourceHandler struct {
+    h slog.Handler
+}
+
+func NewSourceHandler(h slog.Handler) *SourceHandler {
+    return &SourceHandler{
+        h: h,
+    }
+}
+
+func (sh SourceHandler) Enabled(ctx context.Context, level slog.Level) bool {
+    return sh.h.Enabled(ctx, level)
+}
+
+func (sh SourceHandler) Handle(ctx context.Context, r slog.Record) error {
+    // ソース情報を出力
+    if src := r.Source(); src != nil {
+        fmt.Printf("LOG from %s:%d (%s)\n", src.File, src.Line, src.Function)
+    }
+    return sh.h.Handle(ctx, r)
+}
+
+func (sh SourceHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
+    return SourceHandler{h: sh.h.WithAttrs(attrs)}
+}
+
+func (sh SourceHandler) WithGroup(name string) slog.Handler {
+    return SourceHandler{h: sh.h.WithGroup(name)}
+}
+```
+
+# おわりに
+
+Go 1.25 の `log/slog` では、構造化ログの柔軟性と拡張性がさらに向上しました。
+
+サンプルのソースコードは [こちらのリポジトリ](https://github.com/rhumie/tech-blog-go-1.25-feature) で公開しています。
+
+次回は `sync` のアップデートについてです。