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

Zerolog - Golang learning step 6-3

<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 > Zerolog の学習を進めていきます。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/304/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="#zerolog-%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8">Zerolog パッケージ</a></li>
<li><a href="#zerolog-%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Zerolog のインストール</a></li>
<li><a href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AA%E4%BD%BF%E3%81%84%E6%96%B9">基本的な使い方</a></li>
<li><a href="#json-%E5%BD%A2%E5%BC%8F%E3%81%AE%E3%83%AD%E3%82%B0">JSON 形式のログ</a></li>
<li><a href="#%E3%83%AD%E3%82%B0%E3%83%AC%E3%83%99%E3%83%AB">ログレベル</a>
<ol>
<li><a href="#%E3%83%AD%E3%82%B0%E3%83%AC%E3%83%99%E3%83%AB%E3%81%AE%E8%A8%AD%E5%AE%9A">ログレベルの設定</a></li>
</ol>
</li>
<li><a href="#%E3%82%B3%E3%83%B3%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E6%B4%BB%E7%94%A8">コンテキストの活用</a></li>
<li><a href="#%E3%82%A8%E3%83%A9%E3%83%BC%E3%81%AE%E3%83%AD%E3%82%B0%E8%A8%98%E9%8C%B2">エラーのログ記録</a></li>
<li><a href="#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E3%83%AD%E3%82%B0%E3%82%92%E4%BF%9D%E5%AD%98">ファイルにログを保存</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>
</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/rs/zerolog" rel="noopener noreferrer" target="_blank">[OpenSource] Zerolog</a></li>
</ul>
<h2 id="zerolog-パッケージ">Zerolog パッケージ</h2>
Zerolog は、Go の高性能かつ使いやすいログライブラリです。他の一般的なログライブラリ（例: logrus や zap）と比較して依存関係が少なく軽量、低いメモリ使用量と高速なログ処理が特徴です。また、JSON 形式の構造化ログをデフォルトでサポートしており、ログの管理や分析に適しています。
<h2 id="zerolog-のインストール">Zerolog のインストール</h2>
Zerolog は <code>go get</code> コマンドを使ってインストールします。
<pre><code class="hljs language-console">go get -u github.com/rs/zerolog
</code></pre>
<h2 id="基本的な使い方">基本的な使い方</h2>
以下は、Zerolog を使った簡単なログの例です。
<pre><code class="hljs language-go">package main

import (
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
 "os"
)

func main() {
 // 標準出力にログを出力
 log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout})

 // 情報ログ
 log.Info().Msg("アプリケーションが起動しました")

 // 構造化ログ
 log.Info().
 Str("user", "test_user").
 Int("attempt", 3).
 Msg("ログイン試行")

 // エラーログ
 log.Error().
 Err(nil).
 Str("reason", "無効なパスワード").
 Msg("ログイン失敗")
}
</code></pre>
<ul>
<li><code>log.Info().Msg()</code> のようにログレベルを指定してメッセージを出力できます。</li>
<li><code>Str</code> や <code>Int</code> メソッドを使って構造化データを追加できます。</li>
</ul>
このコードを実行すると、以下のようなログが出力されます。
<pre><code class="hljs language-console">10:26PM INF アプリケーションが起動しました
10:26PM INF ログイン試行 attempt=3 user=test_user
10:26PM ERR ログイン失敗 reason="無効なパスワード"
</code></pre>
<h2 id="json-形式のログ">JSON 形式のログ</h2>
Zerolog のデフォルト出力は JSON 形式です。以下のコードでは JSON 形式のログを出力します。
<pre><code class="hljs language-go">package main

import (
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // JSON ログの例
 log.Info().
 Str("event", "user_signup").
 Str("user", "test_user").
 Msg("ユーザー登録が完了しました")
}
</code></pre>
このコードを実行すると、以下のような JSON 形式のログが出力されます。
<pre><code class="hljs language-console">{"level":"info","event":"user_signup","user":"test_user","time":"2024-12-11T22:28:36+09:00","message":"ユーザー登録が完了しました"}
</code></pre>
デフォルトでタイムスタンプ（<code>time</code> フィールド）が含まれますが、<code>zerolog.TimeFieldFormat</code> を使ってカスタマイズすることも可能です。
<h2 id="ログレベル">ログレベル</h2>
Zerolog は以下のログレベルをサポートしています。
<code>Trace</code>, <code>Debug</code>, <code>Info</code>, <code>Warn</code>, <code>Error</code>, <code>Fatal</code>, <code>Panic</code>
<pre><code class="hljs language-go">log.Debug().Msg("デバッグ情報")
log.Info().Msg("一般的な情報")
log.Warn().Msg("警告")
log.Error().Msg("エラー")
</code></pre>
<h3 id="ログレベルの設定">ログレベルの設定</h3>
Zerolog では、ログレベルを動的に変更することができます。以下のように <code>zerolog.SetGlobalLevel</code> を使ってログレベルを指定できます。
<pre><code class="hljs language-go">package main

