Saltar al contenido
Telemetry
guía de integración

Ir al registro estructurado del servidor HTTP

Agregue eventos de resultado de solicitud escritos a los servicios Go HTTP para obtener tasas de error de ruta, percentiles de latencia y comparaciones de versiones.

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
  • Vaya a la confiabilidad API
  • Monitoreo de latencia de ruta
  • Comparaciones de versiones
Evidencia de implementación

Go HTTP Server Structured Logging: del límite a la fila verificada

Utilice Go HTTP Server Structured Logging 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

    Vaya a la confiabilidad API

  2. 2

    Definir el contrato

    route_template, método y status_code

  3. 3

    Instrumentar el límite

    Utilice el patrón de enrutador en lugar de r.URL.Path para evitar un grupo por identificador de recurso.

  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

  • El SDK de telemetry-go se inicializó con una clave del lado del servidor
  • Un contenedor de redacción de respuestas que registra el código de estado final
  • Nombres de ruta normalizados desde el enrutador de la aplicación.

Configuración de entrega

Instalar e inicializar el lado del servidor

Inicialice telemetry.NewTelemetry una vez por proceso o utilice un http.Client propiedad de la aplicación cuando necesite una cancelación de contexto y un tiempo de espera explícito. 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 go-http

Instalación Go module

bash
go get github.com/telemetry-sh/telemetry-go
  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.

go-http

Evento Go HTTP Server Structured Logging

go
startedAt := time.Now()
next.ServeHTTP(recorder, r)

status := "success"
if recorder.StatusCode >= 500 {
    status = "failed"
}

_, err := telemetryClient.Log("api_request_completed", map[string]interface{}{
    "route_template": routePattern,
    "method":         r.Method,
    "status_code":    recorder.StatusCode,
    "status":         status,
    "latency_ms":     float64(time.Since(startedAt).Microseconds()) / 1000,
    "request_id":     requestID,
})

Contrato de evento

route_template, método y status_code

estado, latency_ms y request_id

servicio, entorno y lanzamiento

Puntos de control de implementación

Punto de control 1

Utilice el patrón de enrutador en lugar de r.URL.Path para evitar un grupo por identificador de recurso.

Punto de control 2

Capture los pánicos y las salidas anticipadas en el mismo modelo de resultados documentado.

Punto de control 3

No cometa errores de ingesta que sobrescriban la respuesta de la aplicación; reportarlos a través de la ruta de diagnóstico del servicio.

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 go-http

Consulta de verificación Go HTTP Server Structured Logging

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
colecciones completasFiabilidad de la API SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones