本文へ移動
Telemetry
統合ガイド

MongoDB 操作 Telemetry

ドキュメントやクエリ値を収集せずに、名前付き MongoDB 操作、レイテンシ、結果数、再試行、トランザクション結果、リリース回帰を追跡します。

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

役に立つ
  • スローオペレーション分析
  • MongoDB トランザクションの信頼性
  • リリースのリグレッションモニタリング
実装の証拠

MongoDB Operation Telemetry: 境界から検証された行まで

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

  1. 1

    結果を選択してください

    スローオペレーション分析

  2. 2

    契約を定義する

    database_system、操作、collection_name、query_fingerprint、およびリリース

  3. 3

    境界を計測する

    クエリ実装が変更されてもダッシュボードが安定した状態を維持できるように、アプリケーション操作にデータベース コマンドとは別に名前を付けます。

  4. 4

    証拠を検証する

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

始める前に

前提条件と境界

  • MongoDB Node.js ドライバーと telemetry-sh がサーバー側で初期化されました
  • コレクションドキュメントやフィルター値を含まない、限定された操作分類法
  • アプリケーションのタイミングとデータベースプロファイラー診断の区別の見直し

配信設定

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

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

mongodb-インストール

npmのインストール

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

スニペット

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

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

mongodb

MongoDB Operation Telemetryイベント

javascript
await telemetry.log("mongodb_operation_completed", {
  database_system: "mongodb",
  operation: "workspace_activity.aggregate",
  collection_name: "workspace_activity",
  query_fingerprint: "workspace_activity_summary_v3",
  status: "success",
  duration_ms: Math.round(performance.now() - startedAt),
  result_count: results.length,
  retry_count: 0,
  transaction_status: "not_started",
  read_preference: "primaryPreferred",
  route_template: "/api/workspaces/:workspaceId/activity",
  release: process.env.APP_RELEASE,
});

イベント契約

database_system、操作、collection_name、query_fingerprint、およびリリース

ステータス、duration_ms、result_count、retry_count、および transaction_status

read_preference、write_concern_category、route_template、および error_type

実装のチェックポイント

チェックポイント 1

クエリ実装が変更されてもダッシュボードが安定した状態を維持できるように、アプリケーション操作にデータベース コマンドとは別に名前を付けます。

チェックポイント 2

フィルター、更新ドキュメント、集計パイプライン、返されたドキュメント、接続文字列、および無制限のドライバー エラーをイベントから除外します。

チェックポイント 3

ネイティブ クエリ診断には MongoDB データベース プロファイラーを選択的に使用します。キャプチャされたデータには機密クエリの詳細が含まれる可能性があり、独自のアクセスと保持のレビューが必要です。

検証

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

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

mongodb-検証

MongoDB Operation Telemetry 検証クエリ

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

実装の参考資料

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

生産境界

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

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

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

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

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

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

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

関連製品の機能

このワークフローを続行します SQL クエリ API

構造化イベント テーブルに対して読み取り専用 DataFusion SQL を実行し、結果を再利用します。

関連する SQL レシピ

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

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

すべてのレシピを参照する
完全なコレクションデータベースの信頼性 SQL

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

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

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

さらなる統合