本文へ移動
Telemetry
統合ガイド

NestJS リクエストとワークフロー Telemetry

正規化されたルート結果、レイテンシー、エラー、リリース、承認されたアカウント コンテキストを使用して NestJS コントローラーとプロバイダーを計測します。

レビュー者 Telemetry 製品チーム . インストルメンテーション契約、プライバシー境界、および実装ガイダンス. 基準と所有権を確認する

役に立つ
  • NestJS API モニタリング
  • インターセプターベースのイベントコントラクト
  • リリースごとのコントローラーの信頼性
実装の証拠

NestJS Request and Workflow Telemetry: 境界から検証された行まで

制御されたアプリケーション境界で NestJS Request and Workflow Telemetry を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。

  1. 1

    結果を選択してください

    NestJS API モニタリング

  2. 2

    契約を定義する

    request_id、コントローラー、ハンドラー、route_template、およびメソッド

  3. 3

    境界を計測する

    最も狭い有効スコープでインターセプターを適用し、req.originalUrl ではなくフレームワーク メタデータから route_template を導出します。

  4. 4

    証拠を検証する

    Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

始める前に

前提条件と境界

  • サーバー専用の NestJS プロバイダーまたはモジュールで初期化された telemetry-sh
  • 生の URL とパス識別子を回避するルート テンプレート リゾルバー
  • 例外分類とノンブロッキング配信と永続的配信のポリシー

配信設定

サーバー側のインストールと初期化

サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。

nestjs-インストール

npmのインストール

bash
npm install telemetry-sh
  1. 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
  2. 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
  3. 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。

スニペット

1 つの構造化されたイベントから始める

ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。

nestjs

NestJS Request and Workflow Telemetryイベント

javascript
@Injectable()
export class OutcomeInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler) {
    const request = context.switchToHttp().getRequest();
    const response = context.switchToHttp().getResponse();
    const startedAt = performance.now();
    let errorType: string | undefined;

    return next.handle().pipe(
      catchError((error) => {
        errorType = classifyError(error);
        throw error;
      }),
      finalize(() => {
        const statusCode = response.statusCode;
        void telemetry.log("api_request_completed", {
          request_id: request.id,
          controller: context.getClass().name,
          handler: context.getHandler().name,
          route_template: resolveRouteTemplate(context),
          method: request.method,
          status_code: statusCode,
          status: statusCode >= 500 ? "failed" : "success",
          latency_ms: Math.round(performance.now() - startedAt),
          error_type: errorType,
          release: process.env.APP_RELEASE,
        }).catch(recordTelemetryFailure);
      }),
    );
  }
}

イベント契約

request_id、コントローラー、ハンドラー、route_template、およびメソッド

ステータス、status_code、latency_ms、error_type、リリース

tenant_id、プラン、または機能は明示的に承認された場合のみ

実装のチェックポイント

チェックポイント 1

最も狭い有効スコープでインターセプターを適用し、req.originalUrl ではなくフレームワーク メタデータから route_template を導出します。

チェックポイント 2

この例では、配達の約束を考慮していますが、HTTP 応答は遅延しません。イベントがコンプライアンスまたは課金に重要な場合は、アプリケーション所有の送信ボックスを使用します。

チェックポイント 3

例外オブジェクト、リクエスト本文、認可ヘッダー、Cookie、クエリ文字列、生のパス パラメーターをペイロードから除外します。

検証

イベントが到着したことを証明する

既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。

nestjs-検証

NestJS Request and Workflow Telemetry 検証クエリ

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
論理結果ごとに 1 つのターミナル行を、予想されるステータス、識別子、単位、および UTC 時刻とともに確認します。
推論されたスキーマを検査し、再試行によってフィールド タイプが変更されたり、新しい論理イベント ID が生成されたりしないことを確認します。
保存されたフィールドで認証情報、生のペイロード、プロンプト、プライベート コンテンツ、および無制限のエラー メッセージを検索します。
ダッシュボードを完了として扱う前に、プロバイダーのタイムアウト、取り込みの拒否、およびプロセスのシャットダウンを実行します。

実装の参考資料

新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。

生産境界

結果イベントを小さく、回復可能なものに保つ

このパターンが提供するのは、

  • 上流のワークフローの横にある、制限付きの SQL 対応の結果。
  • ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
  • 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。

このパターンでは提供されません

  • OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
  • ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
  • 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。

イベントスキーマの開始点

クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。

関連製品の機能

このワークフローを続行します アラート

レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。

関連する SQL レシピ

SQL で次の質問に答えてください

このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。

すべてのレシピを参照する
完全なコレクションAPI の信頼性 SQL

実装ファミリーごとに参照する

関連する統合パターンを比較する

この統合と組み合わせるテンプレート

さらなる統合