import (
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // デフォルトは Info レベル
 zerolog.SetGlobalLevel(zerolog.WarnLevel)

 // このログは出力されない（Info レベル）
 log.Info().Msg("このログは表示されません")

 // このログは出力される（Warn レベル以上）
 log.Warn().Msg("警告ログです")
 log.Error().Msg("エラーログです")
}
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"warn","time":"2024-12-11T22:31:23+09:00","message":"警告ログです"}
{"level":"error","time":"2024-12-11T22:31:23+09:00","message":"エラーログです"}
</code></pre>
なお、設定したログレベル以下のログは出力されません。例えば、<code>zerolog.WarnLevel</code> に設定すると、<code>Info</code> や <code>Debug</code> レベルのログは無視されます。
<h2 id="コンテキストの活用">コンテキストの活用</h2>
ログにコンテキスト情報を追加できます。
<pre><code class="hljs language-go">logger := log.With().
 Str("service", "auth-service").
 Str("version", "1.0.0").
 Logger()

logger.Info().Msg("サービスを起動しました")
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"info","service":"auth-service","version":"1.0.0","time":"2024-12-11T22:34:56+09:00","message":"サービスを起動しました"}
</code></pre>
<h2 id="エラーのログ記録">エラーのログ記録</h2>
エラー情報を構造化して記録できます
<pre><code class="hljs language-go">func someFunction() error {
 return fmt.Errorf("エラーになりました")
}
func main() {
 err := someFunction()
 if err != nil {
 log.Error().
 Err(err).
 Str("function", "someFunction").
 Msg("処理に失敗しました")
 }
}
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"error","error":"エラーになりました","function":"someFunction","time":"2024-12-11T22:37:40+09:00","message":"処理に失敗しました"}
</code></pre>
<h2 id="ファイルにログを保存">ファイルにログを保存</h2>
ログをファイルに保存するには、<code>log.Output()</code> を使います。
<pre><code class="hljs language-go">package main

