Envía y verifica eventos con Ruby on Rails structured event analytics
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
Elige el resultado
Monitoreo de solicitudes de rieles
- 2
Definir el contrato
controller_action, method y status_code observado
- 3
Emitir en el resultado
Este suscriptor observa process_action.action_controller. No instrumenta Active Job, archivos estáticos, respuestas solo de middleware ni la solicitud Rack completa.
- 4
Verificar la evidencia
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
Antes de empezar
Antes de empezar
- Una TELEMETRY_API_KEY del servidor con permiso de escritura
- Coloca este ejemplo en config/initializers/telemetry_requests.rb, una vez por proceso
- Rails con ActiveSupport::Notifications.monotonic_subscribe
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.
- 1Prepare un cliente de entrega del lado del servidor reutilizable con comportamiento de red limitado.
- 2Agregue el evento de resultado en el límite de éxito, error, reintento o tiempo de espera.
- 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.
Evento Ruby on Rails structured event analytics
# config/initializers/telemetry_requests.rb
require "json"
require "net/http"
require "uri"
module TelemetryRailsRequests
def self.delivery_failed
warn "Telemetry request event delivery failed."
rescue StandardError
# Diagnostics must not change the application result either.
end
def self.log(fields)
key = ENV["TELEMETRY_API_KEY"]
return if key.nil? || key.empty?
uri = URI("https://api.telemetry.sh/log")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = key
request["Content-Type"] = "application/json"
request.body = { table: "api_request_completed", data: fields }.to_json
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
http.open_timeout = 1
http.read_timeout = 1
http.write_timeout = 1
http.max_retries = 0
response = http.start { |client| client.request(request) }
delivery_failed unless response.is_a?(Net::HTTPSuccess)
rescue StandardError
delivery_failed
end
end
ActiveSupport::Notifications.monotonic_subscribe(
"process_action.action_controller"
) do |_name, started, finished, _id, payload|
status = payload[:status]
status = nil unless status.is_a?(Integer) && (100..599).cover?(status)
TelemetryRailsRequests.log({
controller_action: "#{payload[:controller]}##{payload[:action]}",
method: payload[:method],
status_code: status,
status: status ? "http_#{status / 100}xx" : "unknown",
exception_observed: !!payload[:exception],
latency_ms: ((finished - started) * 1000).round(2)
})
rescue StandardError
TelemetryRailsRequests.delivery_failed
endEsquema del evento
controller_action, method y status_code observado
Clase de estado HTTP, exception_observed y latency_ms del controlador
Sin parámetros de solicitud, rutas sin procesar, cabeceras, identificadores de usuario ni mensajes de excepción
Comprueba tu configuración
Punto de control 1
Este suscriptor observa process_action.action_controller. No instrumenta Active Job, archivos estáticos, respuestas solo de middleware ni la solicitud Rack completa.
Punto de control 2
Las clases de estado HTTP describen respuestas observadas del controlador, no el éxito del negocio ni la entrega al usuario. Un estado ausente sigue siendo desconocido.
Punto de control 3
La latencia usa el intervalo monotónico de la notificación del controlador y excluye el tiempo de exportación HTTP de este suscriptor.
Punto de control 4
La exportación es síncrona y de mejor esfuerzo, con tiempos de espera de un segundo para conexión, lectura y escritura. Estos tiempos de espera de socket no son un límite total estricto; el envío añade latencia a la solicitud.
Punto de control 5
Los fallos de transporte, respuestas no 2xx, codificación y diagnóstico se contienen para no reemplazar el resultado del controlador ni la excepción original. Si falta la clave, se omite la exportación.
Punto de control 6
No hay cola, entrega duradera, reintentos del exportador ni vaciado al cerrar. Usa un buzón de salida propio de la aplicación si no se admite pérdida de eventos.
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.
Consulta de verificación Ruby on Rails structured event analytics
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;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.
Dónde registrar eventos
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.
Ejemplos de esquemas de eventos
Esquemas 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.
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.
Recetas SQL relacionadas
Más ejemplos de 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.
Calcular la tasa de errores de API por ruta
¿Qué rutas de API tienen la mayor tasa de errores 5xx con al menos 20 solicitudes?
Receta abiertaMedir 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 abiertaCree un embudo de registro para activación en SQL
¿Dónde se van los nuevos usuarios antes de alcanzar el primer valor?
Receta abiertaPlantillas 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 plantillaMonitor 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 plantillaPlantilla 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 plantillaMá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 guiaRegistro 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 guiaFunciones 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