Saltar al contenido
Telemetry
Explorar documentación

Primeros pasosActualizado el 1 de octubre de 20264 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. Encuentra la tabla
  2. Inspeccionar el esquema inferido
  3. Inspeccionar la fila exacta
  4. Verificar a través del API
  5. registrar el contrato

Verificar la ingesta y el esquema de eventos

Una solicitud API aceptada no es el final de una verificación de instrumentación. Verifique la tabla y la fila resultantes antes de copiar el evento en más rutas, trabajadores o servicios.

Esta página supone que envió el evento sintético telemetry_quickstart desde Envíe su primer evento estructurado.

¿Usas una clave anónima anon_…? Ve a Verificar mediante la API. La misma clave permite consultar eventos durante 24 horas desde el primer envío. Para usar la interfaz del equipo, crea una cuenta y conserva la prueba. En otro navegador, introduce tu clave mediante ¿Ya tienes una clave API anónima? antes de registrarte.

Encuentra la tabla

Abra su equipo Telemetry, seleccione Tablas y abra telemetry_quickstart. Si la tabla está ausente:

  1. Confirme que la solicitud API haya devuelto una respuesta exitosa.
  2. Confirme que la clave pertenece al equipo previsto y que tiene un alcance con capacidad de escritura.
  3. Verifique el nombre exacto de la tabla después de la normalización.
  4. Vuelva a intentarlo una vez con un nuevo request_id sintético.
  5. Siga Solución de problemas de ingesta de eventos antes de cambiar el esquema.

Evite enviar repetidamente el mismo evento sin un nuevo identificador; Los reintentos pueden hacer que los recuentos posteriores sean ambiguos.

Inspeccionar el esquema inferido

El ejemplo sintético API debería exponer campos similares a:

campo Tipo analítico esperado comprobar
timestamp_utc Marca de tiempo Agregado consistentemente y almacenado en UTC
route_template Texto Contiene una plantilla de ruta limitada, no una URL sin formato
status_code Entero Puede admitir comparaciones numéricas
latency_ms Número Utiliza milisegundos en todas partes
status Texto Utiliza un pequeño vocabulario documentado.
request_id Texto Conecta eventos relacionados sin exponer secretos

Si un campo importante tiene un tipo incorrecto, detenga y corrija al productor antes de enviar el volumen de producción. Un campo que cambia de un número a texto arbitrario puede hacer que sea más difícil razonar sobre el SQL y los gráficos guardados.

Inspeccionar la fila exacta

Utilice la vista MuestrasoTabla y busque request_id = req_demo_001. Confirmar:

  • La fila pertenece al entorno y la versión esperados.
  • latency_ms es 184, no 0.184 o 184000.
  • La ruta no contiene un informe real ni un identificador de cuenta.
  • No se incluyó ningún encabezado de autorización, cookie, cuerpo de solicitud, secreto, aviso o contenido privado del cliente.
  • La hora generada coincide con la ventana de envío.

La fila esperada es evidencia de que el contrato de evento funciona. No es un punto de referencia de desempeño ni una distribución de producción representativa.

Verificar a través del API

Para estas comprobaciones por API, usa una clave con permisos de lectura en un servidor de confianza o en una terminal local. Las claves Ingest only pueden enviar eventos, pero no listar tablas, consultar esquemas ni ejecutar consultas. No incluyas claves con permisos de lectura en el código del navegador o de una app móvil; usa la interfaz del equipo para verificar los eventos enviados con una clave Ingest only.

También puede inspeccionar tablas y esquemas mediante programación:

curl https://api.telemetry.sh/tables \
  -H "Authorization: Bearer $TELEMETRY_API_KEY"

Luego solicite el esquema de la tabla:

curl https://api.telemetry.sh/tables/telemetry_quickstart/schema \
  -H "Authorization: Bearer $TELEMETRY_API_KEY"

Consulta el evento con una clave con permisos de lectura del mismo espacio de trabajo. Si usaste otro request_id, sustituye req_demo_001 abajo. Esta consulta revisa las últimas 24 horas y devuelve como máximo diez filas coincidentes:

curl https://api.telemetry.sh/query \
  -H "Authorization: Bearer $TELEMETRY_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{"query":"SELECT timestamp_utc, request_id, route_template, status_code, latency_ms, release, environment FROM telemetry_quickstart WHERE request_id = 'req_demo_001' AND timestamp_utc >= now() - INTERVAL '24 hours' ORDER BY timestamp_utc DESC LIMIT 10"}
JSON

Busca status: "success" y la fila esperada en data, incluido latency_ms: 184. Un arreglo data vacío no confirma la ingesta; revisa la clave, la tabla, el identificador y la hora del envío. Varias filas coincidentes pueden ser reintentos, no operaciones distintas de la aplicación. La lectura correcta de la muestra solo verifica esta prueba sintética. Después, instrumenta una operación real de tu aplicación y consulta su tabla.

Utilice una clave con capacidad de lectura para la automatización de la verificación. El Tablas API documenta paginación, normalización, retención y respuestas de esquema.

registrar el contrato

Antes de ampliar la instrumentación, anotar:

  • El nombre del evento y el grano comercial.
  • Campos obligatorios y opcionales.
  • Tipos de campo y unidades.
  • Categorías de estado y error permitidas.
  • Campos de identidad y correlación.
  • Campos que están prohibidos.
  • El titular y el plazo de conservación previsto.

Continúe con Escriba su primera consulta sobre SQL. Para conocer la estrategia de cambio de esquema, consulte Evolución del esquema.

Función relacionada

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

Autores de la página y referencias

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

Cómo revisamos nuestra documentación