import (
 "os"
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // ファイルを開く
 file, err := os.Create("app.log")
 if err != nil {
 log.Fatal().Err(err).Msg("ログファイルを作成できませんでした")
 }
 defer file.Close()

 // ファイルにログを出力
 log.Logger = log.Output(file)

 log.Info().Msg("ファイルにログを出力しました")
}
</code></pre>
出力(app.log):
<pre><code class="hljs language-console">{"level":"info","time":"2024-12-11T22:39:38+09:00","message":"ファイルにログを出力しました"}
</code></pre>
<h2 id="パフォーマンスの考慮点">パフォーマンスの考慮点</h2>
Zerolog は高パフォーマンスを重視して設計されていますが、以下の点に注意が必要です：
<ol>
<li>不要なログレベルは無効化する</li>
<li>フィールド名は短く意味のある名前にする</li>
<li>大量のログ出力時はサンプリングを検討する</li>
</ol>
例: サンプリングを有効にするには以下のように設定します。
<pre><code class="hljs language-go">log.Logger = log.Sample(&#x26;zerolog.BasicSampler{N: 10}) // 10回に1回のログ出力 
</code></pre>
<h2 id="まとめ">まとめ</h2>
<ul>
<li>Zerolog は軽量で高性能な Go のログライブラリ。依存関係が少なく、ゼロアロケーションを実現</li>
<li>JSON 形式の構造化ログをデフォルトでサポートし、可読性と解析性が高い</li>
<li>7 段階のログレベル（Trace, Debug, Info, Warn, Error, Fatal, Panic）のサポート</li>
<li>コンテキスト情報を活用した詳細な構造化ログの作成が容易</li>
<li>ファイル出力やコンソール出力など、柔軟な出力先の設定が可能</li>
<li>サンプリング機能による大量ログ出力時のパフォーマンス最適化</li>
</ul>
<hr>
<hr>
[Prev] <a href="/posts/303">Step 6-2: Zap</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 > Zerolog の学習を進めていきます。
<div class="img_wrap"><img src="/images/posts/304/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="#zerolog-%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8">Zerolog パッケージ</a></li>
<li><a href="#zerolog-%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Zerolog のインストール</a></li>
<li><a href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AA%E4%BD%BF%E3%81%84%E6%96%B9">基本的な使い方</a></li>
<li><a href="#json-%E5%BD%A2%E5%BC%8F%E3%81%AE%E3%83%AD%E3%82%B0">JSON 形式のログ</a></li>
<li><a href="#%E3%83%AD%E3%82%B0%E3%83%AC%E3%83%99%E3%83%AB">ログレベル</a>
<ol>
<li><a href="#%E3%83%AD%E3%82%B0%E3%83%AC%E3%83%99%E3%83%AB%E3%81%AE%E8%A8%AD%E5%AE%9A">ログレベルの設定</a></li>
</ol>
</li>
<li><a href="#%E3%82%B3%E3%83%B3%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E6%B4%BB%E7%94%A8">コンテキストの活用</a></li>
<li><a href="#%E3%82%A8%E3%83%A9%E3%83%BC%E3%81%AE%E3%83%AD%E3%82%B0%E8%A8%98%E9%8C%B2">エラーのログ記録</a></li>
<li><a href="#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E3%83%AD%E3%82%B0%E3%82%92%E4%BF%9D%E5%AD%98">ファイルにログを保存</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>
</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/rs/zerolog" rel="noopener noreferrer" target="_blank">[OpenSource] Zerolog</a></li>
</ul>
<h2 id="zerolog-パッケージ">Zerolog パッケージ</h2>
Zerolog は、Go の高性能かつ使いやすいログライブラリです。他の一般的なログライブラリ（例: logrus や zap）と比較して依存関係が少なく軽量、低いメモリ使用量と高速なログ処理が特徴です。また、JSON 形式の構造化ログをデフォルトでサポートしており、ログの管理や分析に適しています。
<h2 id="zerolog-のインストール">Zerolog のインストール</h2>
Zerolog は <code>go get</code> コマンドを使ってインストールします。
<pre><code class="hljs language-console">go get -u github.com/rs/zerolog
</code></pre>
<h2 id="基本的な使い方">基本的な使い方</h2>
以下は、Zerolog を使った簡単なログの例です。
<pre><code class="hljs language-go">package main

import (
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
 "os"
)

func main() {
 // 標準出力にログを出力
 log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout})

 // 情報ログ
 log.Info().Msg("アプリケーションが起動しました")

 // 構造化ログ
 log.Info().
 Str("user", "test_user").
 Int("attempt", 3).
 Msg("ログイン試行")

 // エラーログ
 log.Error().
 Err(nil).
 Str("reason", "無効なパスワード").
 Msg("ログイン失敗")
}
</code></pre>
<ul>
<li><code>log.Info().Msg()</code> のようにログレベルを指定してメッセージを出力できます。</li>
<li><code>Str</code> や <code>Int</code> メソッドを使って構造化データを追加できます。</li>
</ul>
このコードを実行すると、以下のようなログが出力されます。
<pre><code class="hljs language-console">10:26PM INF アプリケーションが起動しました
10:26PM INF ログイン試行 attempt=3 user=test_user
10:26PM ERR ログイン失敗 reason="無効なパスワード"
</code></pre>
<h2 id="json-形式のログ">JSON 形式のログ</h2>
Zerolog のデフォルト出力は JSON 形式です。以下のコードでは JSON 形式のログを出力します。
<pre><code class="hljs language-go">package main

import (
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // JSON ログの例
 log.Info().
 Str("event", "user_signup").
 Str("user", "test_user").
 Msg("ユーザー登録が完了しました")
}
</code></pre>
このコードを実行すると、以下のような JSON 形式のログが出力されます。
<pre><code class="hljs language-console">{"level":"info","event":"user_signup","user":"test_user","time":"2024-12-11T22:28:36+09:00","message":"ユーザー登録が完了しました"}
</code></pre>
デフォルトでタイムスタンプ（<code>time</code> フィールド）が含まれますが、<code>zerolog.TimeFieldFormat</code> を使ってカスタマイズすることも可能です。
<h2 id="ログレベル">ログレベル</h2>
Zerolog は以下のログレベルをサポートしています。
<code>Trace</code>, <code>Debug</code>, <code>Info</code>, <code>Warn</code>, <code>Error</code>, <code>Fatal</code>, <code>Panic</code>
<pre><code class="hljs language-go">log.Debug().Msg("デバッグ情報")
log.Info().Msg("一般的な情報")
log.Warn().Msg("警告")
log.Error().Msg("エラー")
</code></pre>
<h3 id="ログレベルの設定">ログレベルの設定</h3>
Zerolog では、ログレベルを動的に変更することができます。以下のように <code>zerolog.SetGlobalLevel</code> を使ってログレベルを指定できます。
<pre><code class="hljs language-go">package main

import (
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // デフォルトは Info レベル
 zerolog.SetGlobalLevel(zerolog.WarnLevel)

 // このログは出力されない（Info レベル）
 log.Info().Msg("このログは表示されません")

 // このログは出力される（Warn レベル以上）
 log.Warn().Msg("警告ログです")
 log.Error().Msg("エラーログです")
}
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"warn","time":"2024-12-11T22:31:23+09:00","message":"警告ログです"}
{"level":"error","time":"2024-12-11T22:31:23+09:00","message":"エラーログです"}
</code></pre>
なお、設定したログレベル以下のログは出力されません。例えば、<code>zerolog.WarnLevel</code> に設定すると、<code>Info</code> や <code>Debug</code> レベルのログは無視されます。
<h2 id="コンテキストの活用">コンテキストの活用</h2>
ログにコンテキスト情報を追加できます。
<pre><code class="hljs language-go">logger := log.With().
 Str("service", "auth-service").
 Str("version", "1.0.0").
 Logger()

logger.Info().Msg("サービスを起動しました")
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"info","service":"auth-service","version":"1.0.0","time":"2024-12-11T22:34:56+09:00","message":"サービスを起動しました"}
</code></pre>
<h2 id="エラーのログ記録">エラーのログ記録</h2>
エラー情報を構造化して記録できます
<pre><code class="hljs language-go">func someFunction() error {
 return fmt.Errorf("エラーになりました")
}
func main() {
 err := someFunction()
 if err != nil {
 log.Error().
 Err(err).
 Str("function", "someFunction").
 Msg("処理に失敗しました")
 }
}
</code></pre>
出力:
<pre><code class="hljs language-console">{"level":"error","error":"エラーになりました","function":"someFunction","time":"2024-12-11T22:37:40+09:00","message":"処理に失敗しました"}
</code></pre>
<h2 id="ファイルにログを保存">ファイルにログを保存</h2>
ログをファイルに保存するには、<code>log.Output()</code> を使います。
<pre><code class="hljs language-go">package main

import (
 "os"
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // ファイルを開く
 file, err := os.Create("app.log")
 if err != nil {
 log.Fatal().Err(err).Msg("ログファイルを作成できませんでした")
 }
 defer file.Close()

 // ファイルにログを出力
 log.Logger = log.Output(file)

 log.Info().Msg("ファイルにログを出力しました")
}
</code></pre>
出力(app.log):
<pre><code class="hljs language-console">{"level":"info","time":"2024-12-11T22:39:38+09:00","message":"ファイルにログを出力しました"}
</code></pre>
<h2 id="パフォーマンスの考慮点">パフォーマンスの考慮点</h2>
Zerolog は高パフォーマンスを重視して設計されていますが、以下の点に注意が必要です：
<ol>
<li>不要なログレベルは無効化する</li>
<li>フィールド名は短く意味のある名前にする</li>
<li>大量のログ出力時はサンプリングを検討する</li>
</ol>
例: サンプリングを有効にするには以下のように設定します。
<pre><code class="hljs language-go">log.Logger = log.Sample(&#x26;zerolog.BasicSampler{N: 10}) // 10回に1回のログ出力 
</code></pre>
<h2 id="まとめ">まとめ</h2>
<ul>
<li>Zerolog は軽量で高性能な Go のログライブラリ。依存関係が少なく、ゼロアロケーションを実現</li>
<li>JSON 形式の構造化ログをデフォルトでサポートし、可読性と解析性が高い</li>
<li>7 段階のログレベル（Trace, Debug, Info, Warn, Error, Fatal, Panic）のサポート</li>
<li>コンテキスト情報を活用した詳細な構造化ログの作成が容易</li>
<li>ファイル出力やコンソール出力など、柔軟な出力先の設定が可能</li>
<li>サンプリング機能による大量ログ出力時のパフォーマンス最適化</li>
</ul>
<hr>
<hr>
[Prev] <a href="/posts/303">Step 6-2: Zap</a>

Author