Go の Zap について学習します。

Zap - Golang learning step 6-2

<a href="https://roadmap.sh/" rel="noopener noreferrer" target="_blank">roadmap.sh</a> > <a href="https://roadmap.sh/golang" rel="noopener noreferrer" target="_blank">Go</a> > Logging > Zap の学習を進めていきます。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/303/01.png" width="1576" height="1146" alt="学習箇所"></div>
※ 学習メモとしての記録ですが、後にこのセクションを学ぶ道しるべとなるよう、ですます調で記載しています。
<h2 id="contents">contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#%E5%8F%82%E8%80%83-url">参考 URL</a></li>
<li><a href="#zap-%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8">Zap パッケージ</a>
<ol>
<li><a href="#zap-%E3%81%AE%E7%89%B9%E5%BE%B4">Zap の特徴</a></li>
</ol>
</li>
<li><a href="#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">インストール</a></li>
<li><a href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AA%E4%BD%BF%E7%94%A8%E4%BE%8B">基本的な使用例</a></li>
<li><a href="#%E9%96%8B%E7%99%BA%E5%90%91%E3%81%91%E3%81%AE%E7%B0%A1%E7%95%A5%E3%83%AD%E3%82%AC%E3%83%BC-sugaredlogger">開発向けの簡略ロガー (SugaredLogger)</a></li>
<li><a href="#sugaredlogger-%E3%81%A8-logger-%E3%81%AE%E9%81%95%E3%81%84">SugaredLogger と Logger の違い</a></li>
<li><a href="#%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E8%A8%AD%E5%AE%9A">カスタム設定</a></li>
<li><a href="#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E5%9E%8B">フィールドの型</a></li>
<li><a href="#%E3%82%A8%E3%83%A9%E3%83%BC%E3%83%8F%E3%83%B3%E3%83%89%E3%83%AA%E3%83%B3%E3%82%B0">エラーハンドリング</a></li>
<li><a href="#%E3%83%91%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%B3%E3%82%B9%E3%81%AE%E8%80%83%E6%85%AE%E7%82%B9">パフォーマンスの考慮点</a></li>
<li><a href="#logger-%E3%81%A8-sugaredlogger-%E3%81%AE%E4%BD%BF%E3%81%84%E5%88%86%E3%81%91">Logger と SugaredLogger の使い分け</a>
<ol>
<li><a href="#logger-%E3%82%92%E9%81%B8%E6%8A%9E%E3%81%99%E3%81%B9%E3%81%8D%E5%A0%B4%E5%90%88">Logger を選択すべき場合</a></li>
</ol>
</li>
</ol>
<h2 id="開発環境">開発環境</h2>
<ul>
<li>チップ: Apple M2 Pro</li>
<li>OS: macOS Sonoma</li>
<li>go version: go1.23.2 darwin/arm64</li>
</ul>
<h2 id="参考-url">参考 URL</h2>
<ul>
<li><a href="https://github.com/uber-go/zap" rel="noopener noreferrer" target="_blank">[OpenSource] Zap</a></li>
</ul>
<h2 id="zap-パッケージ">Zap パッケージ</h2>
Zap は、Uber が開発した高速かつ構造化されたロギングを提供する Go 用のロギングライブラリです。
<h3 id="zap-の特徴">Zap の特徴</h3>
<ol>
<li>高パフォーマンス
<ul>
<li>メモリアロケーションを最小限に抑えた設計</li>
<li>JSON 形式のログ出力に最適化</li>
</ul>
</li>
<li>レベルベースのロギング
<ul>
<li>Debug, Info, Warn, Error など一般的なログレベルをサポート</li>
</ul>
</li>
<li>構造化ログ
<ul>
<li>フィールドベースの柔軟なログ出力</li>
<li>JSON 形式での出力が容易</li>
</ul>
</li>
<li>柔軟な設定
<ul>
<li>開発モード用の「SugaredLogger」と、プロダクションモード用の「Logger」という2つのロガーを提供</li>
</ul>
</li>
</ol>
<h2 id="インストール">インストール</h2>
Zap は go get コマンドを使ってインストールします。
<pre><code class="hljs language-console">go get -u go.uber.org/zap
</code></pre>
<h2 id="基本的な使用例">基本的な使用例</h2>
以下のコードは、Zap の基本的な使い方を示しています。
<pre><code class="hljs language-go">package main

import (
 "go.uber.org/zap"
)

func main() {
 // デフォルトの Logger を作成
 logger, _ := zap.NewProduction() // プロダクション用
 defer logger.Sync() // ログをフラッシュしてリソースを解放

 // 構造化ログの記録
 logger.Info("これは情報レベルのログです",
 zap.String("key", "value"),
 zap.Int("attempt", 3),
 zap.Duration("backoff", 2),
 )

 // エラーレベルのログ
 logger.Error("エラーが発生しました",
 zap.String("原因", "無効な入力"),
 )
}
</code></pre>
出力:
<pre><code class="hljs language-console"># 構造化ログの記録
{"level":"info","ts":1733832023.54071,"caller":"main.go:16","msg":"これは情報レベルのログです","key":"value","attempt":3,"backoff":0.000000002}

# エラーレベルのログ
{"level":"error","ts":1733832023.5408251,"caller":"main.go:23","msg":"エラーが発生しました","原因":"無効な入力","stacktrace":"main.main01\n\t/path/to/root.main\n\t/path/to/root/main.go:6\nruntime.main\n\t/path/to/root/.goenv/versions/1.23.2/src/runtime/proc.go:272"}
</code></pre>
<h2 id="開発向けの簡略ロガー-sugaredlogger">開発向けの簡略ロガー (SugaredLogger)</h2>
開発時には、もう少し簡単に使える SugaredLogger が便利です。文字列のフォーマットを使ってログを記録できます。
<pre><code class="hljs language-go">package main

import (
 "go.uber.org/zap"
)

func main() {
 // Logger を作成
 logger, _ := zap.NewDevelopment()
 defer logger.Sync()

 // Logger を SugaredLogger に変換
 sugar := logger.Sugar()

 // フォーマットを使ったログ
 sugar.Infof("ユーザー %s が %d 回目の試行に成功しました", "Alice", 3)

 // その他の簡略ログ
 sugar.Infow("試行成功",
 "user", "Alice",
 "attempt", 3,
 )
}
</code></pre>
出力:
<pre><code class="hljs language-console">2024-12-10T21:13:20.783+0900 INFO main.go:58 ユーザー Alice が 3 回目の試行に成功しました
2024-12-10T21:13:20.783+0900 INFO main.go:61 試行成功 {"user": "Alice", "attempt": 3}
</code></pre>
<h2 id="sugaredlogger-と-logger-の違い">SugaredLogger と Logger の違い</h2>
<ul>
<li><code>SugaredLogger</code>:
<ul>
<li>フォーマット文字列（例: "%s"）や非構造化なログをサポート。</li>
<li>使いやすいが、構造化ログのパフォーマンスが若干低下する場合がある。</li>
</ul>
</li>
<li><code>Logger</code>:
<ul>
<li>高性能な構造化ログ用。</li>
<li>フィールド付きログ（例: zap.String("key", "value")）を使う。</li>
</ul>
</li>
</ul>
<pre><code class="hljs language-go">// 通常の Logger
logger, _ := zap.NewProduction()
logger.Info("メッセージ", zap.Int("count", 5))

// SugaredLogger
sugar := logger.Sugar()
sugar.Infof("カウント: %d", 5)
</code></pre>
<h2 id="カスタム設定">カスタム設定</h2>
Logger の動作をカスタマイズする例：
<pre><code class="hljs language-go">package main

import (
 "go.uber.org/zap"
 "go.uber.org/zap/zapcore"
)

func main() {
 config := zap.Config{
 Level: zap.NewAtomicLevelAt(zap.InfoLevel),
 Development: false,
 Encoding: "json",
 EncoderConfig: zapcore.EncoderConfig{
 TimeKey: "time",
 LevelKey: "level",
 NameKey: "logger",
 MessageKey: "msg",
 StacktraceKey: "stacktrace",
 EncodeTime: zapcore.ISO8601TimeEncoder,
 EncodeLevel: zapcore.LowercaseLevelEncoder,
 },
 OutputPaths: []string{"stdout"},
 ErrorOutputPaths: []string{"stderr"},
 }

 logger, _ := config.Build()
 defer logger.Sync()

 logger.Info("アプリケーションが起動しました")
}
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"info","time":"2024-12-10T21:22:01.560+0900","msg":"アプリケーションが起動しました"}
</code></pre>
<h2 id="フィールドの型">フィールドの型</h2>
Zap は様々な型のフィールドをサポートしています。
<pre><code class="hljs language-go">logger, _ := zap.NewDevelopment()
defer logger.Sync()

logger.Info("詳細情報",
 zap.String("name", "テスト"),
 zap.Int("age", 25),
 zap.Bool("active", true),
 zap.Float64("score", 85.5),
 zap.Duration("elapsed", time.Second*10),
)
</code></pre>
出力:
<pre><code class="hljs language-console">2024-12-10T21:25:39.371+0900 INFO main.go:81 詳細情報 {"name": "テスト", "age": 25, "active": true, "score": 85.5, "elapsed": "10s"}
</code></pre>
<h2 id="エラーハンドリング">エラーハンドリング</h2>
エラー情報をログ出力する例
<pre><code class="hljs language-go">package main

import (
 "errors"
 "go.uber.org/zap"
)

// エラーを返す処理を模擬するための関数
func doSomething() error {
 return errors.New("何かしらのエラーが発生")
}

func someFunction() error {
 // Logger の作成（実際のアプリケーションではグローバルに保持することが多い）
 logger, err := zap.NewProduction()
 if err != nil {
 return err
 }
 defer logger.Sync()

 err = doSomething()
 if err != nil {
 // エラー情報を構造化してログ出力
 logger.Error("処理に失敗しました",
 zap.Error(err),
 zap.String("function", "someFunction"),
 )
 return err
 }
 return nil
}

func main() {
 if err := someFunction(); err != nil {
 // main 関数でのエラーハンドリング
 // この例では単純にプログラムを終了させていますが、
 // 実際のアプリケーションでは適切なエラーハンドリングを行ってください
 return
 }
}
</code></pre>
このコードを実行すると、以下のような JSON 形式のエラーログが出力されます。
<pre><code class="hljs language-console">{
 "level": "error",
 "ts": 1702184400.123456,
 "caller": "example/main.go:23",
 "msg": "処理に失敗しました",
 "error": "何かしらのエラーが発生",
 "function": "someFunction"
}
</code></pre>
<h2 id="パフォーマンスの考慮点">パフォーマンスの考慮点</h2>
<ol>
<li><code>Logger</code> は通常アプリケーション起動時に 1 度だけ作成し、グローバル変数や依存性注入で使い回す</li>
<li><code>defer logger.Sync()</code> を使用してバッファされたログを確実にフラッシュする</li>
<li>不要なログレベルは設定で無効化することでパフォーマンスを改善できる</li>
</ol>
<h2 id="logger-と-sugaredlogger-の使い分け">Logger と SugaredLogger の使い分け</h2>
Logger と SugaredLogger はそれぞれ特徴があり、使用状況によって適切な選択が異なります。以下のポイントを考慮して選択してください。
<h3 id="logger-を選択すべき場合">Logger を選択すべき場合</h3>
<ol>
<li>パフォーマンスが重要視される場合
<ul>
<li>高スループットが要求される本番環境</li>
<li>大量のログ出力が予想される場合</li>
<li>メモリ使用量を最小限に抑えたい場合</li>
</ul>
</li>
<li>構造化ログが必要な場合
<ul>
<li>ログの解析や集計が必要な場合</li>
<li>ELK スタックなどのログ分析基盤と連携する場合</li>
<li>JSON 形式での出力が要件の場合</li>
</ul>
</li>
<li>型安全性が重要な場合
<ul>
<li>コンパイル時の型チェックを活用したい場合</li>
<li>フィールド名のタイプミスを防ぎたい場合</li>
</ul>
</li>
</ol>
<h2 id="まとめ">まとめ</h2>
<ul>
<li>Zap は高速かつ構造化されたロギングを提供する Go 用のライブラリ</li>
<li>Logger と SugaredLogger の 2 種類のロガーを提供</li>
<li>高性能な構造化ログを JSON 形式で出力可能</li>
<li>開発向けの簡易ロガーとして SugaredLogger を利用可能</li>
<li>柔軟なカスタマイズが可能な設定オプションを提供</li>
<li>フィールドベースのログで型安全性を確保</li>
<li>ログレベルの設定で不要なログを抑制可能</li>
<li>パフォーマンスと使いやすさを両立した設計</li>
</ul>
<hr>
<hr>
[Next] <a href="/posts/304">Step 6-3: Zerolog</a>
[Prev] <a href="/posts/302">Step 6-1: log/slog</a>

