Go HTTP Server Structured Logging: 境界から検証された行まで
制御されたアプリケーション境界で Go HTTP Server Structured Logging を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
Go API 信頼性
- 2
契約を定義する
route_template、メソッド、および status_code
- 3
境界を計測する
リソース識別子ごとに 1 つのグループが存在しないようにするには、r.URL.Path ではなくルーター パターンを使用します。
- 4
証拠を検証する
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- サーバー側キーで初期化された telemetry-go SDK
- 最終ステータス コードを記録する応答ライター ラッパー
- アプリケーションルーターからの正規化されたルート名
配信設定
サーバー側のインストールと初期化
プロセスごとに 1 回 telemetry.NewTelemetry を初期化するか、コンテキストのキャンセルと明示的なタイムアウトが必要な場合はアプリケーション所有の http.Client を使用します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
Go moduleのインストール
go get github.com/telemetry-sh/telemetry-go- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Go HTTP Server Structured Loggingイベント
startedAt := time.Now()
next.ServeHTTP(recorder, r)
status := "success"
if recorder.StatusCode >= 500 {
status = "failed"
}
_, err := telemetryClient.Log("api_request_completed", map[string]interface{}{
"route_template": routePattern,
"method": r.Method,
"status_code": recorder.StatusCode,
"status": status,
"latency_ms": float64(time.Since(startedAt).Microseconds()) / 1000,
"request_id": requestID,
})イベント契約
route_template、メソッド、および status_code
ステータス、latency_ms、および request_id
サービス、環境、リリース
実装のチェックポイント
チェックポイント 1
リソース識別子ごとに 1 つのグループが存在しないようにするには、r.URL.Path ではなくルーター パターンを使用します。
チェックポイント 2
同じ文書化された結果モデルでパニックと早期終了を捕捉します。
チェックポイント 3
取り込みエラーによってアプリケーションの応答が上書きされないようにしてください。サービスの診断パスを通じてそれらを報告します。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Go HTTP Server Structured Logging 検証クエリ
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
ルート別のAPIエラー率の計算
意味のある 5xx エラー率が最も高いのは、どの API ルートですか?
レシピを開くp50、p95、p99 API レイテンシの計算
テール レイテンシが最も悪いエンドポイントはどれですか?
レシピを開くリリースごとの API 信頼性の比較
どのリリースで、より悪い API エラーまたはテール レイテンシーが発生しますか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
Pino 構造化イベント分析
Pino 診断ログを、Node.js リクエスト、ジョブ、および製品の信頼性分析のために、制限された Telemetry 結果イベントと組み合わせます。
オープンガイドNestJS リクエストとワークフロー Telemetry
正規化されたルート結果、レイテンシー、エラー、リリース、承認されたアカウント コンテキストを使用して NestJS コントローラーとプロバイダーを計測します。
オープンガイドGoogle Cloud Run テレメトリ
Cloud Run のリクエストとジョブの結果、コールドスタート コンテキスト、インスタンスの同時実行性、再試行、レイテンシ、リリースをアプリケーション所有の構造化イベントで追跡します。
オープンガイド