Python and FastAPI Structured Logging: 境界から検証された行まで
制御されたアプリケーション境界で Python and FastAPI Structured Logging を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
Python API 監視
- 2
契約を定義する
route_template、メソッド、および status_code
- 3
境界を計測する
識別子によって無制限のグループが作成されないように、生の URL の代わりに一致したルート パスを使用します。
- 4
証拠を検証する
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- サービス環境にインストールされた telemetry-sh
- TelemetryAsync はサーバー側の API キーで初期化されました
- 信頼できるミドルウェアによって提供される、または入力時に生成されるリクエスト ID
配信設定
サーバー側のインストールと初期化
サーバー側キーを使用して、プロセスごとに 1 回、同期コードの場合は Telemetry を、非同期コードの場合は TelemetryAsync を初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
pipのインストール
python -m pip install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Python and FastAPI Structured Loggingイベント
@app.middleware("http")
async def record_request(request, call_next):
started_at = time.perf_counter()
response = await call_next(request)
route = request.scope.get("route")
await telemetry.log("api_request_completed", {
"route_template": getattr(route, "path", "unmatched"),
"method": request.method,
"status_code": response.status_code,
"status": "failed" if response.status_code >= 500 else "success",
"latency_ms": round((time.perf_counter() - started_at) * 1000),
"request_id": request.headers.get("x-request-id"),
})
return responseイベント契約
route_template、メソッド、および status_code
ステータス、latency_ms、および error_type
request_id、環境、リリース
実装のチェックポイント
チェックポイント 1
識別子によって無制限のグループが作成されないように、生の URL の代わりに一致したルート パスを使用します。
チェックポイント 2
応答結果が判明した後に非同期取り込みを待機し、API 応答を隠蔽しない失敗動作を定義します。
チェックポイント 3
通常のミドルウェアの完了をバイパスする障害に備えて、例外ハンドラーのインストルメンテーションを追加します。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Python and FastAPI 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 ルートはどれですか?
レシピを開く依存関係の比較 p95 レイテンシー
テール レイテンシーと失敗率が最も悪いダウンストリームの依存関係はどれですか?
レシピを開く顧客の影響によるエラーのフィンガープリントのランク付け
最も多くの顧客アカウントに影響を与えるエラー グループはどれですか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
Node.js および Express 構造化ログ
安定したルート テンプレート、ステータス コード、リクエスト レイテンシ、および安全な相関フィールドを備えた Express ルート結果を計測します。
オープンガイドElixir Phoenix Telemetry の統合
Phoenix リクエストのライフサイクル イベントにアタッチし、接続データ、パラメータ、例外テキストをコピーせずに、制限されたターミナル リクエストの結果を転送します。
オープンガイドSpring Boot 構造化イベント監視
安定したルート、レイテンシ、ステータス、トレース コンテキストを使用して、Telemetry の HTTP API を通じて Spring MVC とスケジュールされたワークフローの結果を記録します。
オープンガイド