<a href="https://roadmap.sh/" rel="noopener noreferrer" target="_blank">roadmap.sh</a> > <a href="https://roadmap.sh/golang" rel="noopener noreferrer" target="_blank">Go</a> > Logging > Zap の学習を進めていきます。
<div class="img_wrap"><img src="/images/posts/303/01.png" width="1576" height="1146" alt="学習箇所"></div>
※ 学習メモとしての記録ですが、後にこのセクションを学ぶ道しるべとなるよう、ですます調で記載しています。
<h2 id="contents">contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#%E5%8F%82%E8%80%83-url">参考 URL</a></li>
<li><a href="#zap-%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8">Zap パッケージ</a>
<ol>
<li><a href="#zap-%E3%81%AE%E7%89%B9%E5%BE%B4">Zap の特徴</a></li>
</ol>
</li>
<li><a href="#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">インストール</a></li>
<li><a href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AA%E4%BD%BF%E7%94%A8%E4%BE%8B">基本的な使用例</a></li>
<li><a href="#%E9%96%8B%E7%99%BA%E5%90%91%E3%81%91%E3%81%AE%E7%B0%A1%E7%95%A5%E3%83%AD%E3%82%AC%E3%83%BC-sugaredlogger">開発向けの簡略ロガー (SugaredLogger)</a></li>
<li><a href="#sugaredlogger-%E3%81%A8-logger-%E3%81%AE%E9%81%95%E3%81%84">SugaredLogger と Logger の違い</a></li>
<li><a href="#%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E8%A8%AD%E5%AE%9A">カスタム設定</a></li>
<li><a href="#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E5%9E%8B">フィールドの型</a></li>
<li><a href="#%E3%82%A8%E3%83%A9%E3%83%BC%E3%83%8F%E3%83%B3%E3%83%89%E3%83%AA%E3%83%B3%E3%82%B0">エラーハンドリング</a></li>
<li><a href="#%E3%83%91%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%B3%E3%82%B9%E3%81%AE%E8%80%83%E6%85%AE%E7%82%B9">パフォーマンスの考慮点</a></li>
<li><a href="#logger-%E3%81%A8-sugaredlogger-%E3%81%AE%E4%BD%BF%E3%81%84%E5%88%86%E3%81%91">Logger と SugaredLogger の使い分け</a>
<ol>
<li><a href="#logger-%E3%82%92%E9%81%B8%E6%8A%9E%E3%81%99%E3%81%B9%E3%81%8D%E5%A0%B4%E5%90%88">Logger を選択すべき場合</a></li>
</ol>
</li>
</ol>
<h2 id="開発環境">開発環境</h2>
<ul>
<li>チップ: Apple M2 Pro</li>
<li>OS: macOS Sonoma</li>
<li>go version: go1.23.2 darwin/arm64</li>
</ul>
<h2 id="参考-url">参考 URL</h2>
<ul>
<li><a href="https://github.com/uber-go/zap" rel="noopener noreferrer" target="_blank">[OpenSource] Zap</a></li>
</ul>
<h2 id="zap-パッケージ">Zap パッケージ</h2>
Zap は、Uber が開発した高速かつ構造化されたロギングを提供する Go 用のロギングライブラリです。
<h3 id="zap-の特徴">Zap の特徴</h3>
<ol>
<li>高パフォーマンス
<ul>
<li>メモリアロケーションを最小限に抑えた設計</li>
<li>JSON 形式のログ出力に最適化</li>
</ul>
</li>
<li>レベルベースのロギング
<ul>
<li>Debug, Info, Warn, Error など一般的なログレベルをサポート</li>
</ul>
</li>
<li>構造化ログ
<ul>
<li>フィールドベースの柔軟なログ出力</li>
<li>JSON 形式での出力が容易</li>
</ul>
</li>
<li>柔軟な設定
<ul>
<li>開発モード用の「SugaredLogger」と、プロダクションモード用の「Logger」という2つのロガーを提供</li>
</ul>
</li>
</ol>
<h2 id="インストール">インストール</h2>
Zap は go get コマンドを使ってインストールします。
<pre><code class="hljs language-console">go get -u go.uber.org/zap
</code></pre>
<h2 id="基本的な使用例">基本的な使用例</h2>
以下のコードは、Zap の基本的な使い方を示しています。
<pre><code class="hljs language-go">package main

import (
 "go.uber.org/zap"
)

