Saltar al contenido
Telemetry
guía de integración

Integración de AWS ECS y Fargate Telemetry

Agregue la familia de tareas de ECS, la revisión, la zona de disponibilidad y el contexto de lanzamiento a los resultados de la aplicación utilizando el punto final de metadatos de la tarea local.

Revisado por el equipo de producto Telemetry en . Contrato de instrumentación, límites de privacidad y guía de implementación. Revisar los estándares y la propiedad

Útil para
  • Fiabilidad de liberación de ECS
  • Estado de la carga de trabajo de Fargate
  • Análisis de regresión de revisión de tareas.
Evidencia de implementación

AWS ECS and Fargate Telemetry Integration: del límite a la fila verificada

Utilice AWS ECS and Fargate Telemetry Integration en un límite de aplicación controlado, mantenga el contrato de evento pequeño y verifique un resultado conocido antes de crear vistas agregadas.

  1. 1

    Elige el resultado

    Fiabilidad de liberación de ECS

  2. 2

    Definir el contrato

    servicio, ecs_task_family, ecs_task_revision, availability_zone, región y versión

  3. 3

    Instrumentar el límite

    Lea ECS_CONTAINER_METADATA_URI_V4 desde el tiempo de ejecución de la tarea y solicite /task localmente con un breve tiempo de espera. Almacene en caché los campos de familia estable, revisión y zona de disponibilidad en lugar de leer metadatos por evento.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Una tarea de ECS con el punto final de metadatos de la versión 4 expuesto por el tiempo de ejecución
  • Telemetry se inicializó una vez en el contenedor de la aplicación confiable con una clave de alcance de escritura
  • Campos estables de servicio, ruta, trabajo, versión y resultado propiedad de la aplicación

Configuración de entrega

Instalar e inicializar el lado del servidor

Importe telemetry-sh en código solo de servidor e inicialícelo una vez con Process.env.TELEMETRY_API_KEY. Mantenga las credenciales de ingesta fuera de los paquetes de navegador, las variables de entorno visibles para el cliente, el control de fuente, los registros y los mensajes de excepción.

Instalación de aws-ecs-fargate

Instalación npm

bash
npm install telemetry-sh
  1. 1Prepare un cliente de entrega del lado del servidor reutilizable con comportamiento de red limitado.
  2. 2Agregue el evento de resultado en el límite de éxito, error, reintento o tiempo de espera.
  3. 3Envíe accesorios controlados e inspeccione las filas almacenadas antes de habilitar una alerta.

Fragmento

Comience con un evento estructurado

Agregue esta forma donde el flujo de trabajo se completa, falla o se vuelve a intentar. Luego cree el panel a partir de campos reales.

aws-ecs-fargate

Evento 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()),
});

Contrato de evento

servicio, ecs_task_family, ecs_task_revision, availability_zone, región y versión

route_template o job_name, estado, duration_ms, retry_count y error_type controlado

Sin credenciales de función de tarea, URI de metadatos, volcado de entorno, etiquetas de contenedor, ARN sin formato, cuerpo de solicitud ni texto de excepción

Puntos de control de implementación

Punto de control 1

Lea ECS_CONTAINER_METADATA_URI_V4 desde el tiempo de ejecución de la tarea y solicite /task localmente con un breve tiempo de espera. Almacene en caché los campos de familia estable, revisión y zona de disponibilidad en lugar de leer metadatos por evento.

Punto de control 2

Mantenga los identificadores de contenedores y tareas efímeras fuera de los campos de grupo ordinarios, a menos que un flujo de trabajo de incidentes limitado los requiera explícitamente.

Punto de control 3

Registre los resultados de la solicitud en el límite de la solicitud o del trabajador. El punto final de metadatos agrega contexto de implementación; no reemplaza las métricas de infraestructura de CloudWatch ni los seguimientos distribuidos.

Verificación

Demuestra que el evento llegó

Ejecute esto después de ejercitar casos conocidos de éxito y fracaso. Reemplace el nombre de la tabla alternativa si su contrato de evento final difiere del fragmento.

Verificación aws-ecs-fargate

Consulta de verificación AWS ECS and Fargate Telemetry Integration

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirme una fila terminal por resultado lógico, con el estado esperado, identificadores, unidades y hora UTC.
Inspeccione el esquema inferido y verifique que los reintentos no cambien los tipos de campos ni generen un nuevo ID de evento lógico.
Busque en los campos almacenados credenciales, cargas útiles sin procesar, mensajes, contenido privado y mensajes de error ilimitados.
Realice un tiempo de espera del proveedor, un rechazo de la ingesta y un cierre del proceso antes de considerar el panel como completo.

Referencias de implementación

Revise el contrato del evento, la guía de seguridad de los datos y la documentación primaria previa antes de habilitar una nueva ruta de producción.

Límite de producción

Mantenga el evento de resultado pequeño y recuperable

Este patrón proporciona

  • Un resultado limitado y listo para SQL junto al flujo de trabajo ascendente.
  • Campos estables para paneles, alertas y correlación entre eventos.
  • Una ruta basada en dispositivos para validar el comportamiento de éxito, fracaso, reintento y tiempo de espera.

Este patrón no proporciona

  • Un exportador de OTLP, un canal de recopilación automática o un reemplazo para seguimientos detallados y registros de diagnóstico.
  • Entrega exactamente una vez simplemente porque la carga útil contiene un ID de evento.
  • Permiso para recopilar cargas útiles sin procesar del proveedor, contenido de usuario, credenciales o datos regulados.

Puntos de partida del esquema de eventos

Revise el detalle de la fila, el límite de emisión, los tipos requeridos, las clases de privacidad, la carga útil de ejemplo y la lista de verificación de validación antes de adaptar una consulta o fragmento a producción.

Función relacionada del producto

Continúe este flujo de trabajo en Alertas

Promueva la consulta de confiabilidad revisada a un umbral propio y un flujo de trabajo de respuesta.

Recetas SQL relacionadas

Responde la siguiente pregunta con SQL

Ejecute la consulta en los campos estructurados de este flujo de trabajo, inspeccione el resultado del ejemplo y convierta una respuesta útil en un panel o alerta.

Explorar todas las recetas

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones