Middleware

Le Package Core fournit plusieurs outils pour vous aider à mettre en place un logger simple à utiliser. Parmi eux, des middlewares Express.

ContextMiddleware

Ce middleware vous permet de générer et récupérer un identifiant de requête unique (UUID).

// Add the middleware to your Express application
app.use(contextMiddleware);

// You can now get the current requestId from everywhere
getRequestContext()?.requestId // string | undefined

LoggerSetupMiddleware

Ce middleware détermine le nom du Controller en s'appuyant sur la convention de nommage *.controller.ts

Il enregistre également le responseBody renvoyé au client.

// Add the middleware to your Express application
app.use(loggerEndpointMiddleware);

info

Ce middleware est une dépendance du loggerEndpointMiddleware.

LoggerEndpointMiddleware

Ce middleware loggue chaque requête reçue par votre API dans le Monitor Dashboard.

// Add the middleware to your Express application
app.use(loggerEndpointMiddleware);

// You can dynamically disable logging for specific request by adding
res.locals = {
  shouldNotPublishLog?: boolean; // To not publish the log and not log it to the console
  shouldNotSaveRequestBody?: boolean; // To not save the requestBody
  shouldNotSaveResponseBody?: boolean; // To not save the responseBody
}

info

Vous devriez activer shouldNotPublishLog pour les endpoints d'uptime afin de ne pas polluer votre dashboard.