Mejores Prácticas para la Observabilidad en el Framework Gin

Mejores Prácticas para la Observabilidad del Framework Gin Sin Instrumentación Manual Cumbersome

En la era de la computación en la nube, el lenguaje de programación Golang se ha convertido en la opción preferida para muchos desarrolladores. Entre los frameworks más destacados en este ámbito, el framework Gin se destaca por su capacidad para facilitar la construcción de aplicaciones web complejas. Sin embargo, la observabilidad de las aplicaciones desarrolladas con Gin presenta un desafío significativo. Este artículo se centrará en las mejores prácticas para la observabilidad del framework Gin, introduciendo y comparando varias soluciones oficiales recomendadas.

Visión General de las Soluciones de Observabilidad

El framework Gin proporciona una variedad de plugins que ayudan a los desarrolladores a construir rápidamente aplicaciones web. En su lista de plugins oficiales, se incluyen soluciones compatibles con OpenTelemetry, tales como la instrumentación manual del SDK, la inyección en tiempo de compilación y eBPF. A continuación, se describirán cada una de estas tres soluciones recomendadas para la observabilidad.

Preparativos Iniciales

1. Crear una aplicación básica en Golang utilizando el framework Gin:

package main

import (
    "io"
    "log"
    "net/http"
    "time"
    "github.com/gin-gonic/gin"
)

func main() {
    r := gin.Default()
    r.GET("/hello-gin", func(c *gin.Context) {
        c.String(http.StatusOK, "hello\n")
    })
    go func() {
        _ = r.Run()
    }()
    time.Sleep(5 * time.Second)
    for {
        resp, err := http.Get("http://localhost:8080/hello-gin")
        if err != nil {
            log.Fatal(err)
        }
        body, err := io.ReadAll(resp.Body)
        if err != nil {
            log.Fatal(err)
        }
        log.Printf("Body: %s\n", string(body))
        _ = resp.Body.Close()
        time.Sleep(5 * time.Second)
    }
}

2. Iniciar rápidamente varias dependencias del lado del servidor de OpenTelemetry (como OpenTelemetry Collector, Jaeger y Prometheus) según la documentación.

Instrumentación Manual

La instrumentación manual utiliza el mecanismo de middleware del framework Gin para generar un span durante el procesamiento de la solicitud. Se requiere modificar el código existente de la siguiente manera:

const (
    SERVICE_NAME       = ""
    SERVICE_VERSION    = ""
    DEPLOY_ENVIRONMENT = ""
    HTTP_ENDPOINT      = ""
    HTTP_URL_PATH      = ""
)

// Configuración de recursos de la aplicación.
func newResource(ctx context.Context) *resource.Resource {
    hostName, _ := os.Hostname()

    r, err := resource.New(
        ctx,
        resource.WithFromEnv(),
        resource.WithProcess(),
        resource.WithTelemetrySDK(),
        resource.WithHost(),
        resource.WithAttributes(
            semconv.ServiceNameKey.String(SERVICE_NAME),
            semconv.ServiceVersionKey.String(SERVICE_VERSION),
            semconv.DeploymentEnvironmentKey.String(DEPLOY_ENVIRONMENT),
            semconv.HostNameKey.String(hostName),
        ),
    )

    if err != nil {
        log.Fatalf("%s: %v", "Error al crear el recurso de OpenTelemetry", err)
    }
    return r
}

Al añadir el middleware de OpenTelemetry al servicio Gin, se puede recopilar eficazmente la información de trazado de la aplicación Gin.

Instrumentación Automática en Tiempo de Compilación

Además del enfoque de instrumentación manual, la documentación oficial también recomienda una solución de inyección automática en tiempo de compilación para lograr observabilidad sin modificaciones en el código. Los usuarios pueden referirse al proyecto de instrumentación automática en tiempo de compilación open-sourced por Alibaba Cloud para instrumentar la aplicación de ejemplo mencionada anteriormente.

1. Descargar el paquete binario del agente Golang.
2. Compilar la aplicación Golang utilizando el paquete binario del agente Golang.
3. Configurar el endpoint de reporte y ejecutar el programa binario.

Instrumentación Automática eBPF

El último método oficial para la observabilidad de aplicaciones Gin es utilizar la solución eBPF de OpenTelemetry para la instrumentación automática. En eBPF, solo se necesita desplegar un contenedor sidecar privilegiado dentro del namespace del proceso de la aplicación. Este contenedor captura y reporta automáticamente los datos de observabilidad generados por el contenedor de la aplicación.

Comparación de Soluciones

En general, la instrumentación manual ofrece mayor flexibilidad pero incurre en los mayores costos de acceso y mantenimiento. La solución de instrumentación automática en tiempo de compilación representa actualmente la solución óptima para la observabilidad del framework Gin.

Golang Agent ha sido comercializado en Alibaba Cloud, proporcionando a los clientes potentes capacidades de monitoreo. Esta tecnología permite a los usuarios insertar código de monitoreo fácilmente sin cambiar el código existente, facilitando el monitoreo y análisis en tiempo real del rendimiento de las aplicaciones. Con la donación de esta solución a la comunidad OpenTelemetry, se promueve el intercambio técnico y la mejora continua en el campo.

Para más información, puedes consultar la fuente principal del artículo en Alibaba Cloud.