Saltar al contenido
Telemetry
guía de integración

Análisis de eventos estructurados de Ruby on Rails

Registre el controlador Rails y los resultados del flujo de trabajo en segundo plano a través de la API HTTP de Telemetry con campos seguros y consultables.

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

Obtén una clave APIVer fragmento
Útil para
  • Monitoreo de solicitudes de rieles
  • Fiabilidad del trabajo activo
  • Análisis del flujo de trabajo del producto
Evidencia de implementación

Ruby on Rails Structured Event Analytics: del límite a la fila verificada

Utilice Ruby on Rails Structured Event Analytics 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

    Monitoreo de solicitudes de rieles

  2. 2

    Definir el contrato

    controller_action, método y status_code

  3. 3

    Instrumentar el límite

    Envíe una carga útil incluida en la lista permitida en lugar de serializar los parámetros de solicitud.

  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

  • Un TELEMETRY_API_KEY del lado del servidor
  • Un pequeño cliente HTTP con tiempos de espera de apertura y lectura explícitos
  • Nombres de ruta o acción de controlador normalizados

Configuración de entrega

Instalar e inicializar el lado del servidor

Utilice un pequeño contenedor Net::HTTP con una clave del lado del servidor más tiempos de espera de apertura y lectura explícitos. 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.

  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.

ruby-rails

Evento Ruby on Rails Structured Event Analytics

ruby
payload = {
  table: "api_request_completed",
  data: {
    controller_action: "#{controller_name}##{action_name}",
    method: request.method,
    status_code: response.status,
    status: response.server_error? ? "failed" : "success",
    latency_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
    request_id: request.request_id
  }
}

TelemetryHttp.log(payload)

Contrato de evento

controller_action, método y status_code

estado, latency_ms y error_type

request_id, account_id y versión

Puntos de control de implementación

Punto de control 1

Envíe una carga útil incluida en la lista permitida en lugar de serializar los parámetros de solicitud.

Punto de control 2

Maneje las fallas de ingesta sin imprimir la clave API ni cambiar la respuesta completa del cliente.

Punto de control 3

Utilice los mismos tipos de campos en controladores y trabajadores de trabajos activos.

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 ruby-rails

Consulta de verificación Ruby on Rails Structured Event Analytics

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.

Guía HTTP de RubíRedactar datos confidencialesDepuración y registro de rieles

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.
Entrega e idempotenciaProcesamiento por lotes y apagadoSolucionar problemas de ingestión

Puntos de partida del esquema de eventos

Contratos de eventos para este flujo de trabajo

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.

Ciclo de vida del producto7 campos

user_signed_up

Un registro aceptado por usuario y cuenta.

inspeccionar contrato
Análisis de producto8 campos

product_milestone_completed

Un hito completado por actor, cuenta y ocurrencia.

inspeccionar contrato

Función relacionada del producto

Continúe este flujo de trabajo en Paneles de control

Convierta una consulta de ingresos o un producto validado en una superficie de decisión enfocada.

Explorar Paneles de controlRevisar la evidencia del cliente

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
Fiabilidad de la APIPrincipiante

Calcular la tasa de errores de API por ruta

¿Qué rutas API tienen la tasa de error 5xx significativa más alta?

Receta abierta
Tareas en segundo planoPrincipiante

Medir el reintento del trabajo en segundo plano y la tasa de fallas

¿Qué trabajos en segundo plano consumen más reintentos o aún fallan?

Receta abierta
Análisis de productoIntermedio

Cree un embudo de registro para activación en SQL

¿Dónde se van los nuevos usuarios antes de alcanzar el primer valor?

Receta abierta
colecciones completasFiabilidad de la API SQLTareas en segundo plano SQLAnálisis de producto SQL

Plantillas para combinar con esta integración

Monitor de fallas en el trabajo en segundo plano

Capture el estado de los trabajos de cola, cron, importación, sincronización de facturación y webhook desde la primera ejecución hasta los reintentos y fallas.

Abrir plantilla

Monitor de latencia y errores de API

Observe el volumen de solicitudes, los códigos de estado, la latencia de ruta, los puntos finales fallidos y los incidentes de API que afectan al cliente.

Abrir plantilla

Plantilla de activación y retención

Realice un seguimiento del camino desde el registro hasta la primera acción significativa, el uso retenido, la intención de actualización y las señales de expansión.

Abrir plantilla

Más integraciones

Supabase y aplicación Postgres Telemetry

Realice un seguimiento de los flujos de trabajo de productos, trabajos adyacentes a bases de datos, rutas API y fallas de cara al cliente desde el código del servidor.

abrir guia

Registro estructurado de Laravel y análisis de colas

Envíe los resultados de solicitudes, comandos, colas y facturación de Laravel como eventos escritos sin exponer secretos de aplicaciones ni cargas útiles.

abrir guia

Funciones de Azure Telemetry

Realice un seguimiento de los resultados de HTTP, temporizador, cola y desencadenador de eventos de Azure Functions con invocación, reintento, latencia, liberación y contexto de impacto en el cliente.

abrir guia