跳转到内容
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 使用写范围密钥在可信应用程序容器中初始化一次
  • 应用程序拥有的稳定服务、路线、作业、发布和结果字段

交货设置

安装并初始化服务器端

在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

aws-ecs-fargate-安装

npm安装

bash
npm install telemetry-sh
  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

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;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

生产边界

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件架构起点

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 告警

将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。

相关 SQL 查询示例

用 SQL 回答下一个问题

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成