Node.js and Express structured logging でイベントを送信して確認する
制御されたアプリケーション境界で Node.js and Express structured logging を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
API エラー率の監視
- 2
契約を定義する
route_template、メソッド、および status_code
- 3
結果で発行する
next を呼び出す前にリスナーをアタッチして、最終的な応答ステータスを記録します。
- 4
証拠を検証する
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
始める前に
始める前に
- サーバー側の TELEMETRY_API_KEY 環境変数
- アプリケーションの起動時に初期化される telemetry-sh パッケージ
- 生のリクエスト URL ではなく安定したルート テンプレート
配信設定
サーバー側のインストールと初期化
サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
npmのインストール
npm install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Node.js and Express structured loggingイベント
app.use((req, res, next) => {
const startedAt = performance.now();
res.on("finish", async () => {
try {
await telemetry.log("api_request_completed", {
route_template: req.route?.path ?? "unmatched",
method: req.method,
status_code: res.statusCode,
status: res.statusCode >= 500 ? "failed" : "success",
latency_ms: Math.round(performance.now() - startedAt),
request_id: req.id,
release: process.env.APP_RELEASE,
});
} catch {
try { console.warn("Telemetry delivery unconfirmed"); } catch {}
}
});
next();
});イベントスキーマ
route_template、メソッド、および status_code
ステータスと分類済み error_type
latency_ms、request_id、およびリリース
設定を確認する
チェックポイント 1
next を呼び出す前にリスナーをアタッチして、最終的な応答ステータスを記録します。
チェックポイント 2
一致した Express ルート パターンとルーター ベース URL を使用します。クエリ文字列や生のリクエスト本文は決して送信しないでください。
チェックポイント 3
中止されたリクエストに別のステータスが必要かどうかを決定し、テストでその分岐を実行します。
チェックポイント 4
finish リスナー内で送信失敗を捕捉し、未処理の Promise 拒否を防いでください。診断メッセージは固定文にし、診断出力の失敗も捕捉してください。
チェックポイント 5
このリスナーには送信期限、永続キュー、再試行、終了時の送信待ち処理はありません。本番環境では送信の上限とライフサイクル処理を設定してください。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Node.js and Express structured logging 検証クエリ
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
イベントを記録する場所
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの例
このワークフローのイベントスキーマ
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
その他のSQL例
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
ルート別のAPIエラー率の計算
リクエストが 20 件以上ある API ルートのうち、5xx エラー率が最も高いのはどれですか？
レシピを開くp50、p95、p99 API レイテンシの計算
テール レイテンシが最も悪いエンドポイントはどれですか?
レシピを開くルートごとの API タイムアウト率の計算
ユーザーに影響を与えるほど頻繁にタイムアウトになる API ルートはどれですか?
レシピを開く依存関係の比較 p95 レイテンシー
テール レイテンシーと失敗率が最も悪いダウンストリームの依存関係はどれですか?
レシピを開く顧客の影響によるエラーのフィンガープリントのランク付け
最も多くの顧客アカウントに影響を与えるエラー グループはどれですか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
Python および FastAPI 構造化ロギング
Telemetry の非同期クライアントと正規化したルート名を使い、FastAPI の応答ステータスとヘッダー受信までの遅延を記録します。
オープンガイドElixir Phoenix Telemetry の統合
Phoenix リクエストのライフサイクル イベントにアタッチし、接続データ、パラメータ、例外テキストをコピーせずに、制限されたターミナル リクエストの結果を転送します。
オープンガイドSpring Boot 構造化イベント監視
安定したルート、レイテンシ、ステータス、トレース コンテキストを使用して、Telemetry の HTTP API を通じて Spring MVC とスケジュールされたワークフローの結果を記録します。
オープンガイド