Log

Este paquete basado en zap⚡ permite loguear los eventos y/o errores que se dan en nuestra aplicación. Actualmente, estamos usando el stack de Elastic o ELK, con lo cual, nos basamos en el estandar de arquitectura.

Console o JSON? 🔧

Usaremos la variable de entorno LOG_CONFIG_PATH para configurar la ruta del archivo .json de configuracion que permitirá parametrizar nuestro logger.

Una buena pregunta... ❓

• "Estoy trabajando con Openshift, estoy OBLIGADO a subir un archivo .json?? 😨 O sea que cada vez que quiera cambiar la configuración del log tengo que commitear, pushear, buildear y generar un deploy? 😨😨"

• No! Afortunadamente no. Claramente sería una locura laburar de esa manera. La mejor alternativa en ese caso, es crear un ConfigMap y montarlo en el punto de entrada o ruta que vos prefieras.

Estándares de configuracion

En dicho archivo .json, podremos configurar si queremos que nuestros logs se visualicen en forma de consola con sus campos separados por pipes (|) o en json, y las keys de los diferentes campos de ese JSON. Debajo dejamos archivos de configuración listos para utilizar en nuestros proyectos.

Console

{
	"level": "debug",
	"encoding": "console",
	"development": true,
	"outputPaths": [
		"stderr"
	],
	"errorOutputPaths": [
		"stderr"
	],
	"encoderConfig": {
		"callerKey": "context",
		"timeKey": "timestamp",
		"messageKey": "message",
		"levelKey": "severity",
		"stacktraceKey": "" //Asignamos un valor vacío para que la stracktrace no se imprima en la consola, evitando que se salga del estándar
	}
}

JSON

{
	"level": "debug",
	"encoding": "json",
	"development": true,
	"outputPaths": [
		"stderr"
	],
	"errorOutputPaths": [
		"stderr"
	],
	"encoderConfig": {
		"callerKey": "context",
		"timeKey": "timestamp",
		"messageKey": "message",
		"levelKey": "severity",
		"stacktraceKey": "" //Asignamos un valor vacío para que la stracktrace no se imprima en la consola, evitando que se salga del estándar
	}
}

• PD: Si nos olvidamos de setear dicha variable de entorno, el logger se configurará con una salida en formato console

Acceso

El paquete dispone dos variables globales que permiten loguear:

• Logger
• SugarLogger

Logger o SugarLogger? 🤔

Logger permite un logueo rápido recibiendo un parámetro de tipo String, en cualquiera de sus niveles de logueo. En caso de que no queramos estar concatenando para obtener un parámetro único de String, podemos optar por SugarLogger, que si bien es un poco más lento que el Logger resuelve ciertas cosas por nosotros, es decir, imprime más al estilo de un printf(), por ejemplo:

log.SugarLogger.Infof("La conexión a la BD %s se realizó sin problemas!", "BD_PROD_01")
// o bien
log.SugarLogger.Error("Error al leer la respuesta desde la API.", err)

Niveles de Logueo 🤓

Ambos Loggers admiten los siguientes niveles de Logueo:

• DEBUG: trazas de la aplicación al debuguear
• INFO: Información general
• WARN: Advertencia!
• ERROR: Errores en general, sean de conexión a una base de datos, a una API, un error al parsear un dato, etc.
• FATAL: Errores irrecuperables

Manos a la obra! 👨‍💻👩‍💻

Console

export LOG_ENCODING="console"

import "github.com/architecture-it/go-platform/log"
import "errors"

func main() {

    log.Logger.Info("Hola!")
    // genera esta salida
    // 2020-08-14 10:31:34.613	 | 0 | INFO | main.exe	| test-log/main.go:6 |	Hola!

    err := errors.New("No sos vos, soy yo")
    log.Error.JSON(err.Error())
    //2020-08-14 11:19:16.524	 | 0 | ERROR | main.exe	| test-log/main.go:11 |	No sos vos, soy yo
}

JSON

export LOG_ENCODING="json"

import "github.com/architecture-it/go-platform/log"
import "errors"

func main() {

    log.Logger.Info("Hola!")
    // genera esta salida
    // {"severity":"INFO","timestamp":"2020-08-17 11:34:15.064","context":"test-log/main.go:6","message":"Hola!","threadId":0,"applicationName":"main.exe"}

    err := errors.New("No sos vos, soy yo")
    log.Error.JSON(err.Error())
    // {"severity":"ERROR","timestamp":"2020-08-14 11:31:19.773","context":"test-log/main.go:11","message":"No sos vos, soy yo","threadId":0,"applicationName":"main.exe"}
}