本文へ移動
Telemetry
統合ガイド

ワークフローの一時的な可観測性

ワークフロー ペイロードを記録することなく、一時的なワークフローの結果、アクティビティの再試行、スケジュールから開始までの待ち時間、ビジネス マイルストーンを追跡します。

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

役に立つ
  • ワークフローの完了監視
  • アクティビティの再試行分析
  • 長期実行プロセスの健全性
実装の証拠

Temporal Workflow Observability: 境界から検証された行まで

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

  1. 1

    結果を選択してください

    ワークフローの完了監視

  2. 2

    契約を定義する

    workflow_type、workflow_id、run_id、およびステータス

  3. 3

    境界を計測する

    決定論的なワークフロー コードから直接ではなく、アクティビティまたはワーカー インターセプターから Telemetry イベントを送信します。

  4. 4

    証拠を検証する

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

始める前に

前提条件と境界

  • サーバー側 TELEMETRY_API_KEY
  • 安定したワークフローとアクティビティのタイプ名
  • 外部テレメトリ呼び出しの非再生境界

配信設定

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

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

temporal-インストール

npmのインストール

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

スニペット

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

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

temporal

Temporal Workflow Observabilityイベント

javascript
await telemetry.log("workflow_completed", {
  workflow_type: info.workflowType,
  workflow_id: info.workflowId,
  run_id: info.runId,
  task_queue: info.taskQueue,
  status: "success",
  duration_ms: Date.now() - startedAt,
  business_outcome: result.category,
});

イベント契約

workflow_type、workflow_id、run_id、およびステータス

activity_type、試行、queue_name、および duration_ms

error_type、business_outcome、およびリリース

実装のチェックポイント

チェックポイント 1

決定論的なワークフロー コードから直接ではなく、アクティビティまたはワーカー インターセプターから Telemetry イベントを送信します。

チェックポイント 2

一時的な実行 ID を個別に記録しながら、論理ワークフロー ID を安定した状態に保ちます。

チェックポイント 3

ワークフロー引数、プライベート データを含む検索属性、またはアクティビティの結果をログに記録しないでください。

検証

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

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

temporal-検証

Temporal Workflow Observability 検証クエリ

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

実装の参考資料

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

生産境界

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

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

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

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

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

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

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

関連製品の機能

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

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

関連する SQL レシピ

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

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

すべてのレシピを参照する
完全なコレクションバックグラウンドジョブ SQL

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

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

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

さらなる統合