Improves application logging and monitoring

oDaviML · oDaviML · commit 500f067e2fce · 2025-12-11T11:47:43.000-03:00
Adds structured logging using Logstash to enhance application monitoring and debugging.

Implements detailed logging for exceptions and scheduler tasks,
providing contextual information such as transaction IDs, status codes, and relevant data.
This allows for better traceability and faster issue resolution.

The custom exception handler now logs warnings and errors with relevant context, including exception type, HTTP status, and error messages.
Scheduler tasks now include a transaction ID for easier tracking of background processes.
diff --git a/pom.xml b/pom.xml
@@ -84,6 +84,11 @@
             <artifactId>jackson-datatype-jsr310</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>net.logstash.logback</groupId>
+            <artifactId>logstash-logback-encoder</artifactId>
+            <version>9.0</version>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/src/main/java/com/dmware/api_onibusbh/infra/CustomExceptionHandler.java b/src/main/java/com/dmware/api_onibusbh/infra/CustomExceptionHandler.java
@@ -1,6 +1,8 @@
 package com.dmware.api_onibusbh.infra;
 
 import com.dmware.api_onibusbh.exceptions.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ControllerAdvice;
@@ -11,54 +13,66 @@
 
 import java.io.IOException;
 
+import static net.logstash.logback.argument.StructuredArguments.kv;
+
 @ControllerAdvice
 public class CustomExceptionHandler extends ResponseEntityExceptionHandler {
 
+    private static final Logger logger = LoggerFactory.getLogger(CustomExceptionHandler.class);
+
     @ExceptionHandler(LinhasNotFoundException.class)
     public ResponseEntity<ErrorResponse> linhasNotFoundException(LinhasNotFoundException ex) {
+        logger.warn("Recurso não encontrado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.NOT_FOUND));
         return ErrorResponse.of("Não foi encontrada nenhuma linha, por favor tente novamente", HttpStatus.NOT_FOUND);
     }
 
     @ExceptionHandler(CoordenadasNotFoundException.class)
     public ResponseEntity<ErrorResponse> coordenadasNotFoundException(CoordenadasNotFoundException ex) {
+        logger.warn("Recurso não encontrado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.NOT_FOUND));
         return ErrorResponse.of("Não foi encontrada nenhuma coordenada, por favor tente novamente",
                 HttpStatus.NOT_FOUND);
     }
 
     @ExceptionHandler(DicionarioNotFoundException.class)
     public ResponseEntity<ErrorResponse> dicionarioNotFoundException(DicionarioNotFoundException ex) {
+        logger.warn("Recurso não encontrado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.NOT_FOUND));
         return ErrorResponse.of("Não foi encontrado o dicionário para os dados, por favor tente novamente",
                 HttpStatus.NOT_FOUND);
     }
 
     @ExceptionHandler(LinhaNotFoundException.class)
     public ResponseEntity<ErrorResponse> linhaNotFoundException(LinhaNotFoundException ex) {
+        logger.warn("Recurso não encontrado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.NOT_FOUND));
         return ErrorResponse.of("Não foi encontrada nenhuma linha, por favor tente novamente", HttpStatus.NOT_FOUND);
     }
 
     @ExceptionHandler(ValidJsonException.class)
     public ResponseEntity<ErrorResponse> validJsonException(ValidJsonException ex) {
+        logger.warn("Erro de validação JSON", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.BAD_REQUEST), kv("mensagem_erro", ex.getMessage()));
         return ErrorResponse.of(ex.getMessage(), HttpStatus.BAD_REQUEST);
     }
 
     @ExceptionHandler(RuntimeException.class)
     public ResponseEntity<ErrorResponse> runtimeException(RuntimeException ex) {
-        logger.error(ex.getMessage(), ex);
+        logger.error("Erro interno não tratado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.INTERNAL_SERVER_ERROR), ex);
         return ErrorResponse.of("Ocorreu um erro interno, por favor tente novamente", HttpStatus.INTERNAL_SERVER_ERROR);
     }
 
     @ExceptionHandler(IOException.class)
     public ResponseEntity<ErrorResponse> ioException(IOException ex) {
+        logger.error("Erro interno não tratado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.INTERNAL_SERVER_ERROR), ex);
         return ErrorResponse.of("Ocorreu um erro interno, por favor tente novamente", HttpStatus.INTERNAL_SERVER_ERROR);
     }
 
     @ExceptionHandler(NoResourceFoundException.class)
     public ResponseEntity<ErrorResponse> noResourceFoundException(NoResourceFoundException ex) {
+        logger.warn("Recurso não encontrado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.NOT_FOUND));
         return ErrorResponse.of("Verifique a rota digitada ou os dados enviados", HttpStatus.NOT_FOUND);
     }
 
     @ExceptionHandler(NoHandlerFoundException.class)
     public ResponseEntity<ErrorResponse> noHandlerFoundException(NoHandlerFoundException ex) {
+        logger.warn("Recurso não encontrado", kv("exception", ex.getClass().getSimpleName()), kv("status", HttpStatus.NOT_FOUND));
         return ErrorResponse.of("Verifique a rota digitada ou os dados enviados", HttpStatus.NOT_FOUND);
     }
 }
diff --git a/src/main/java/com/dmware/api_onibusbh/scheduler/CoordenadasScheduler.java b/src/main/java/com/dmware/api_onibusbh/scheduler/CoordenadasScheduler.java
@@ -2,10 +2,12 @@
 
 import java.io.IOException;
 import java.util.List;
+import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
 import com.dmware.api_onibusbh.dto.CoordenadaDTO;
 import com.dmware.api_onibusbh.services.APIService;
+import org.slf4j.MDC;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Component;
@@ -25,8 +27,13 @@ public CoordenadasScheduler(APIService apiService, OnibusService onibusService)
 
     @Scheduled(fixedDelay = 20, timeUnit = TimeUnit.SECONDS)
     public void fetchCoordenadasOnibus() {
-        List<CoordenadaDTO> coordenadas = apiService.getOnibusCoordenadaBH();
-        onibusService.salvaCoordenadas(coordenadas);
+        try {
+            MDC.put("transaction_id", UUID.randomUUID().toString());
+            List<CoordenadaDTO> coordenadas = apiService.getOnibusCoordenadaBH();
+            onibusService.salvaCoordenadas(coordenadas);
+        } finally {
+            MDC.clear();
+        }
     }
 
 }
diff --git a/src/main/java/com/dmware/api_onibusbh/scheduler/DicionarioScheduler.java b/src/main/java/com/dmware/api_onibusbh/scheduler/DicionarioScheduler.java
@@ -1,7 +1,9 @@
 package com.dmware.api_onibusbh.scheduler;
 
+import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
+import org.slf4j.MDC;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.scheduling.annotation.Scheduled;
@@ -21,6 +23,11 @@ public DicionarioScheduler(DicionarioService dicionarioService) {
     @Async
       @Scheduled(fixedDelay = 12, timeUnit = TimeUnit.HOURS)
       public void salvaDicionarioBanco() {
-            dicionarioService.salvarDicionarioBanco();
+            try {
+                  MDC.put("transaction_id", UUID.randomUUID().toString());
+                  dicionarioService.salvarDicionarioBanco();
+            } finally {
+                  MDC.clear();
+            }
       }
 }
diff --git a/src/main/java/com/dmware/api_onibusbh/scheduler/LinhaScheduler.java b/src/main/java/com/dmware/api_onibusbh/scheduler/LinhaScheduler.java
@@ -1,7 +1,9 @@
 package com.dmware.api_onibusbh.scheduler;
 
+import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
+import org.slf4j.MDC;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.scheduling.annotation.Scheduled;
@@ -21,7 +23,12 @@ public LinhaScheduler(LinhasService linhasService) {
     @Async
     @Scheduled(fixedDelay = 12, timeUnit = TimeUnit.HOURS)
     public void fetchCoordenadasOnibus() {
-        linhasService.salvaLinhasNormais();
+        try {
+            MDC.put("transaction_id", UUID.randomUUID().toString());
+            linhasService.salvaLinhasNormais();
+        } finally {
+            MDC.clear();
+        }
     }
 
 }
diff --git a/src/main/java/com/dmware/api_onibusbh/services/APIService.java b/src/main/java/com/dmware/api_onibusbh/services/APIService.java
@@ -1,14 +1,15 @@
 package com.dmware.api_onibusbh.services;
 
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 
 import com.dmware.api_onibusbh.dto.CoordenadaDTO;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Service;
+import org.springframework.web.reactive.function.client.WebClient;
 import org.springframework.web.reactive.function.client.WebClientResponseException;
 
-import com.dmware.api_onibusbh.config.WebClientConfig;
 import com.dmware.api_onibusbh.dto.DicionarioDTO;
 import com.dmware.api_onibusbh.dto.LinhaDTO;
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -21,18 +22,19 @@
 @Service
 public class APIService {
 
-    private final WebClientConfig webClientConfig;
+    private static final Logger logger = LoggerFactory.getLogger(APIService.class);
+
+    private final WebClient webClient;
     private final ObjectMapper objectMapper;
 
-    public APIService(WebClientConfig webClientConfig, ObjectMapper objectMapper) {
-        this.webClientConfig = webClientConfig;
+    public APIService(WebClient webClient, ObjectMapper objectMapper) {
+        this.webClient = webClient;
         this.objectMapper = objectMapper;
     }
 
     public List<DicionarioDTO> getDicionarioAPIBH() {
-        List<DicionarioDTO> dicionarios;
         try {
-            String json = webClientConfig.webClient().get()
+            String json = webClient.get()
                     .uri("https://ckan.pbh.gov.br/api/3/action/datastore_search?resource_id=825337e5-8cd5-43d9-ac52-837d80346721&limit=20")
                     .retrieve()
                     .bodyToMono(String.class)
@@ -41,44 +43,33 @@ public List<DicionarioDTO> getDicionarioAPIBH() {
             JsonNode rootNode = objectMapper.readTree(json);
             JsonNode recordsNode = rootNode.path("result").path("records");
 
-            // Deserializa o JsonNode em uma lista de objetos DicionarioDTO
-            dicionarios = objectMapper.readValue(recordsNode.toString(),
-                    new TypeReference<List<DicionarioDTO>>() {
-                    });
+            return objectMapper.convertValue(recordsNode, new TypeReference<List<DicionarioDTO>>() {});
 
         } catch (JsonProcessingException | WebClientResponseException e) {
             throw new RuntimeException(e);
         }
-
-        return dicionarios;
     }
 
     public List<LinhaDTO> getLinhasAPIBH() {
         try {
-            // Consome API PBH para buscar linhas
-            String json = webClientConfig.webClient().get()
+            String json = webClient.get()
                     .uri("https://ckan.pbh.gov.br/api/3/action/datastore_search?resource_id=150bddd0-9a2c-4731-ade9-54aa56717fb6&limit=3000")
                     .retrieve()
                     .bodyToMono(String.class)
                     .block();
 
-            // Lê o json e navega até o campo "result" -> "records"
             JsonNode rootNode = objectMapper.readTree(json);
             JsonNode recordsNode = rootNode.path("result").path("records");
 
-            // Deserializa o JsonNode em uma lista de objetos LinhaDTO
-
-            return objectMapper.readValue(recordsNode.toString(),
-                    new TypeReference<List<LinhaDTO>>() {
-                    });
+            return objectMapper.convertValue(recordsNode, new TypeReference<List<LinhaDTO>>() {});
 
         } catch (JsonProcessingException | WebClientResponseException e) {
             throw new RuntimeException(e);
         }
     }
 
     public List<CoordenadaDTO> getOnibusCoordenadaBH() {
-        System.out.printf("Acessando diretamente.%n");
+        logger.info("Acessando diretamente.");
         List<String> responses = fetchCoordenadasDirectly();
 
         if (responses == null || responses.size() < 2) {
@@ -89,17 +80,25 @@ public List<CoordenadaDTO> getOnibusCoordenadaBH() {
     }
 
     private List<String> fetchCoordenadasDirectly() {
-        Mono<String> monoParamD = webClientConfig.webClient().get()
+        Mono<String> monoParamD = webClient.get()
                 .uri("https://temporeal.pbh.gov.br/?param=D")
                 .retrieve()
-                .bodyToMono(String.class);
+                .bodyToMono(String.class)
+                .onErrorResume(e -> {
+                    logger.error("Erro ao buscar coordenadas D", e);
+                    return Mono.just("[]");
+                });
 
-        Mono<String> monoParamSD = webClientConfig.webClient().get()
+        Mono<String> monoParamSD = webClient.get()
                 .uri("https://temporeal.pbh.gov.br/?param=SD")
                 .retrieve()
-                .bodyToMono(String.class);
+                .bodyToMono(String.class)
+                .onErrorResume(e -> {
+                    logger.error("Erro ao buscar coordenadas SD", e);
+                    return Mono.just("[]");
+                });
 
-        return Flux.merge(monoParamD, monoParamSD).collectList().block();
+        return Flux.mergeSequential(monoParamD, monoParamSD).collectList().block();
     }
 
     private List<CoordenadaDTO> processAndReturnCoordenadas(List<String> responses) {
diff --git a/src/main/java/com/dmware/api_onibusbh/services/DicionarioService.java b/src/main/java/com/dmware/api_onibusbh/services/DicionarioService.java
@@ -17,6 +17,8 @@
 import com.dmware.api_onibusbh.entities.DicionarioEntity;
 import com.dmware.api_onibusbh.repositories.DicionarioRepository;
 
+import static net.logstash.logback.argument.StructuredArguments.kv;
+
 @Service
 public class DicionarioService {
 
@@ -48,34 +50,37 @@ public void salvarDicionarioBanco() {
 
             List<DicionarioDTO> listaDados = apiService.getDicionarioAPIBH();
             List<DicionarioEntity> dadosExistentes = dicionarioRepository.findAll();
-            logger.info("Dados existentes no banco de dados: " + dadosExistentes.size());
+            logger.info("Estado inicial do banco", kv("total_existente", dadosExistentes.size()));
 
-            // Mapeia os dados da api para facilitar a comparação
             Map<String, DicionarioEntity> dicionarioMap = dadosExistentes.stream()
                         .collect(Collectors.toMap(DicionarioEntity::getIdDicionario,
                                     dicionarioEntity -> dicionarioEntity));
 
             List<DicionarioDTO> dadosParaSalvar = new ArrayList<>();
 
-            // Realiza a comparação, se for diferente, insere no banco de dados
             for (DicionarioDTO dicionarioDTO : listaDados) {
                   DicionarioEntity dicionarioComparacao = dicionarioMap.get(dicionarioDTO.getId());
 
                   if (dicionarioComparacao == null) {
-                        logger.info("Novo dado encontrado: " + dicionarioDTO.getNomeArquivo());
+                        logger.info("Novo dicionário identificado", 
+                            kv("nome_arquivo", dicionarioDTO.getNomeArquivo()), 
+                            kv("tipo_operacao", "insercao"));
                         dadosParaSalvar.add(dicionarioDTO);
                   } else if (!dicionarioDTO.getNomeArquivo().equals(dicionarioComparacao.getNomeArquivo())) {
-                        logger.info("Novo dado atualizado: " + dicionarioDTO.getNomeArquivo());
+                        logger.info("Dicionário atualizado identificado", 
+                            kv("nome_arquivo", dicionarioDTO.getNomeArquivo()), 
+                            kv("tipo_operacao", "atualizacao"));
                         dadosParaSalvar.add(dicionarioDTO);
                   }
             }
 
-            // Salva apenas os dados que forem novos ou atualizados
             if (!dadosParaSalvar.isEmpty()) {
-                  logger.info("Dicionário novo ou atualizados: " + dadosParaSalvar.size());
                   dicionarioRepository
                               .saveAll(modelMapper.map(dadosParaSalvar, new TypeToken<List<DicionarioEntity>>() {
                               }.getType()));
+                  logger.info("Sincronização de dicionário concluída", kv("total_processado", dadosParaSalvar.size()));
+            } else {
+                  logger.info("Nenhuma alteração necessária no dicionário");
             }
       }
 
diff --git a/src/main/java/com/dmware/api_onibusbh/services/LinhasService.java b/src/main/java/com/dmware/api_onibusbh/services/LinhasService.java
@@ -18,6 +18,8 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 
+import static net.logstash.logback.argument.StructuredArguments.kv;
+
 @Service
 public class LinhasService {
 
@@ -79,7 +81,7 @@ public void salvaLinhasNormais() {
         logger.info("Iniciando sincronização de linhas normais.");
         List<LinhaDTO> linhasDaAPI = apiService.getLinhasAPIBH();
         List<LinhaEntity> linhasExistentes = linhasRepository.findAll();
-        logger.info("Linhas existentes no banco: {}", linhasExistentes.size());
+        logger.info("Estado inicial do banco", kv("total_existente", linhasExistentes.size()));
 
         Map<Integer, LinhaEntity> linhasExistentesMap = linhasExistentes.stream()
                 .collect(Collectors.toMap(LinhaEntity::getIdLinha, linha -> linha));
@@ -98,7 +100,7 @@ public void salvaLinhasNormais() {
 
         if (!linhasParaSalvar.isEmpty()) {
             linhasRepository.saveAll(linhasParaSalvar);
-            logger.info("Linhas normais sincronizadas com sucesso. Total de linhas salvas/atualizadas: {}", linhasParaSalvar.size());
+            logger.info("Linhas normais sincronizadas com sucesso", kv("total_sincronizado", linhasParaSalvar.size()));
         } else {
             logger.info("Nenhuma linha nova ou atualizada encontrada para sincronização.");
         }
diff --git a/src/main/java/com/dmware/api_onibusbh/services/OnibusService.java b/src/main/java/com/dmware/api_onibusbh/services/OnibusService.java
diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml
