本文へ移動
Telemetry
統合ガイド

AWS ECS と Fargate Telemetry の統合

ローカル タスク メタデータ エンドポイントを使用して、ECS タスク ファミリー、リビジョン、アベイラビリティ ゾーン、リリース コンテキストをアプリケーションの結果に追加します。

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

役に立つ
  • ECS リリースの信頼性
  • Fargate ワークロードの健全性
  • タスク改訂回帰分析
実装の証拠

AWS ECS and Fargate Telemetry Integration: 境界から検証された行まで

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

  1. 1

    結果を選択してください

    ECS リリースの信頼性

  2. 2

    契約を定義する

    サービス、ecs_task_family、ecs_task_revision、availability_zone、リージョン、リリース

  3. 3

    境界を計測する

    タスク ランタイムから ECS_CONTAINER_METADATA_URI_V4 を読み取り、短いタイムアウトでローカルに /task をリクエストします。イベントごとにメタデータを読み取る代わりに、安定したファミリ、リビジョン、およびアベイラビリティ ゾーンのフィールドをキャッシュします。

  4. 4

    証拠を検証する

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

始める前に

前提条件と境界

  • ランタイムによって公開されるバージョン 4 メタデータ エンドポイントを含む ECS タスク
  • Telemetry は、書き込みスコープのキーを使用して信頼できるアプリケーション コンテナー内で 1 回初期化されます
  • アプリケーションが所有する安定したサービス、ルート、ジョブ、リリース、および結果フィールド

配信設定

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

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

aws-ecs-fargate-インストール

npmのインストール

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

スニペット

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

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

aws-ecs-fargate

AWS ECS and Fargate Telemetry Integrationイベント

javascript
let cachedEcsContext;

async function getEcsContext() {
  if (cachedEcsContext) return cachedEcsContext;
  const baseUrl = process.env.ECS_CONTAINER_METADATA_URI_V4;
  if (!baseUrl) return {};

  const response = await fetch(`${baseUrl}/task`, {
    signal: AbortSignal.timeout(1000),
  });
  if (!response.ok) throw new Error("ecs_metadata_unavailable");

  const task = await response.json();
  cachedEcsContext = {
    ecs_task_family: task.Family,
    ecs_task_revision: task.Revision,
    availability_zone: task.AvailabilityZone,
  };
  return cachedEcsContext;
}

await telemetry.log("api_request_completed", {
  route_template: "/api/projects/:id",
  status: "success",
  status_code: 200,
  duration_ms: 184,
  service: "projects-api",
  release: process.env.APP_RELEASE ?? "development",
  ...(await getEcsContext()),
});

イベント契約

サービス、ecs_task_family、ecs_task_revision、availability_zone、リージョン、リリース

route_template または job_name、ステータス、duration_ms、retry_count、および制御対象の error_type

タスクロールの認証情報、メタデータ URI、環境ダンプ、コンテナー ラベル、生の ARN、リクエスト本文、例外テキストはありません

実装のチェックポイント

チェックポイント 1

タスク ランタイムから ECS_CONTAINER_METADATA_URI_V4 を読み取り、短いタイムアウトでローカルに /task をリクエストします。イベントごとにメタデータを読み取る代わりに、安定したファミリ、リビジョン、およびアベイラビリティ ゾーンのフィールドをキャッシュします。

チェックポイント 2

境界付きインシデントのワークフローで明示的に必要な場合を除き、一時的なタスクとコンテナの識別子を通常のグループ化フィールドに含めないでください。

チェックポイント 3

リクエストまたはワーカーの境界でアプリケーションの結果を記録します。メタデータ エンドポイントは、デプロイメント コンテキストを追加します。 CloudWatch インフラストラクチャのメトリクスや分散トレースに代わるものではありません。

検証

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

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

aws-ecs-fargate-検証

AWS ECS and Fargate Telemetry Integration 検証クエリ

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

実装の参考資料

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

生産境界

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

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

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

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

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

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

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

関連製品の機能

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

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

関連する SQL レシピ

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

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

すべてのレシピを参照する

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

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

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

さらなる統合