Logging de Peticiones en servicios REST

En ciertas ocasiones, al desarrollar una nueva comunicación entre APIs, es útil poder hacer logging de las peticiones que llegan a nuestros servicios REST.

En esta página se explica los pasos para configurar nuestras aplicaciones Spring Boot y así poder visualizar las peticiones en LAGAR.

Guía detallada

A continuación se detallan las distintas configuraciones que permiten realizar el logging de peticiones y respuestas en clientes REST.

Fichero pom.xml

• Añadir la siguiente dependencia (en caso de no estar añadida):

<properties>
...
<fdwjs.version>[1.0.0,)</fdwjs.version>
...
</properties>
<dependency>
    <groupId>es.um.atica.fundewebjs.fundewebjs-api</groupId>
    <artifactId>fundewebjs-lagar</artifactId>
    <version>${fdwjs.version}</version>
</dependency>

• Añadir en el bloque de repositories, el repositorio de Archiva de FundeWebJS (en caso de no estar añadido):

<repository>
    <id>fundewebjs.archiva.atica.umu.es</id>
    <name>ATICA - UMU Repository - FundeWebJS</name>
    <url>https://archiva.um.es/archiva/repository/FundeWebJS/</url>
    <releases>
        <enabled>true</enabled>
    </releases>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>

Fichero application.properties

• Añadir las siguientes properties:

# FundeWebJS Habilitar filtro para loggear request
fdwjs.api.logging.enable=true
fdwjs.api.logging.client.enable=true
fdwjs.api.logging.query.enable=true
fdwjs.api.logging.headers.enable=true
fdwjs.api.logging.payload.enable=true
fdwjs.api.logging.payload.maxLength=6400
fdwjs.api.logging.url-patterns=*

• • fdwjs.api.logging.enable: Habilita (true) o deshabilita (false) el filtro de logging a nivel general. Por defecto a false.
  • fdwjs.api.logging.client.enable, fdwjs.api.logging.query.enable, fdwjs.api.logging.headers.enable: Habilita que se loguee información de la request (path, cliente, headers).
  • fdwjs.api.logging.payload.enable, fdwjs.api.logging.payload.maxLength: Habilita que se loguee el body de la request y el tamaño máximo de body que se logueará.
  • fdwjs.api.logging.url-patterns: Permite configurar los endpoints para los que se loguearán las requests.

Fichero log4j2.xml

• Añadir el siguiente logger junto al de la aplicación:

<Logger name="es.um.atica.fundewebjs.lagar.config.FundeWebJSRequestLoggingFilter" level="debug" />

- 

Artículos Relacionados