Send telemetry when it fails to generate token, open conversation, or refresh token

Author: daxian-dbw

shell/agents/Microsoft.Azure.Agent/ChatSession.cs

@@ -87,16 +87,8 @@ internal async Task<string> RefreshAsync(IStatusContext context, bool force, Can
             }
         }
 
-        try
-        {
-            _token = await GenerateTokenAsync(context, cancellationToken);
-            return await StartConversationAsync(context, cancellationToken);
-        }
-        catch (Exception)
-        {
-            Reset();
-            throw;
-        }
+        _token = await GenerateTokenAsync(context, cancellationToken);
+        return await OpenConversationAsync(context, cancellationToken);
     }
 
     private void Reset()
@@ -113,57 +105,83 @@ private void Reset()
 
     private async Task<string> GenerateTokenAsync(IStatusContext context, CancellationToken cancellationToken)
     {
-        context.Status("Get Azure CLI login token ...");
-        // Get an access token from the AzCLI login, using the specific audience guid.
-        AccessToken accessToken = await new AzureCliCredential()
-            .GetTokenAsync(
-                new TokenRequestContext(["7000789f-b583-4714-ab18-aef39213018a/.default"]),
-                cancellationToken);
-
-        context.Status("Request for DirectLine token ...");
-        StringContent content = new("{\"conversationType\": \"Chat\"}", Encoding.UTF8, Utils.JsonContentType);
-        HttpRequestMessage request = new(HttpMethod.Post, DL_TOKEN_URL) { Content = content };
-        request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken.Token);
+        try
+        {
+            context.Status("Get Azure CLI login token ...");
+            // Get an access token from the AzCLI login, using the specific audience guid.
+            AccessToken accessToken = await new AzureCliCredential()
+                .GetTokenAsync(
+                    new TokenRequestContext(["7000789f-b583-4714-ab18-aef39213018a/.default"]),
+                    cancellationToken);
+
+            context.Status("Request for DirectLine token ...");
+            StringContent content = new("{\"conversationType\": \"Chat\"}", Encoding.UTF8, Utils.JsonContentType);
+            HttpRequestMessage request = new(HttpMethod.Post, DL_TOKEN_URL) { Content = content };
+            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken.Token);
+
+            HttpResponseMessage response = await _httpClient.SendAsync(request, cancellationToken);
+            response.EnsureSuccessStatusCode();
 
-        HttpResponseMessage response = await _httpClient.SendAsync(request, cancellationToken);
-        response.EnsureSuccessStatusCode();
+            using Stream stream = await response.Content.ReadAsStreamAsync(cancellationToken);
+            var dlToken = JsonSerializer.Deserialize<DirectLineToken>(stream, Utils.JsonOptions);
+            return dlToken.DirectLine.Token;
+        }
+        catch (Exception e)
+        {
+            if (e is not OperationCanceledException)
+            {
+                Telemetry.Trace(AzTrace.Exception("Failed to generate the initial DL token."), e);
+            }
 
-        using Stream stream = await response.Content.ReadAsStreamAsync(cancellationToken);
-        var dlToken = JsonSerializer.Deserialize<DirectLineToken>(stream, Utils.JsonOptions);
-        return dlToken.DirectLine.Token;
+            Reset();
+            throw;
+        }
     }
 
