[PAGOPA-1834] feat: Enhancing Registro Eventi's event tracing (#26)

* [PAGOPA-1834] fix: refactored RE event, normalizing language and removing unused fields
* [PAGOPA-1834] fix: refactored internal step status enum
* [PAGOPA-1834] chore: removed unused files
* [PAGOPA-1834] fix: add logging level also on interceptors
* [PAGOPA-1834] fix: restructuring RE generation and MDC setting
* [PAGOPA-1834] fix: little refactoring of errors and added more descriptions
* [PAGOPA-1834] fix: removed RE logging for 'retrieve cache' invocations
* [PAGOPA-1834] fix: restructuring RE generation for PP generation and caching
* [PAGOPA-1834] fix: restructuring RE generation for Checkout communication
* [PAGOPA-1834] feat: added optional RE tracing for client invocation
* [PAGOPA-1834] feat: added optional RE tracing for internal status change
* [PAGOPA-1834] feat: added feature flags for RE tracing
* [PAGOPA-1834] fix: set injected parameters of RE tracing in client config
* [PAGOPA-1834] fix: resolved issue about log injection

---------

Co-authored-by: pagopa-github-bot <github-bot@pagopa.it>

helm/Chart.yaml

@@ -2,8 +2,8 @@ apiVersion: v2
 name: pagopa-wisp-converter
 description: A service that permits to handle nodoInviaRPT and nodoInviaCarrelloRPT request from WISP, interfacing them with GPD system
 type: application
-version: 0.54.0
-appVersion: 0.0.21
+version: 0.55.0
+appVersion: 0.0.21-1-PAGOPA-1834-re-refactoring
 dependencies:
   - name: microservice-chart
     version: 3.0.0

helm/values-dev.yaml

@@ -4,7 +4,7 @@ microservice-chart:
   fullnameOverride: ""
   image:
     repository: ghcr.io/pagopa/pagopa-wisp-converter
-    tag: "0.0.21"
+    tag: "0.0.21-1-PAGOPA-1834-re-refactoring"
     pullPolicy: Always
   livenessProbe:
     httpGet:
@@ -90,8 +90,16 @@ microservice-chart:
     CLIENT_DECOUPLERCACHING_HOST: 'https://api.dev.platform.pagopa.it/wisp-converter/caching/api/v1'
     CLIENT_CACHE_HOST: 'https://api.dev.platform.pagopa.it/api-config-cache/p/v1'
     STATION_IN_GPD_PARTIAL_PATH: 'gpd-payments/api/v2'
+    RE_TRACING_INTERFACE_IUVGENERATOR_ENABLED: 'true'
+    RE_TRACING_INTERFACE_PAYMENTPOSITIONANALYSIS_ENABLED: 'true'
+    RE_TRACING_INTERFACE_DECOUPLERCACHING_ENABLED: 'true'
+    RE_TRACING_INTERFACE_CHECKOUTINTERACTION_ENABLED: 'true'
+    RE_TRACING_INTERNAL_RPTRETRIEVING_ENABLED: 'true'
+    RE_TRACING_INTERNAL_RPTEXTRACTION_ENABLED: 'true'
+    RE_TRACING_INTERNAL_PAYMENTPOSITIONANALYSIS_ENABLED: 'true'
+    RE_TRACING_INTERNAL_DECOUPLERCACHING_ENABLED: 'true'
+    RE_TRACING_INTERNAL_CHECKOUTINTERACTION_ENABLED: 'true'
     SPRING_PROFILES_ACTIVE: "default,jsonLog"
-    CLIENT_CHECKOUT_USEBLUEDEPLOYMENT: 'true'
   secretProvider:
     create: true
     envSecrets:

helm/values-prod.yaml

@@ -4,7 +4,7 @@ microservice-chart:
   fullnameOverride: ""
   image:
     repository: ghcr.io/pagopa/pagopa-wisp-converter
-    tag: "0.0.21"
+    tag: "0.0.21-1-PAGOPA-1834-re-refactoring"
     pullPolicy: Always
   livenessProbe:
     httpGet:
@@ -90,6 +90,15 @@ microservice-chart:
     CLIENT_DECOUPLERCACHING_HOST: 'https://api.platform.pagopa.it/wisp-converter/caching/api/v1'
     CLIENT_CACHE_HOST: 'https://api.platform.pagopa.it/api-config-cache/p/v1'
     STATION_IN_GPD_PARTIAL_PATH: 'gpd-payments/api/v2'
