Merge pull request #135 from AzureAD/sagonzal/serverTelemetryV2

Add server telemetry with v2 schema

Author: sangonzal

src/main/java/com/microsoft/aad/msal4j/AcquireTokenSilentSupplier.java

@@ -57,6 +57,8 @@ AuthenticationResult execute() throws Exception {
         if(res == null || StringHelper.isBlank(res.accessToken())){
             throw new MsalClientException(AuthenticationErrorMessage.NO_TOKEN_IN_CACHE, AuthenticationErrorCode.CACHE_MISS);
         }
+
+        clientApplication.getServiceBundle().getServerSideTelemetry().incrementSilentSuccessfulCount();
         return res;
     }
 }

src/main/java/com/microsoft/aad/msal4j/AuthenticationResultSupplier.java

@@ -68,10 +68,23 @@ public IAuthenticationResult get() {
                 }
             } catch(Exception ex) {
 
+                String error;
                 if (ex instanceof MsalServiceException) {
-                    apiEvent.setApiErrorCode(((MsalServiceException) ex).errorCode());
+                    error = ((MsalServiceException) ex).errorCode();
+                    apiEvent.setApiErrorCode(error);
+                } else {
+                    if(ex.getCause() != null){
+                        error = ex.getCause().toString();
+                    } else {
+                        error = StringHelper.EMPTY_STRING;
+                    }
                 }
 
+                clientApplication.getServiceBundle().getServerSideTelemetry().addFailedRequestTelemetry(
+                        String.valueOf(msalRequest.requestContext().publicApi().getApiId()),
+                        msalRequest.requestContext().correlationId(),
+                        error);
+
                 clientApplication.log.error(
                         LogHelper.createMessage(
                                 "Execution of " + this.getClass() + " failed.",
@@ -83,8 +96,7 @@ public IAuthenticationResult get() {
         return result;
     }
 
-    void logResult(AuthenticationResult result, HttpHeaders headers)
-    {
+    private void logResult(AuthenticationResult result, HttpHeaders headers) {
         if (!StringHelper.isBlank(result.accessToken())) {
 
             String accessTokenHash = this.computeSha256Hash(result

src/main/java/com/microsoft/aad/msal4j/ClientApplicationBase.java

@@ -251,7 +251,7 @@ abstract static class Builder<T extends Builder<T>> {
         private String authority = DEFAULT_AUTHORITY;
         private Authority authenticationAuthority = createDefaultAADAuthority();
         private boolean validateAuthority = true;
-        private String correlationId = UUID.randomUUID().toString();
+        private String correlationId;
         private boolean logPii = false;
         private ExecutorService executorService;
         private Proxy proxy;

src/main/java/com/microsoft/aad/msal4j/CurrentRequest.java

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.aad.msal4j;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+@Getter
+@Accessors(fluent = true)
+class CurrentRequest {
+
+    private final PublicApi publicApi;
+
+    @Setter
+    private boolean forceRefresh = false;
+
+    CurrentRequest(PublicApi publicApi){
+        this.publicApi = publicApi;
+    }
+}

src/main/java/com/microsoft/aad/msal4j/MsalRequest.java

@@ -12,14 +12,25 @@
 @Getter(AccessLevel.PACKAGE)
 @AllArgsConstructor
 abstract class MsalRequest {
-    private final ClientApplicationBase application;
 
     AbstractMsalAuthorizationGrant msalAuthorizationGrant;
 
+    private final ClientApplicationBase application;
+
     private final RequestContext requestContext;
 
     @Getter(value = AccessLevel.PACKAGE, lazy = true)
     private final HttpHeaders headers = new HttpHeaders(requestContext);
-}
 
+    MsalRequest(ClientApplicationBase clientApplicationBase,
+                AbstractMsalAuthorizationGrant abstractMsalAuthorizationGrant,
+                RequestContext requestContext){
+
+        this.application = clientApplicationBase;
+        this.msalAuthorizationGrant = abstractMsalAuthorizationGrant;
+        this.requestContext = requestContext;
 
+        CurrentRequest currentRequest = new CurrentRequest(requestContext.publicApi());
+        application.getServiceBundle().getServerSideTelemetry().setCurrentRequest(currentRequest);
+    }
+}

src/main/java/com/microsoft/aad/msal4j/OAuthHttpRequest.java

@@ -62,6 +62,11 @@ private Map<String, String> configureHttpHeaders(){
         if (this.getAuthorization() != null) {
             httpHeaders.put("Authorization", this.getAuthorization());
         }
+
+        Map<String, String> telemetryHeaders =
+                serviceBundle.getServerSideTelemetry().getServerTelemetryHeaderMap();
+        httpHeaders.putAll(telemetryHeaders);
+
         return httpHeaders;
     }
 

src/main/java/com/microsoft/aad/msal4j/ServerSideTelemetry.java

@@ -0,0 +1,117 @@
+package com.microsoft.aad.msal4j;
+
+import java.lang.reflect.Array;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import java.util.concurrent.atomic.AtomicInteger;
+
+class ServerSideTelemetry {
+
+    private final static String SCHEMA_VERSION = "2";
+    private final static String SCHEMA_PIPE_DELIMITER = "|";
+    private final static String SCHEMA_COMMA_DELIMITER = ",";
+    private final static String CURRENT_REQUEST_HEADER_NAME = "x-client-current-telemetry";
+    private final static String LAST_REQUEST_HEADER_NAME = "x-client-last-telemetry";
+
+    private CurrentRequest currentRequest;
+    private AtomicInteger silentSuccessfulCount = new AtomicInteger(0);
+
+    ConcurrentMap<String, String[]> previousRequests = new ConcurrentHashMap<>();
+    ConcurrentMap<String, String[]> previousRequestInProgress = new ConcurrentHashMap<>();
+
+    synchronized Map<String, String> getServerTelemetryHeaderMap(){
+        Map<String, String> headerMap = new HashMap<>();
+
+        headerMap.put(CURRENT_REQUEST_HEADER_NAME, buildCurrentRequestHeader());
+        headerMap.put(LAST_REQUEST_HEADER_NAME, buildLastRequestHeader());
+
+        return headerMap;
+    }
+
+    void addFailedRequestTelemetry(String publicApiId, String correlationId, String error){
+
+        String[] previousRequest = new String[]{publicApiId, error};
+        previousRequests.put(
+                correlationId,
+                previousRequest);
+    }
+
+    void incrementSilentSuccessfulCount(){
+        silentSuccessfulCount.incrementAndGet();
+    }
+
+    synchronized CurrentRequest getCurrentRequest() {
+        return currentRequest;
+    }
+
+    synchronized void setCurrentRequest(CurrentRequest currentRequest) {
+        this.currentRequest = currentRequest;
+    }
+
+    private synchronized String buildCurrentRequestHeader(){
+        if(currentRequest == null){
+            return StringHelper.EMPTY_STRING;
+        }
+
+        return SCHEMA_VERSION +
+                SCHEMA_PIPE_DELIMITER +
+                currentRequest.publicApi().getApiId() +
+                SCHEMA_COMMA_DELIMITER +
+                currentRequest.forceRefresh() +
+                SCHEMA_PIPE_DELIMITER;
+    }
+
+    private synchronized String buildLastRequestHeader() {
+
+        // LastRequest header schema:
+        // schema_version|silent_successful_count|api_id1,correlation_id1|error1|
+        StringBuilder lastRequestBuilder = new StringBuilder();
+
+        lastRequestBuilder
+                .append(SCHEMA_VERSION)
+                .append(SCHEMA_PIPE_DELIMITER)
+                .append(silentSuccessfulCount.getAndSet(0));
+
+        if (previousRequests.isEmpty()) {
+            // Kusto queries always expect all delimiters so return
+            // "schema_version|silent_successful_count|||"
+            return lastRequestBuilder
+                    .append(SCHEMA_PIPE_DELIMITER)
+                    .append(SCHEMA_PIPE_DELIMITER)
+                    .append(SCHEMA_PIPE_DELIMITER)
+                    .toString();
+        }
+
+        StringBuilder middleSegmentBuilder = new StringBuilder(SCHEMA_PIPE_DELIMITER);
+        StringBuilder errorSegmentBuilder = new StringBuilder(SCHEMA_PIPE_DELIMITER);
+
+        Iterator<String> it = previousRequests.keySet().iterator();
+
+        // Total header size should be less than 8kb. At max, we will use 4kb for telemetry.
+        while (it.hasNext()
+                && (middleSegmentBuilder.length() + errorSegmentBuilder.length()) < 3800) {
+            String correlationId = it.next();
+            String[] previousRequest = previousRequests.get(correlationId);
+            String apiId = (String)Array.get(previousRequest, 0);
+            String error = (String)Array.get(previousRequest, 1);
+
+            middleSegmentBuilder.append(apiId).append(SCHEMA_COMMA_DELIMITER).append(correlationId);
+            errorSegmentBuilder.append(error);
+
+            if(it.hasNext()){
+                middleSegmentBuilder.append(SCHEMA_COMMA_DELIMITER);
+                errorSegmentBuilder.append(SCHEMA_COMMA_DELIMITER);
+            }
+
+            previousRequestInProgress.put(correlationId, previousRequest);
+            it.remove();
+        }
+
+        errorSegmentBuilder.append(SCHEMA_PIPE_DELIMITER);
+
+        return lastRequestBuilder.append(middleSegmentBuilder).append(errorSegmentBuilder).toString();
+    }
+}

src/main/java/com/microsoft/aad/msal4j/ServiceBundle.java

@@ -10,12 +10,15 @@ class ServiceBundle {
     private ExecutorService executorService;
     private TelemetryManager telemetryManager;
     private IHttpClient httpClient;
+    private ServerSideTelemetry serverSideTelemetry;
 
     ServiceBundle(ExecutorService executorService, IHttpClient httpClient,
                   TelemetryManager telemetryManager){
         this.executorService = executorService;
         this.telemetryManager = telemetryManager;
         this.httpClient = httpClient;
+
+        serverSideTelemetry = new ServerSideTelemetry();
     }
 
     ExecutorService getExecutorService() {
@@ -29,4 +32,8 @@ TelemetryManager getTelemetryManager(){
     IHttpClient getHttpClient(){
         return httpClient;
     }
+
+    ServerSideTelemetry getServerSideTelemetry(){
+        return serverSideTelemetry;
+    }
 }

src/main/java/com/microsoft/aad/msal4j/SilentRequest.java

@@ -27,5 +27,8 @@ class SilentRequest extends MsalRequest {
         this.requestAuthority = StringHelper.isBlank(parameters.authorityUrl()) ?
                 application.authenticationAuthority :
                 Authority.createAuthority(new URL(parameters.authorityUrl()));
+
+        application.getServiceBundle().getServerSideTelemetry().getCurrentRequest().forceRefresh(
+                parameters.forceRefresh());
     }
 }

src/main/java/com/microsoft/aad/msal4j/StringHelper.java

@@ -10,6 +10,8 @@
 
 final class StringHelper {
 
+    static String EMPTY_STRING = "";
+
     static boolean isBlank(final String str) {
         return str == null || str.trim().length() == 0;
     }