func main() {
 // デフォルトの Logger を作成
 logger, _ := zap.NewProduction() // プロダクション用
 defer logger.Sync() // ログをフラッシュしてリソースを解放

 // 構造化ログの記録
 logger.Info("これは情報レベルのログです",
 zap.String("key", "value"),
 zap.Int("attempt", 3),
 zap.Duration("backoff", 2),
 )

 // エラーレベルのログ
 logger.Error("エラーが発生しました",
 zap.String("原因", "無効な入力"),
 )
}
</code></pre>
出力:
<pre><code class="hljs language-console"># 構造化ログの記録
{"level":"info","ts":1733832023.54071,"caller":"main.go:16","msg":"これは情報レベルのログです","key":"value","attempt":3,"backoff":0.000000002}

# エラーレベルのログ
{"level":"error","ts":1733832023.5408251,"caller":"main.go:23","msg":"エラーが発生しました","原因":"無効な入力","stacktrace":"main.main01\n\t/path/to/root.main\n\t/path/to/root/main.go:6\nruntime.main\n\t/path/to/root/.goenv/versions/1.23.2/src/runtime/proc.go:272"}
</code></pre>
<h2 id="開発向けの簡略ロガー-sugaredlogger">開発向けの簡略ロガー (SugaredLogger)</h2>
開発時には、もう少し簡単に使える SugaredLogger が便利です。文字列のフォーマットを使ってログを記録できます。
<pre><code class="hljs language-go">package main

import (
 "go.uber.org/zap"
)

func main() {
 // Logger を作成
 logger, _ := zap.NewDevelopment()
 defer logger.Sync()

 // Logger を SugaredLogger に変換
 sugar := logger.Sugar()

 // フォーマットを使ったログ
 sugar.Infof("ユーザー %s が %d 回目の試行に成功しました", "Alice", 3)

 // その他の簡略ログ
 sugar.Infow("試行成功",
 "user", "Alice",
 "attempt", 3,
 )
}
</code></pre>
出力:
<pre><code class="hljs language-console">2024-12-10T21:13:20.783+0900 INFO main.go:58 ユーザー Alice が 3 回目の試行に成功しました
2024-12-10T21:13:20.783+0900 INFO main.go:61 試行成功 {"user": "Alice", "attempt": 3}
</code></pre>
<h2 id="sugaredlogger-と-logger-の違い">SugaredLogger と Logger の違い</h2>
<ul>
<li><code>SugaredLogger</code>:
<ul>
<li>フォーマット文字列（例: "%s"）や非構造化なログをサポート。</li>
<li>使いやすいが、構造化ログのパフォーマンスが若干低下する場合がある。</li>
</ul>
</li>
<li><code>Logger</code>:
<ul>
<li>高性能な構造化ログ用。</li>
<li>フィールド付きログ（例: zap.String("key", "value")）を使う。</li>
</ul>
</li>
</ul>
<pre><code class="hljs language-go">// 通常の Logger
logger, _ := zap.NewProduction()
logger.Info("メッセージ", zap.Int("count", 5))

// SugaredLogger
sugar := logger.Sugar()
sugar.Infof("カウント: %d", 5)
</code></pre>
<h2 id="カスタム設定">カスタム設定</h2>
Logger の動作をカスタマイズする例：
<pre><code class="hljs language-go">package main

import (
 "go.uber.org/zap"
 "go.uber.org/zap/zapcore"
)

func main() {
 config := zap.Config{
 Level: zap.NewAtomicLevelAt(zap.InfoLevel),
 Development: false,
 Encoding: "json",
 EncoderConfig: zapcore.EncoderConfig{
 TimeKey: "time",
 LevelKey: "level",
 NameKey: "logger",
 MessageKey: "msg",
 StacktraceKey: "stacktrace",
 EncodeTime: zapcore.ISO8601TimeEncoder,
 EncodeLevel: zapcore.LowercaseLevelEncoder,
 },
 OutputPaths: []string{"stdout"},
 ErrorOutputPaths: []string{"stderr"},
 }

 logger, _ := config.Build()
 defer logger.Sync()

 logger.Info("アプリケーションが起動しました")
}
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"info","time":"2024-12-10T21:22:01.560+0900","msg":"アプリケーションが起動しました"}
</code></pre>
<h2 id="フィールドの型">フィールドの型</h2>
Zap は様々な型のフィールドをサポートしています。
<pre><code class="hljs language-go">logger, _ := zap.NewDevelopment()
defer logger.Sync()