-    private async Task<string> StartConversationAsync(IStatusContext context, CancellationToken cancellationToken)
+    private async Task<string> OpenConversationAsync(IStatusContext context, CancellationToken cancellationToken)
     {
-        context.Status("Start a new chat session ...");
-        HttpRequestMessage request = new(HttpMethod.Post, CONVERSATION_URL);
-        request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", _token);
+        try
+        {
+            context.Status("Start a new chat session ...");
+            HttpRequestMessage request = new(HttpMethod.Post, CONVERSATION_URL);
+            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", _token);
 
-        HttpResponseMessage response = await _httpClient.SendAsync(request, cancellationToken);
-        response.EnsureSuccessStatusCode();
+            HttpResponseMessage response = await _httpClient.SendAsync(request, cancellationToken);
+            response.EnsureSuccessStatusCode();
 
-        using Stream content = await response.Content.ReadAsStreamAsync(cancellationToken);
-        SessionPayload spl = JsonSerializer.Deserialize<SessionPayload>(content, Utils.JsonOptions);
+            using Stream content = await response.Content.ReadAsStreamAsync(cancellationToken);
+            SessionPayload spl = JsonSerializer.Deserialize<SessionPayload>(content, Utils.JsonOptions);
 
-        _token = spl.Token;
-        _conversationId = spl.ConversationId;
-        _conversationUrl = $"{CONVERSATION_URL}/{_conversationId}/activities";
-        _streamUrl = spl.StreamUrl;
-        _expireOn = DateTime.UtcNow.AddSeconds(spl.ExpiresIn);
-        _copilotReceiver = await AzureCopilotReceiver.CreateAsync(_streamUrl);
+            _token = spl.Token;
+            _conversationId = spl.ConversationId;
+            _conversationUrl = $"{CONVERSATION_URL}/{_conversationId}/activities";
+            _streamUrl = spl.StreamUrl;
+            _expireOn = DateTime.UtcNow.AddSeconds(spl.ExpiresIn);
+            _copilotReceiver = await AzureCopilotReceiver.CreateAsync(_streamUrl);
 
-        Log.Debug("[ChatSession] Conversation started. Id: {0}", _conversationId);
+            Log.Debug("[ChatSession] Conversation started. Id: {0}", _conversationId);
 
-        while (true)
+            while (true)
+            {
+                CopilotActivity activity = _copilotReceiver.Take(cancellationToken);
+                if (activity.IsMessage && activity.IsFromCopilot && _copilotReceiver.Watermark is 0)
+                {
+                    activity.ExtractMetadata(out _, out ConversationState conversationState);
+                    int chatNumber = conversationState.DailyConversationNumber;
+                    int requestNumber = conversationState.TurnNumber;
+                    return $"{activity.Text}\nThis is chat #{chatNumber}, request #{requestNumber}.\n";
+                }
+            }
+        }
+        catch (Exception e)
         {
-            CopilotActivity activity = _copilotReceiver.Take(cancellationToken);
-            if (activity.IsMessage && activity.IsFromCopilot && _copilotReceiver.Watermark is 0)
+            if (e is not OperationCanceledException)
             {
-                activity.ExtractMetadata(out _, out ConversationState conversationState);
-                int chatNumber = conversationState.DailyConversationNumber;
-                int requestNumber = conversationState.TurnNumber;
-                return $"{activity.Text}\nThis is chat #{chatNumber}, request #{requestNumber}.\n";
+                Telemetry.Trace(AzTrace.Exception("Failed to open conversation with the initial DL token."), e);
             }
+
+            Reset();
+            throw;
         }
     }
 
@@ -216,6 +234,7 @@ private async Task RenewTokenAsync(CancellationToken cancellationToken)
         catch (Exception e) when (e is not OperationCanceledException)
         {
             Reset();
+            Telemetry.Trace(AzTrace.Exception("Failed to refresh the DL token."), e);
             throw new TokenRequestException($"Failed to refresh the 'DirectLine' token: {e.Message}.", e);
         }
     }

shell/agents/Microsoft.Azure.Agent/DataRetriever.cs

@@ -586,7 +586,7 @@ private AzCLICommand QueryForMetadata(string azCommand)
                         ["Command"] = azCommand,
                         ["Message"] = "AzCLI metadata service returns unsuccessful status code for query."
                     };
-                    Telemetry.Trace(AzTrace.Exception(response: null, details));
+                    Telemetry.Trace(AzTrace.Exception(details));
                 }
             }
         }
@@ -600,7 +600,7 @@ private AzCLICommand QueryForMetadata(string azCommand)
                     ["Command"] = azCommand,
                     ["Message"] = "AzCLI metadata query and process raised an exception."
                 };
-                Telemetry.Trace(AzTrace.Exception(response: null, details), e);
+                Telemetry.Trace(AzTrace.Exception(details), e);
             }
         }
 

shell/agents/Microsoft.Azure.Agent/Telemetry.cs

@@ -132,6 +132,8 @@ internal static AzTrace Exception(CopilotResponse response, object details)
         // Don't create an object when telemetry is disabled.
         return null;
     }
+
+    internal static AzTrace Exception(object details) => Exception(response: null, details);
 }
 
 internal class Telemetry
@@ -231,7 +233,7 @@ internal static void Initialize()
     internal static void Trace(AzTrace trace) => s_singleton?.LogTelemetry(trace, exception: null);
 
     /// <summary>
-    /// Trace a telemetry metric and an Exception with it.
+    /// Trace a telemetry metric and an exception with it.
     /// The method does nothing when telemetry is disabled.
     /// </summary>
     internal static void Trace(AzTrace trace, Exception exception) => s_singleton?.LogTelemetry(trace, exception);