<h1 id="%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB">
<a class="header-anchor-link" href="#%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" aria-hidden="true"></a> はじめに</h1>
<p>こんにちは！バックエンドとプラットフォームエンジニアのビクトルです。</p>
<p>この記事では、<code>Google Cloud Run</code>をロガーする方法についてお話しし、マイクロサービスアーキテクチャでトレーシングを使用するために試してみたいと思います。</p>
<h1 id="%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B7%E3%83%B3%E3%82%B0%E3%81%A8%E3%83%AD%E3%82%AE%E3%83%B3%E3%82%B0">
<a class="header-anchor-link" href="#%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B7%E3%83%B3%E3%82%B0%E3%81%A8%E3%83%AD%E3%82%AE%E3%83%B3%E3%82%B0" aria-hidden="true"></a> トレーシングとロギング</h1>
<p>オブザーバビリティは、トレース、ログ、およびメトリクスを収集および集約することによって分散トレーシングを実現します。</p>
<p>トレースは、リクエストを受信するとそのリクエストがどのようにして始まり、ソースから宛先までどのように流れるかを示し、リクエストの各部分間の遅延を測定します。</p>
<p>ログは、開発者がデバッグを行い、アプリで起きてるイベントを追跡するのに役立ちます。</p>
<p>ログはトレーサビリティと組み合わせることができます。ログを中央に集約している場合、ツールを使用してログをフィルタリングし、トレースに関連するすべてのイベントを表示できます。</p>
<h1 id="google-cloud-run%E3%81%A7%E4%BD%BF%E7%94%A8%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95">
<a class="header-anchor-link" href="#google-cloud-run%E3%81%A7%E4%BD%BF%E7%94%A8%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95" aria-hidden="true"></a> Google Cloud Runで使用する方法</h1>
<p><code>Google Cloud Run</code>（以下、<code>Cloud Run</code>）でサービスをデプロイする際、<code>Cloud Run</code>はサービスと他のサービスの間にプロキシレイヤーを作成します。</p>
<p><img src="https://storage.googleapis.com/zenn-user-upload/535f9c1a87f2-20240119.png" alt="google cloud request" loading="lazy" class="md-img"></p>
<p>ログの中には：</p>
<div class="code-block-container"><pre><code>trace: "projects/&lt;projectID&gt;/traces/aaaa3cb476111119ff2accccccc2d75"
</code></pre></div><p>と書いています。</p>
<h2 id="%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B9id%E3%82%92%E3%81%A9%E3%81%AE%E3%82%88%E3%81%86%E3%81%AB%E6%B3%A8%E5%85%A5%E3%81%97%E3%81%A6%E4%BD%BF%E7%94%A8%E3%81%A7%E3%81%8D%E3%81%BE%E3%81%99%E3%81%8B%EF%BC%9F">
<a class="header-anchor-link" href="#%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B9id%E3%82%92%E3%81%A9%E3%81%AE%E3%82%88%E3%81%86%E3%81%AB%E6%B3%A8%E5%85%A5%E3%81%97%E3%81%A6%E4%BD%BF%E7%94%A8%E3%81%A7%E3%81%8D%E3%81%BE%E3%81%99%E3%81%8B%EF%BC%9F" aria-hidden="true"></a> トレースIDをどのように注入して使用できますか？</h2>
<p>マイクロサービスアーキテクチャでは、トラフィックを別のサービスにルーティングするためのゲートウェイサービスがあり、そのサービスからは、<code>トレースID</code>を使用し、ログに注入します。</p>
<h3 id="%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%81%8B%E3%82%89context%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B">
<a class="header-anchor-link" href="#%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%81%8B%E3%82%89context%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B" aria-hidden="true"></a> ヘッダーからcontextを取得する</h3>
<p><code>Cloud Run</code>は<code>トレースID</code>を<code>HTTP</code>ヘッダーに注入します。2つのヘッダーにそれを注入します：</p>
<ul>
<li><code>X-Cloud-Trace-Context</code></li>
<li><code>Traceparent</code></li>
</ul>
<p><code>X-Cloud-Trace-Context</code>ヘッダーは最初に<code>Google Cloud Platform</code>で使用されましたが、<code>W3C</code>によって標準として推奨されている<code>Traceparent</code>ヘッダー名を使用することが推奨されています。</p>
<h3 id="w3c%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%82%92%E4%BD%BF%E7%94%A8">
<a class="header-anchor-link" href="#w3c%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%82%92%E4%BD%BF%E7%94%A8" aria-hidden="true"></a> W3Cヘッダーを使用</h3>
<p>ヘッダーの<code>Regex</code>パターンは以下の通りです：</p>
<div class="code-block-container"><pre><code>&lt;version&gt;-&lt;traceID&gt;-&lt;parentID&gt;-&lt;traceFlags&gt;
</code></pre></div><p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__047bc84053c85" src="https://embed.zenn.studio/card#zenn-embedded__047bc84053c85" data-content="https%3A%2F%2Fwww.w3.org%2FTR%2Ftrace-context%2F%23trace-context-http-headers-format" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://www.w3.org/TR/trace-context/#trace-context-http-headers-format" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://www.w3.org/TR/trace-context/#trace-context-http-headers-format</a></p>
<p>さて、ゲートウェイでは、そのヘッダーを伝播させることで、リクエストをトレースし、ログに表示できるようにします。</p>
<aside class="msg message"><span class="msg-symbol">!</span><div class="msg-content">
<p><code>Cloud Run</code>は各サービスの間にレイヤーを作成するため、ヘッダーを伝播させない場合、<code>Cloud Run</code>は新しいヘッダーを作成し、トレーサビリティが失われる可能性があります。</p>
</div></aside>
<h2 id="%E3%83%AD%E3%82%AC%E3%83%BC%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%97%E3%81%A6%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B9%E3%82%92%E6%B3%A8%E5%85%A5%E3%81%97%E3%81%BE%E3%81%99">
<a class="header-anchor-link" href="#%E3%83%AD%E3%82%AC%E3%83%BC%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%97%E3%81%A6%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B9%E3%82%92%E6%B3%A8%E5%85%A5%E3%81%97%E3%81%BE%E3%81%99" aria-hidden="true"></a> ロガーを使用してトレースを注入します</h2>
<p><code>Cloud Run</code>のログのフォーマットを見てみましょう：</p>
<p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__3fcbf69960e4f" src="https://embed.zenn.studio/card#zenn-embedded__3fcbf69960e4f" data-content="https%3A%2F%2Fcloud.google.com%2Flogging%2Fdocs%2Freference%2Fv2%2Frest%2Fv2%2FLogEntry" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry</a></p>
<p><img src="https://storage.googleapis.com/zenn-user-upload/434bf5758004-20240119.png" alt="cloud run logentry" loading="lazy" class="md-img"></p>
<p>よし！これでデータをログに注入し、<code>Cloud Run</code>はフィールドを自動的に解釈します、もし<code>Golang</code>で実装したら：</p>
<div class="code-block-container"><pre class="language-golang"><code class="language-golang">func SpanKey() string {
	return "logging.googleapis.com/spanId"
}

func TraceKey() string {
	return "logging.googleapis.com/trace"
}
</code></pre></div><p>また、<code>Cloud Run</code>はこれらのログエントリーをそのメトリクスサービスにリンクします。</p>
<h1 id="%E7%B5%82%E3%82%8F%E3%82%8A">
<a class="header-anchor-link" href="#%E7%B5%82%E3%82%8F%E3%82%8A" aria-hidden="true"></a> 終わり</h1>
<p>私たちはログにトレースヘッダーを含めるように設定しました：</p>
<ul>
<li>
<code>W3C</code>によって推奨されている<code>Traceparent</code>ヘッダーを使用</li>
<li>ゲートウェイでヘッダーを注入し、コンテキストで他のサービスに伝播させる</li>
<li>
<code>トレースID</code>を使用し、以下のキーを使用してキーと値のエントリに印刷します：
<ul>
<li><code>logging.googleapis.com/spanId</code></li>
<li><code>logging.googleapis.com/trace</code></li>
</ul>
</li>
</ul>


Observability: Google Cloud Runロギング&トレーシング

トレースIDをどのように注入して使用できますか？

ロガーを使用してトレースを注入します

Discussion