Saltar al contenido
Telemetry
Explorar documentación
Primeros pasosActualizado el 28 de julio de 2026Revisado por los equipos editorial y de producto de Telemetry4 min de lectura

Usa esta documentación con tu agente de programación

Abra un paquete de mensajes enfocados para Claude Code, Codex, Cursor u otro agente de codificación, luego adáptelo al flujo de trabajo que se describe aquí.

En esta página
  1. Contrato de evento
  2. Límite de datos confidenciales
  3. Credenciales y entornos
  4. Comportamiento de entrega y falla.
  5. Esquema y ciclo de vida de los datos.
  6. Análisis y respuesta
  7. Desplegar gradualmente

Lista de verificación de instrumentación en producción

Utilice esta lista de verificación después de un trabajo sintético, una consulta, un panel y una alerta de principio a fin. El objetivo es un lanzamiento de producción limitado con un propietario y un respaldo, no una cobertura máxima del evento.

Contrato de evento

  • El nombre del evento describe un resultado duradero del flujo de trabajo.
  • El grano del negocio está documentado: solicitud, trabajo, cuenta, ejecución del agente, webhook u otra unidad estable.
  • Los campos obligatorios y opcionales se enumeran con tipos y unidades.
  • Los valores de estado, error, característica, versión y entorno utilizan vocabularios acotados.
  • Un identificador estable conecta eventos relacionados sin exponer un secreto.
  • Los reintentos y los intentos repetidos se pueden distinguir de los resultados finales.

Revise Diseñar un esquema de evento, Eventos amplios canónicos y ID de correlación.

Límite de datos confidenciales

  • Están prohibidas las contraseñas, las claves API, los encabezados de autorización, las cookies y los tokens de sesión.
  • Los cuerpos de solicitud sin procesar, las cargas útiles de webhooks, las indicaciones, las finalizaciones y las cargas útiles de trabajos permanecen fuera a menos que se revisen por separado.
  • Las plantillas de ruta reemplazan las URL que contienen identificadores.
  • Las categorías de error reemplazan el contenido privado sin procesar siempre que sea posible.
  • Los campos personales o regulados tienen un propósito, un límite de acceso y un período de retención aprobados.

Utilice Eliminación de datos sensibles confidenciales y la descripción general de Seguridad y manejo de datos durante la revisión.

Credenciales y entornos

  • La ingesta de producción utiliza una clave con nombre y alcance de escritura.
  • La automatización de informes utiliza una clave de alcance de lectura independiente.
  • Las claves se encuentran en un administrador secreto o en una configuración de tiempo de ejecución protegida.
  • La preparación y la producción utilizan claves independientes y un campo environment explícito.
  • Se registra la rotación y revocación de la titularidad.

Nunca introduzca una variable de entorno requerida sin confirmar cada entorno implementado o proporcionar un respaldo compatible.

Comportamiento de entrega y falla.

  • La entrega de Telemetry tiene un tiempo de espera limitado.
  • Un error de telemetría no daña el resultado de la aplicación principal.
  • Los reintentos están limitados y son observables.
  • Se prueba el comportamiento de apagado o descarga para el SDK seleccionado.
  • Los bucles de alto volumen no emiten un evento para cada paso interno sin un motivo aprobado.

Ejecute una prueba controlada con el terminal Telemetry no disponible o lento. La aplicación debe seguir su respaldo documentado.

Esquema y ciclo de vida de los datos.

  • En la tabla final se han inspeccionado filas sintéticas.
  • Los tipos de campos siguen siendo compatibles con los productores existentes y las consultas guardadas.
  • Las opciones de partición reflejan filtros de consulta reales.
  • La retención coincide con el propósito operativo y de privacidad.
  • Se comprenden las responsabilidades de eliminación de filas y tablas.

Consulte Evolución del esquema, Elegir columnas de partición y Retención y eliminación de datos.

Análisis y respuesta

  • El primer resultado guardado de SQL coincide con un encuentro conocido.
  • Se documentan los denominadores, exclusiones, ventanas de tiempo y reglas de identidad.
  • Los widgets del panel conducen a filas o SQL inspeccionables.
  • Cada alerta tiene un umbral probado, un destinatario y una acción de respuesta.
  • Las dimensiones comerciales, de seguridad o de clientes tienen un límite de acceso adecuado.

Utilice el Metodología de prueba SQL y un Receta SQL relacionado antes de tratar el resultado como evidencia de producción.

Desplegar gradualmente

Comience con un servicio, trabajador o ruta. Observe el volumen de eventos, el comportamiento del esquema, el costo de las consultas, los errores de entrega y el ruido de las alertas antes de expandirse.

Registro:

  • Propietario y fecha de revisión.
  • Servicios y lanzamientos implementados.
  • Volumen de eventos diario esperado.
  • Consultas guardadas y enlaces al panel.
  • Destinatarios de alertas y documentación de respuesta.
  • Deficiencias conocidas y el desencadenante de la próxima revisión.

Si el flujo de trabajo pasa esta lista de verificación, amplíe la evidencia. Si no es así, mantenga el evento en desarrollo o puesta en escena hasta que el límite esté claro.

Función relacionada del producto

Registra nombres de eventos estables, campos con tipos definidos y contexto revisado para proteger la privacidad.

Responsabilidad y referencias técnicas

El equipo editorial de Telemetry es responsable de esta explicación; el equipo de producto revisa el comportamiento, los ejemplos y las limitaciones.

Consultar los criterios editoriales