logger.Info("詳細情報",
 zap.String("name", "テスト"),
 zap.Int("age", 25),
 zap.Bool("active", true),
 zap.Float64("score", 85.5),
 zap.Duration("elapsed", time.Second*10),
)
</code></pre>
出力:
<pre><code class="hljs language-console">2024-12-10T21:25:39.371+0900 INFO main.go:81 詳細情報 {"name": "テスト", "age": 25, "active": true, "score": 85.5, "elapsed": "10s"}
</code></pre>
<h2 id="エラーハンドリング">エラーハンドリング</h2>
エラー情報をログ出力する例
<pre><code class="hljs language-go">package main

import (
 "errors"
 "go.uber.org/zap"
)

// エラーを返す処理を模擬するための関数
func doSomething() error {
 return errors.New("何かしらのエラーが発生")
}

func someFunction() error {
 // Logger の作成（実際のアプリケーションではグローバルに保持することが多い）
 logger, err := zap.NewProduction()
 if err != nil {
 return err
 }
 defer logger.Sync()

 err = doSomething()
 if err != nil {
 // エラー情報を構造化してログ出力
 logger.Error("処理に失敗しました",
 zap.Error(err),
 zap.String("function", "someFunction"),
 )
 return err
 }
 return nil
}

func main() {
 if err := someFunction(); err != nil {
 // main 関数でのエラーハンドリング
 // この例では単純にプログラムを終了させていますが、
 // 実際のアプリケーションでは適切なエラーハンドリングを行ってください
 return
 }
}
</code></pre>
このコードを実行すると、以下のような JSON 形式のエラーログが出力されます。
<pre><code class="hljs language-console">{
 "level": "error",
 "ts": 1702184400.123456,
 "caller": "example/main.go:23",
 "msg": "処理に失敗しました",
 "error": "何かしらのエラーが発生",
 "function": "someFunction"
}
</code></pre>
<h2 id="パフォーマンスの考慮点">パフォーマンスの考慮点</h2>
<ol>
<li><code>Logger</code> は通常アプリケーション起動時に 1 度だけ作成し、グローバル変数や依存性注入で使い回す</li>
<li><code>defer logger.Sync()</code> を使用してバッファされたログを確実にフラッシュする</li>
<li>不要なログレベルは設定で無効化することでパフォーマンスを改善できる</li>
</ol>
<h2 id="logger-と-sugaredlogger-の使い分け">Logger と SugaredLogger の使い分け</h2>
Logger と SugaredLogger はそれぞれ特徴があり、使用状況によって適切な選択が異なります。以下のポイントを考慮して選択してください。
<h3 id="logger-を選択すべき場合">Logger を選択すべき場合</h3>
<ol>
<li>パフォーマンスが重要視される場合
<ul>
<li>高スループットが要求される本番環境</li>
<li>大量のログ出力が予想される場合</li>
<li>メモリ使用量を最小限に抑えたい場合</li>
</ul>
</li>
<li>構造化ログが必要な場合
<ul>
<li>ログの解析や集計が必要な場合</li>
<li>ELK スタックなどのログ分析基盤と連携する場合</li>
<li>JSON 形式での出力が要件の場合</li>
</ul>
</li>
<li>型安全性が重要な場合
<ul>
<li>コンパイル時の型チェックを活用したい場合</li>
<li>フィールド名のタイプミスを防ぎたい場合</li>
</ul>
</li>
</ol>
<h2 id="まとめ">まとめ</h2>
<ul>
<li>Zap は高速かつ構造化されたロギングを提供する Go 用のライブラリ</li>
<li>Logger と SugaredLogger の 2 種類のロガーを提供</li>
<li>高性能な構造化ログを JSON 形式で出力可能</li>
<li>開発向けの簡易ロガーとして SugaredLogger を利用可能</li>
<li>柔軟なカスタマイズが可能な設定オプションを提供</li>
<li>フィールドベースのログで型安全性を確保</li>
<li>ログレベルの設定で不要なログを抑制可能</li>
<li>パフォーマンスと使いやすさを両立した設計</li>
</ul>
<hr>
<hr>
[Next] <a href="/posts/304">Step 6-3: Zerolog</a>
[Prev] <a href="/posts/302">Step 6-1: log/slog</a>

Author