+    RE_TRACING_INTERFACE_IUVGENERATOR_ENABLED: 'true'
+    RE_TRACING_INTERFACE_PAYMENTPOSITIONANALYSIS_ENABLED: 'true'
+    RE_TRACING_INTERFACE_DECOUPLERCACHING_ENABLED: 'true'
+    RE_TRACING_INTERFACE_CHECKOUTINTERACTION_ENABLED: 'true'
+    RE_TRACING_INTERNAL_RPTRETRIEVING_ENABLED: 'true'
+    RE_TRACING_INTERNAL_RPTEXTRACTION_ENABLED: 'true'
+    RE_TRACING_INTERNAL_PAYMENTPOSITIONANALYSIS_ENABLED: 'true'
+    RE_TRACING_INTERNAL_DECOUPLERCACHING_ENABLED: 'true'
+    RE_TRACING_INTERNAL_CHECKOUTINTERACTION_ENABLED: 'true'
     SPRING_PROFILES_ACTIVE: "default,jsonLog"
   secretProvider:
     create: true

helm/values-uat.yaml

@@ -4,7 +4,7 @@ microservice-chart:
   fullnameOverride: ""
   image:
     repository: ghcr.io/pagopa/pagopa-wisp-converter
-    tag: "0.0.21"
+    tag: "0.0.21-1-PAGOPA-1834-re-refactoring"
     pullPolicy: Always
   livenessProbe:
     httpGet:
@@ -90,6 +90,15 @@ microservice-chart:
     CLIENT_DECOUPLERCACHING_HOST: 'https://api.uat.platform.pagopa.it/wisp-converter/caching/api/v1'
     CLIENT_CACHE_HOST: 'https://api.uat.platform.pagopa.it/api-config-cache/p/v1'
     STATION_IN_GPD_PARTIAL_PATH: 'gpd-payments/api/v2'
+    RE_TRACING_INTERFACE_IUVGENERATOR_ENABLED: 'true'
+    RE_TRACING_INTERFACE_PAYMENTPOSITIONANALYSIS_ENABLED: 'true'
+    RE_TRACING_INTERFACE_DECOUPLERCACHING_ENABLED: 'true'
+    RE_TRACING_INTERFACE_CHECKOUTINTERACTION_ENABLED: 'true'
+    RE_TRACING_INTERNAL_RPTRETRIEVING_ENABLED: 'true'
+    RE_TRACING_INTERNAL_RPTEXTRACTION_ENABLED: 'true'
+    RE_TRACING_INTERNA_PAYMENTPOSITIONANALYSIS_ENABLED: 'true'
+    RE_TRACING_INTERNAL_DECOUPLERCACHING_ENABLED: 'true'
+    RE_TRACING_INTERNAL_CHECKOUTINTERACTION_ENABLED: 'true'
     SPRING_PROFILES_ACTIVE: "default,jsonLog"
   secretProvider:
     create: true

pom.xml

@@ -13,7 +13,7 @@
 
     <groupId>it.gov.pagopa</groupId>
     <artifactId>wisp-converter</artifactId>
-    <version>0.0.21</version>
+    <version>0.0.21-1-PAGOPA-1834-re-refactoring</version>
     <name>pagoPA WISP Converter</name>
     <description>A service that permits to handle nodoInviaRPT and nodoInviaCarrelloRPT request from WISP, converting them in NMU payments.</description>
 

src/main/java/it/gov/pagopa/wispconverter/config/client/CheckoutClientConfig.java

@@ -34,6 +34,9 @@ public class CheckoutClientConfig {
     @Value("${client.checkout.base-path}")
     private String basePath;
 
+    @Value("${wisp-converter.re-tracing.interface.checkout-interaction.enabled}")
+    private Boolean isTracingOfClientOnREEnabled;
+
     @Bean
     @ConfigurationProperties(prefix = "log.client.checkout")
     public RequestResponseLoggingProperties checkoutClientLoggingProperties() {
@@ -44,7 +47,7 @@ public RequestResponseLoggingProperties checkoutClientLoggingProperties() {
     public it.gov.pagopa.gen.wispconverter.client.checkout.invoker.ApiClient checkoutClient() {
         RequestResponseLoggingProperties clientLoggingProperties = checkoutClientLoggingProperties();
 
-        CheckoutClientLoggingInterceptor clientLogging = new CheckoutClientLoggingInterceptor(clientLoggingProperties, reService);
+        CheckoutClientLoggingInterceptor clientLogging = new CheckoutClientLoggingInterceptor(clientLoggingProperties, reService, isTracingOfClientOnREEnabled);
 
         RestTemplate restTemplate = restTemplate();
 

src/main/java/it/gov/pagopa/wispconverter/config/client/DecouplerCachingClientConfig.java

@@ -38,6 +38,9 @@ public class DecouplerCachingClientConfig {
     @Value("${client.decoupler-caching.api-key}")
     private String apiKey;
 
+    @Value("${wisp-converter.re-tracing.interface.decoupler-caching.enabled}")
+    private Boolean isTracingOfClientOnREEnabled;
+
 
     @Bean
     @ConfigurationProperties(prefix = "log.client.decoupler-caching")
@@ -49,7 +52,7 @@ public RequestResponseLoggingProperties decouplerCachingClientLoggingProperties(
     public it.gov.pagopa.gen.wispconverter.client.decouplercaching.invoker.ApiClient decouplerCachingClient() {
         RequestResponseLoggingProperties clientLoggingProperties = decouplerCachingClientLoggingProperties();
 
-        DecouplerCachingClientLoggingInterceptor clientLogging = new DecouplerCachingClientLoggingInterceptor(clientLoggingProperties, reService);
+        DecouplerCachingClientLoggingInterceptor clientLogging = new DecouplerCachingClientLoggingInterceptor(clientLoggingProperties, reService, isTracingOfClientOnREEnabled);
 
         RestTemplate restTemplate = restTemplate();
 

src/main/java/it/gov/pagopa/wispconverter/config/client/GpdClientConfig.java

@@ -50,6 +50,8 @@ public class GpdClientConfig {
     @Value("${client.gpd.api-key}")
     private String apiKey;
 
+    @Value("${wisp-converter.re-tracing.interface.payment-position-analysis.enabled}")
+    private Boolean isTracingOfClientOnREEnabled;
 
     @Bean
     @ConfigurationProperties(prefix = "log.client.gpd")
@@ -61,7 +63,7 @@ public RequestResponseLoggingProperties gpdClientLoggingProperties() {
     public it.gov.pagopa.gen.wispconverter.client.gpd.invoker.ApiClient gpdClient() {
         RequestResponseLoggingProperties clientLoggingProperties = gpdClientLoggingProperties();
 
-        GpdClientLoggingInterceptor clientLogging = new GpdClientLoggingInterceptor(clientLoggingProperties, reService);
+        GpdClientLoggingInterceptor clientLogging = new GpdClientLoggingInterceptor(clientLoggingProperties, reService, isTracingOfClientOnREEnabled);
 
         RestTemplate restTemplate = restTemplate();
 

src/main/java/it/gov/pagopa/wispconverter/config/client/IuvGeneratorClientConfig.java

@@ -38,6 +38,8 @@ public class IuvGeneratorClientConfig {
     @Value("${client.iuvgenerator.api-key}")
     private String apiKey;
 
+    @Value("${wisp-converter.re-tracing.interface.iuv-generator.enabled}")
+    private Boolean isTracingOfClientOnREEnabled;
 
     @Bean
     @ConfigurationProperties(prefix = "log.client.iuvgenerator")
@@ -50,7 +52,7 @@ public RequestResponseLoggingProperties iuvGeneratorClientLoggingProperties() {
     public it.gov.pagopa.gen.wispconverter.client.iuvgenerator.invoker.ApiClient iuvGeneratorClient() {
         RequestResponseLoggingProperties clientLoggingProperties = iuvGeneratorClientLoggingProperties();
 
-        IuvGeneratorClientLoggingInterceptor clientLogging = new IuvGeneratorClientLoggingInterceptor(clientLoggingProperties, reService);
+        IuvGeneratorClientLoggingInterceptor clientLogging = new IuvGeneratorClientLoggingInterceptor(clientLoggingProperties, reService, isTracingOfClientOnREEnabled);
 
         RestTemplate restTemplate = restTemplate();
 

src/main/java/it/gov/pagopa/wispconverter/controller/RedirectController.java

@@ -53,13 +53,16 @@ public String redirect(@Parameter(description = "", example = "identificativoInt
                            @RequestParam("sessionId") String sessionId,
                            HttpServletResponse response) {
         try {
+            log.info("Invoking API operation redirect - args: {}", sessionId.matches("[\\w\\-]*") ? sessionId : "...");
             String redirectURI = converterService.convert(sessionId);
+            log.info("Successful API operation redirect - result: {}", redirectURI);
             return "redirect:" + redirectURI;
         } catch (AppException appException) {
             ErrorResponse errorResponse = errorUtil.forAppException(appException);
             ProblemDetail problemDetail = errorResponse.updateAndGetBody(this.messageSource, LocaleContextHolder.getLocale());
             errorUtil.finalizeError(problemDetail, errorResponse.getStatusCode().value());
             response.setStatus(200);
+            log.error("Failed API operation redirect - error: {}", errorResponse);
             return "error";
         } catch (Exception ex) {
             String operationId = MDC.get(Constants.MDC_OPERATION_ID);
@@ -70,6 +73,7 @@ public String redirect(@Parameter(description = "", example = "identificativoInt
             ProblemDetail problemDetail = errorResponse.updateAndGetBody(this.messageSource, LocaleContextHolder.getLocale());
             errorUtil.finalizeError(problemDetail, errorResponse.getStatusCode().value());
             response.setStatus(200);
+            log.error("Failed API operation redirect - error: {}", errorResponse);
             return "error";
         }
     }