feat(connector): add JSON based statistic logger

4 files changed, 271 insertions, 0 deletions

diff --git a/basicConfig/ms-connector/logback_config.xml b/basicConfig/ms-connector/logback_config.xml
index a6a2738f..5f0b80f7 100644
--- a/basicConfig/ms-connector/logback_config.xml
+++ b/basicConfig/ms-connector/logback_config.xml
@@ -52,6 +52,21 @@
     </triggeringPolicy>
   </appender>
 
+  <appender name="statisticJson" class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <!--See also http://logback.qos.ch/manual/appenders.html#RollingFileAppender-->
+    <File>${catalina.base}/logs/eidas-ms-statistic-json.log</File>
+    <encoder>
+      <pattern>%m%n</pattern>
+    </encoder>
+    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+      <maxIndex>9999</maxIndex>
+      <FileNamePattern>${catalina.base}/logs/eidas-ms-statistic-json.log.%i</FileNamePattern>
+    </rollingPolicy>
+    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+      <MaxFileSize>10000KB</MaxFileSize>
+    </triggeringPolicy>
+  </appender>
+
   <appender name="stdout" class="ch.qos.logback.core.rolling.RollingFileAppender">
     <!--See also http://logback.qos.ch/manual/appenders.html#RollingFileAppender-->
     <File>${catalina.base}/logs/console.log</File>
@@ -72,6 +87,9 @@
   <logger name="at.asitplus.eidas.specific.core.logger.StatisticLogger" additivity="false" level="info">
     <appender-ref ref="statistic"/>
   </logger>
+  <logger name="at.asitplus.eidas.specific.core.logger.AdvancedStatisicLogger" additivity="false" level="info">
+    <appender-ref ref="statisticJson"/>
+  </logger>    
   <logger name="at.asitplus.eidas.specific.core.logger.RevisionLogger" level="info">
     <appender-ref ref="reversion"/>
   </logger>
diff --git a/modules/core_common_webapp/pom.xml b/modules/core_common_webapp/pom.xml
index 1b11ad66..c8e9fe6d 100644
--- a/modules/core_common_webapp/pom.xml
+++ b/modules/core_common_webapp/pom.xml
@@ -40,6 +40,14 @@
       <groupId>org.thymeleaf</groupId>
       <artifactId>thymeleaf-spring5</artifactId>
     </dependency>    
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.datatype</groupId>
+      <artifactId>jackson-datatype-jsr310</artifactId>
+    </dependency>    
     
     <dependency>
       <groupId>javax.servlet</groupId>
