Pino Structured Event Analytics: 境界から検証された行まで
制御されたアプリケーション境界で Pino Structured Event Analytics を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
Node.js API 信頼性
- 2
契約を定義する
request_id、route_template、メソッド、status_code、およびステータス
- 3
境界を計測する
Pino を詳細な診断ストリームとして保持します。リクエストまたはワークフローが最終結果に達した場合にのみ、別のコンパクトな Telemetry 行を発行します。
- 4
証拠を検証する
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- Pino と telemetry-sh は信頼できる Node.js ランタイムで一度初期化されます
- 安定したルート テンプレート、ワークフロー名、リクエスト ID、リリース識別子
- 資格情報とプライベート コンテンツに対するフィールド ホワイトリストと Pino 編集ルール
配信設定
サーバー側のインストールと初期化
サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
npmのインストール
npm install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Pino Structured Event Analyticsイベント
import pino from "pino";
import telemetry from "telemetry-sh";
const logger = pino();
const startedAt = performance.now();
try {
const result = await runCheckout();
const outcome = {
request_id: requestId,
route_template: "/api/checkout",
method: "POST",
status_code: 200,
status: "success",
latency_ms: Math.round(performance.now() - startedAt),
release: process.env.APP_RELEASE,
};
logger.info(outcome, "checkout completed");
await telemetry.log("api_request_completed", outcome);
return result;
} catch (error) {
const outcome = {
request_id: requestId,
route_template: "/api/checkout",
method: "POST",
status_code: 500,
status: "failed",
latency_ms: Math.round(performance.now() - startedAt),
error_type: classifyError(error),
release: process.env.APP_RELEASE,
};
logger.error({ ...outcome, err: error }, "checkout failed");
await telemetry.log("api_request_completed", outcome);
throw error;
}イベント契約
request_id、route_template、メソッド、status_code、およびステータス
latency_ms、error_type、リリース、環境、およびサービス
account_id または tenant_id は運用分析用に承認された場合のみ
実装のチェックポイント
チェックポイント 1
Pino を詳細な診断ストリームとして保持します。リクエストまたはワークフローが最終結果に達した場合にのみ、別のコンパクトな Telemetry 行を発行します。
チェックポイント 2
相関のために承認済みの request_id をシステム間で共有しますが、ログ メッセージ、リクエスト本文、ヘッダー、または例外スタックをイベントにコピーしないでください。
チェックポイント 3
アプリケーション境界で Telemetry Promise を待つかその他の方法で考慮し、結果を失うことが許容できない場合は送信ボックス ポリシーを定義します。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Pino Structured Event Analytics 検証クエリ
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
ルートごとの API リクエスト スループットの計算
1 分あたり最も多くのリクエストを処理している API ルートはどれですか?
レシピを開くルート別のAPIエラー率の計算
意味のある 5xx エラー率が最も高いのは、どの API ルートですか?
レシピを開くp50、p95、p99 API レイテンシの計算
テール レイテンシが最も悪いエンドポイントはどれですか?
レシピを開くリリースごとの API 信頼性の比較
どのリリースで、より悪い API エラーまたはテール レイテンシーが発生しますか?
レシピを開く顧客の影響によるエラーのフィンガープリントのランク付け
最も多くの顧客アカウントに影響を与えるエラー グループはどれですか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
NestJS リクエストとワークフロー Telemetry
正規化されたルート結果、レイテンシー、エラー、リリース、承認されたアカウント コンテキストを使用して NestJS コントローラーとプロバイダーを計測します。
オープンガイドElixir Phoenix Telemetry の統合
Phoenix リクエストのライフサイクル イベントにアタッチし、接続データ、パラメータ、例外テキストをコピーせずに、制限されたターミナル リクエストの結果を転送します。
オープンガイドGo HTTP サーバー構造化ロギング
ルート エラー率、レイテンシー パーセンタイル、リリース比較のために、型指定されたリクエスト結果イベントを Go HTTP サービスに追加します。
オープンガイド