diff --git a/ms_specific_connector/src/main/java/at/asitplus/eidas/specific/core/logger/AdvancedStatisicLogger.java b/ms_specific_connector/src/main/java/at/asitplus/eidas/specific/core/logger/AdvancedStatisicLogger.java
new file mode 100644
index 00000000..f3c43579
--- /dev/null
+++ b/ms_specific_connector/src/main/java/at/asitplus/eidas/specific/core/logger/AdvancedStatisicLogger.java
@@ -0,0 +1,178 @@
+package at.asitplus.eidas.specific.core.logger;
+
+import java.time.LocalDateTime;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
+import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
+
+import at.asitplus.eidas.specific.core.MsEidasNodeConstants;
+import at.gv.egiz.eaaf.core.api.IRequest;
+import at.gv.egiz.eaaf.core.api.IStatusMessenger;
+import at.gv.egiz.eaaf.core.api.idp.IAuthData;
+import at.gv.egiz.eaaf.core.api.logging.IStatisticLogger;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * Extended statistic logger that use a JSON based data model.
+ * 
+ * @author tlenz
+ *
+ */
+@Slf4j
+public class AdvancedStatisicLogger implements IStatisticLogger {
+
+  private static final String DATEFORMATER = "yyyy.MM.dd-HH:mm:ss+z";
+  private static final String DEFAULT_NO_IDP_ID = "no idpId available";
+  private static final String DEFAULT_NO_SP_ID = "no appId available";
+  
+  private static final ObjectMapper mapper = new ObjectMapper();
+  
+  private final IStatusMessenger messageService;
+  
+  /**
+   * Build a JSON based statistic logger that uses error messages from a specific source.
+   * 
+   * @param source i18n message source
+   */
+  public AdvancedStatisicLogger(IStatusMessenger source) {
+    this.messageService = source;
+    
+  }
+
+  @Override
+  public void logSuccessOperation(IRequest protocolRequest, IAuthData authData, boolean isSsoSession) {
+    final StatisticLogEntry entry = buildCoreEntry(protocolRequest);
+    entry.setSuccess(SuccessEntry.builder()
+        .spSector(protocolRequest.getServiceProviderConfiguration().getAreaSpecificTargetIdentifier())
+        .citizenCountryCode(authData.getCiticenCountryCode())
+        .matchingMethod(extractMatchingState(protocolRequest.getRawData(MsEidasNodeConstants.DATA_MATCHING_STATE)))
+        .build());    
+    writeEntryToLog(entry);
+    
+  }
+
+  @Override
+  public void logErrorOperation(Throwable throwable) {
+    log.trace("Advanced statistic logger only logs on SP level");
+
+  }
+
+  @Override
+  public void logErrorOperation(Throwable throwable, IRequest errorRequest) {        
+    final StatisticLogEntry entry = buildCoreEntry(errorRequest);                  
+    entry.setError(new ErrorEntry(messageService.getResponseErrorCode(throwable), throwable.getMessage()));
+    writeEntryToLog(entry);
+
+  }
+
+  @Override
+  public void internalTesting() throws Exception {
+    log.trace("Not implemented for a File-based logger");
+
+  }
+
+  private StatisticLogEntry buildCoreEntry(IRequest errorRequest) {
+    Object appId = errorRequest.getRawData(MsEidasNodeConstants.DATA_REQUESTERID);
+    return new StatisticLogEntry(
+        LocalDateTime.now(),
+        errorRequest.getUniqueTransactionIdentifier(),
+        errorRequest.getServiceProviderConfiguration() != null 
+            && errorRequest.getServiceProviderConfiguration().getUniqueIdentifier() != null 
+          ? errorRequest.getServiceProviderConfiguration().getUniqueIdentifier() : DEFAULT_NO_IDP_ID,
+        appId instanceof String && StringUtils.isNotEmpty((String)appId)
+            ? (String)appId : DEFAULT_NO_SP_ID);  
+    
+  }
+  
+  private String extractMatchingState(Object state) {
+    return state != null ? state.toString() : MsEidasNodeConstants.MatchingStates.NO_REQUIRED.toString();
+    
+  }
+  
+  private void writeEntryToLog(StatisticLogEntry entry) {
+    try {
+      log.info(mapper.writeValueAsString(entry));
+
+    } catch (final JsonProcessingException e) {
+      log.error("Can NOT generate statistic entry for logging", e);
+
+    }
+  }
+  
+  
+  @Getter
+  @Setter
+  @RequiredArgsConstructor
+  @JsonInclude(Include.NON_NULL)
+  private static class StatisticLogEntry {
+
+    @JsonSerialize(using = LocalDateTimeSerializer.class)
+    @JsonDeserialize(using = LocalDateTimeDeserializer.class)
+    @JsonFormat(pattern = DATEFORMATER)
+    @JsonProperty("timestamp")
+    private final LocalDateTime timestamp;
+    
+    @JsonProperty("txId")
+    private final String transactionId;
+    
+    @JsonProperty("entityid")
+    private final String idpEntityId;
+    
+    @JsonProperty("unique-sp-id")
+    private final String uniqueId;
+
+    @JsonProperty("success")
+    private SuccessEntry success;
+
+    @JsonProperty("error")
+    private ErrorEntry error;
+
+  }
+
+  @Getter
+  @Setter
+  @Builder
+  @RequiredArgsConstructor
+  @JsonInclude(Include.NON_NULL)
+  private static class SuccessEntry {
+
+    @JsonProperty("spSector")
+    private final String spSector;
+    
+    @JsonProperty("ccc")
+    private final String citizenCountryCode;
+    
+    @JsonProperty("finalMatchingMethod")
+    private final String matchingMethod;
+
+        
+  }
+
+  @Getter
+  @Setter
+  @RequiredArgsConstructor
+  private static class ErrorEntry {
+
+    @JsonProperty("code")
+    private final String errorCode;
+    
+    @JsonProperty("msg")
+    private final String errorMessage;
+
+  }
+
+}
diff --git a/ms_specific_connector/src/main/java/at/asitplus/eidas/specific/core/logger/MultipleStatisticLogger.java b/ms_specific_connector/src/main/java/at/asitplus/eidas/specific/core/logger/MultipleStatisticLogger.java
new file mode 100644
index 00000000..008a5691
--- /dev/null
+++ b/ms_specific_connector/src/main/java/at/asitplus/eidas/specific/core/logger/MultipleStatisticLogger.java
@@ -0,0 +1,67 @@
+package at.asitplus.eidas.specific.core.logger;
+
+import java.util.Collections;
+import java.util.Set;
+
+import org.springframework.beans.factory.annotation.Autowired;
+
+import com.google.common.collect.Sets;
+
+import at.gv.egiz.eaaf.core.api.IRequest;
+import at.gv.egiz.eaaf.core.api.IStatusMessenger;
+import at.gv.egiz.eaaf.core.api.idp.IAuthData;
+import at.gv.egiz.eaaf.core.api.logging.IStatisticLogger;
+
+/**
+ * {@link IStatisticLogger} implementation that can log into more than one internal {@link IStatisticLogger}.
+ * 
+ * @author tlenz
+ *
+ */
+public class MultipleStatisticLogger implements IStatisticLogger {
+
+  private final Set<IStatisticLogger> internalLoggers;
+  
+  /**
+   * Build a statistic logger that logs into {@link StatisticLogger} and {@link AdvancedStatisicLogger}.
+   * 
+   * @param messageService i18n message-source implementation.
+   */
+  public MultipleStatisticLogger(@Autowired IStatusMessenger messageService) {
+    internalLoggers = Collections.unmodifiableSet(
+        Sets.newHashSet(
+            new StatisticLogger(), 
+            new AdvancedStatisicLogger(messageService)));
+    
+  }
+  
+   
+  
+  @Override
+  public void logSuccessOperation(IRequest protocolRequest, IAuthData authData, boolean isSsoSession) {
+    internalLoggers.parallelStream()
+        .forEach(el -> el.logSuccessOperation(protocolRequest, authData, isSsoSession));
+
+  }
+
+  @Override
+  public void logErrorOperation(Throwable throwable) {
+    internalLoggers.parallelStream().forEach(el -> el.logErrorOperation(throwable));
+
+  }
+
+  @Override
+  public void logErrorOperation(Throwable throwable, IRequest errorRequest) {
+    internalLoggers.parallelStream().forEach(el -> el.logErrorOperation(throwable, errorRequest));
+
+  }
+
+  @Override
+  public void internalTesting() throws Exception {
+    for (IStatisticLogger el : internalLoggers) {
+      el.internalTesting();
+      
+    }
+  }
+
+}