Added dashboard and otel viewing commands

ai-cli.sln

@@ -41,6 +41,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Telemetry", "Telemetry", "{
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "inference_extension", "src\extensions\inference_extension\inference_extension.csproj", "{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "otel_viewer_extension", "src\extensions\otel_viewer_extension\otel_viewer_extension.csproj", "{B153ED12-2028-49A9-AD7F-9D67DA0ECA32}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -183,18 +185,6 @@ Global
 		{306A3CD6-91C2-450B-9995-79701CE63FE2}.Release|x64.Build.0 = Release|Any CPU
 		{306A3CD6-91C2-450B-9995-79701CE63FE2}.Release|x86.ActiveCfg = Release|Any CPU
 		{306A3CD6-91C2-450B-9995-79701CE63FE2}.Release|x86.Build.0 = Release|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Debug|x64.Build.0 = Debug|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Debug|x86.Build.0 = Debug|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Release|Any CPU.Build.0 = Release|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Release|x64.ActiveCfg = Release|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Release|x64.Build.0 = Release|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Release|x86.ActiveCfg = Release|Any CPU
-		{7BF26AB6-8931-46CB-A330-D83DF55AB4E8}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

src/ai/.x/help/chat.assistant.trace.get

@@ -0,0 +1,23 @@
+CHAT ASSISTANT GET
+
+  The `ai chat assistant trace get` command retrieves the trace data from a specific request.
+
+USAGE: ai chat assistant trace get [...]
+
+  GET
+    --request-id ID                          
+    --request-id ID --output-file FILEPATH   
+    --request-id ID --dashboard true         (Note: dashboard must be running to use this option)
+
+EXAMPLE
+
+  ai chat assistant get trace --request-id 25abac2c-9949-481f-83dd-db06d2993e85
+
+  ai tool dashboard start
+  ai chat assistant get trace --request-id 25abac2c-9949-481f-83dd-db06d2993e85 --dashboard true
+
+SEE ALSO
+
+  ai help chat examples
+  ai help chat assistant examples
+  ai help find topics chat assistant

src/ai/.x/help/tool.dashboard

@@ -0,0 +1,11 @@
+TOOL DASHBOARD
+
+  The 'ai tool dashboard' command controls the .NET Aspire Dashboard docker container.
+  NOTE: Make sure Docker is running prior to using the command.
+
+USAGE: ai tool dashboard start
+       ai chat dashboard stop
+
+SEE ALSO
+
+  ai help chat assistant get trace 

src/ai/ai-cli.csproj

@@ -131,11 +131,12 @@
     <ProjectReference Include="..\extensions\helper_functions_extension\helper_functions_extension.csproj" />
     <ProjectReference Include="..\extensions\inference_extension\inference_extension.csproj" />
     <ProjectReference Include="..\extensions\speech_extension\speech-extension.csproj" />
+    <ProjectReference Include="..\extensions\otel_viewer_extension\otel_viewer_extension.csproj" />
     <ProjectReference Include="..\extensions\template_extension\template_extension.csproj" />
     <ProjectReference Include="..\extensions\testframework\YamlTestFramework.csproj" />
     <ProjectReference Include="..\telemetry\aria\telemetry.aria.csproj" />
   </ItemGroup>
 
   <Import Project="BuildCommon.targets" />
 
-</Project>
+</Project>

src/ai/commands/chat_command.cs

@@ -27,6 +27,7 @@
 using OpenAI.Assistants;
 using OpenAI.Files;
 using OpenAI.VectorStores;
+using Azure.AI.Details.Common.CLI.Extensions.Otel;
 using System.ClientModel.Primitives;
 
 #pragma warning disable AOAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
@@ -94,6 +95,8 @@ private void DoCommand(string command)
                 case "chat.assistant.file.list": DoChatAssistantFileList().Wait(); break;
                 case "chat.assistant.file.delete": DoChatAssistantFileDelete().Wait(); break;
 
+                case "chat.assistant.trace.get": DoChatAssistantTraceGet().Wait(); break;
+
                 default:
                     _values.AddThrowError("WARNING:", $"'{command.Replace('.', ' ')}' NOT YET IMPLEMENTED!!");
                     break;
@@ -737,6 +740,20 @@ private OpenAIClient CreateOpenAIClient(out string deployment)
             var region = _values["service.config.region"];
             var endpoint = ConfigEndpointUriToken.Data().GetOrDefault(_values);
             var tokenValue = _values["service.config.token.value"];
+
+            var filepathOutput = _values.GetOrDefault("chat.output.request.id", "");
+            var filepathAdd = _values.GetOrDefault("chat.output.add.request.id", "");
+            bool outputId = !string.IsNullOrEmpty(filepathOutput);
+            bool addId = !string.IsNullOrEmpty(filepathAdd);
+            var filepath = "";
+            if (outputId)
+            {
+                filepath = filepathOutput;
+            }
+            else if (addId)
+            {
+                filepath = filepathAdd;
+            }
 
             deployment = ConfigDeploymentToken.Data().GetOrDefault(_values);
 
@@ -757,6 +774,11 @@ private OpenAIClient CreateOpenAIClient(out string deployment)
             {
                 AzureOpenAIClientOptions options = new();
                 options.AddPolicy(new LogTrafficEventPolicy(), PipelinePosition.PerCall);
+
+                if (outputId || addId)
+                {
+                    options.AddPolicy(new GetRequestIdLogTrafficEventPolicy(filepath, outputId, addId), PipelinePosition.PerCall);
+                }
 
                 return new AzureOpenAIClient(
                     new Uri(endpoint!),
@@ -1621,6 +1643,28 @@ private async Task<bool> DoChatAssistantFileDelete()
             if (!_quiet) Console.WriteLine($"{message} Done!");
             return true;
         }
+
+        private async Task<bool> DoChatAssistantTraceGet() 
+        {
+            var requestId = _values["chat.trace.request.id"];
+            var dashboard = _values.GetOrDefault("chat.trace.dashboard", false);
+            var filePath = _values.GetOrDefault("chat.trace.output.file", "");
+
+            if (string.IsNullOrEmpty(requestId))
+            {
+                _values.AddThrowError("ERROR:", $"Retrieving trace; requires request id.");
+            }
+            Console.WriteLine("Attempting to fetch trace data...");
+            var data = await OtelData.GetTrace(requestId);
+            Console.WriteLine(data);
+            if (!string.IsNullOrEmpty(filePath)) {
+                await OtelData.WriteDataToFile(data, filePath);
+            }
+            if (dashboard) {
+                await OtelData.ExportToDashboard(data);
+            }
+            return true;
+        }
 
         private List<string> ExpandFindFiles(List<string> files)
         {

src/ai/commands/parsers/chat_command_parser.cs

@@ -40,6 +40,9 @@ private static readonly (string name, bool valuesRequired)[] _commands =  {
             ("chat.assistant.file.list", false),
             ("chat.assistant.file", true),
 
+            ("chat.assistant.trace", true),
+            ("chat.assistant.trace.get", true),
+
             ("chat.assistant", true),
             ("chat", true),
         };
@@ -71,6 +74,7 @@ private static IEnumerable<INamedValueTokenParser> GetCommandParsers(ICommandVal
                 case "chat.assistant.file.upload": return _chatAssistantFileUploadCommandParsers;
                 case "chat.assistant.file.delete": return _chatAssistantFileDeleteCommandParsers;
                 case "chat.assistant.file.list": return _chatAssistantFileListCommandParsers;
+                case "chat.assistant.trace.get": return _chatAssistantTraceGetCommandParsers;
             }
 
             foreach (var command in _commands)
@@ -162,6 +166,9 @@ public CommonChatNamedValueTokenParsers() : base(
 
             new OutputFileNameNamedValueTokenParser(null, "chat.output.thread.id", "0111", "chat.assistant.thread.output.id"),
             new OutputFileNameNamedValueTokenParser(null, "chat.output.add.thread.id", "01111", "chat.assistant.thread.output.add.id"),
+
+            new OutputFileNameNamedValueTokenParser(null, "chat.output.request.id", "0111"),
+            new OutputFileNameNamedValueTokenParser(null, "chat.output.add.request.id", "01111"),
         };
 
         private static INamedValueTokenParser[] _chatAssistantCreateCommandParsers = {
@@ -287,6 +294,12 @@ public CommonChatNamedValueTokenParsers() : base(
             new CommonChatNamedValueTokenParsers(),
             new Any1ValueNamedValueTokenParser(null, "chat.assistant.file.id", "0001"),
         };
+        private static INamedValueTokenParser[] _chatAssistantTraceGetCommandParsers = {
+            new CommonChatNamedValueTokenParsers(),
+            new Any1ValueNamedValueTokenParser(null, "chat.trace.request.id", "0011;0101"),
+            new Any1ValueNamedValueTokenParser(null, "chat.trace.output.file", "0001"),
+            new TrueFalseNamedValueTokenParser("chat.trace.dashboard", "001"),
+        };
 
         #endregion
     }

src/ai/commands/parsers/tool_command_parser.cs

@@ -20,18 +20,23 @@ public static bool ParseCommandValues(INamedValueTokens tokens, ICommandValues v
         {
             return ParseCommandValues("tool", GetCommandParsers(values), tokens, values);
         }
-
+        
         private static readonly (string name, bool valuesRequired)[] _commands =  {
-            ("tool", true)
+            ("tool.dashboard.start", false),
+            ("tool.dashboard.stop", false),
+            ("tool.dashboard", false),
+            ("tool", true),
+
         };
-
+        
         private static readonly string[] _partialCommands = {
             "tool"
         };
 
         private static IEnumerable<INamedValueTokenParser> GetCommandParsers(ICommandValues values)
         {
             var commandName = values.GetCommand();
+
             foreach (var command in _commands)
             {
                 if (commandName == command.name)
@@ -73,6 +78,7 @@ public CommonToolNamedValueTokenParsers() : base(
 
         };
 
+
         #endregion
     }
 }

src/ai/commands/tool_command.cs

@@ -15,7 +15,7 @@
 using System.Text.Json.Serialization;
 using System.Threading;
 using System.Threading.Tasks;
-
+using Azure.AI.Details.Common.CLI.Extensions.Otel;
 namespace Azure.AI.Details.Common.CLI
 {
     public class ToolCommand : Command
@@ -41,6 +41,15 @@ internal bool RunCommand()
 
             return _values.GetOrDefault("passed", true);
         }
+        private void StartDashboard() 
+        {
+            Dashboard.StartDashboard();
+        }
+
+        private void StopDashboard() 
+        {
+            Dashboard.StopDashboard();
+        }
 
         private bool RunToolCommand()
         {
@@ -54,6 +63,8 @@ private void DoCommand(string command)
 
             switch (command)
             {
+                case "tool.dashboard.start": StartDashboard(); break;
+                case "tool.dashboard.stop": StopDashboard(); break;
                 default:
                     _values.AddThrowError("WARNING:", $"'{command.Replace('.', ' ')}' NOT YET IMPLEMENTED!!");
                     break;

src/ai/helpers/openai/GetRequestIdLogTrafficEventPolicy.cs

@@ -0,0 +1,54 @@
+using System;
+using System.ClientModel.Primitives;
+using System.IO;
+using System.Text;
+
+namespace Azure.AI.Details.Common.CLI;
+
+public class GetRequestIdLogTrafficEventPolicy : TrafficEventPolicy
+{
+    public GetRequestIdLogTrafficEventPolicy(string filepath, bool outputId, bool addId)
+    {
+        OnRequest += (sender, request) => LogRequest(request);
+        OnResponse += (sender, response) => LogResponse(response, filepath, outputId, addId);
+    }
+
+    private static void LogRequest(PipelineRequest request)
+    {
+    }
+
+    private static void LogResponse(PipelineResponse response, string filepath, bool outputId, bool addId)
+    {
+        string apimRequestId = null;
+        foreach ((string headerName, string headerValue) in response.Headers)
+        {
+            if (headerName.Equals("apim-request-id", StringComparison.OrdinalIgnoreCase))
+            {
+                apimRequestId = headerValue;
+                break;
+            }
+        }
+         if (!string.IsNullOrWhiteSpace(apimRequestId))
+        {
+            // Determine the write mode: append or overwrite
+            FileMode mode = addId ? FileMode.Append : FileMode.Create;
+
+            try
+            {
+                using (FileStream fs = new FileStream(filepath, mode))
+                using (StreamWriter writer = new StreamWriter(fs))
+                {
+                    writer.WriteLine(apimRequestId);
+                }
+            }
+            catch (Exception ex)
+            {
+                AI.TRACE_ERROR($"Failed to write Request ID to file: {ex.Message}");
+            }
+        }
+        else
+        {
+            AI.TRACE_WARNING("APIM Request ID not found in response headers.");
+        }
+    }
+}

src/common/details/commands/parsers/command_parser.cs

@@ -35,7 +35,7 @@ public static bool DispatchParseCommand(INamedValueTokens tokens, ICommandValues
 
             var parsed = Program.DispatchParseCommand(tokens, values);
             if (parsed || values.DisplayHelpRequested()) return parsed;
-
+            
             switch (command.Split('.')[0])
             {
                 case "-?":

src/extensions/otel_viewer_extension/AnyValueConverter.cs

@@ -0,0 +1,52 @@
+using Newtonsoft.Json.Linq;
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using OpenTelemetry.Proto.Common.V1;
+using Azure.AI.Details.Common.CLI;
+
+namespace Azure.AI.Details.Common.CLI.Extensions.Otel
+{
+    public class AnyValueConverter : JsonConverter
+    {
+        public override bool CanConvert(Type objectType)
+        {
+            return objectType == typeof(AnyValue);
+        }
+
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            JObject item = JObject.Load(reader);
+            var anyValue = new AnyValue();
+
+            // Check and set the string value
+            if (item["hasStringValue"]?.Value<bool>() == true)
+            {
+                anyValue.StringValue = item["stringValue"]?.Value<string>();
+            }
+            if (item["hasBoolValue"]?.Value<bool>() == true)
+            {
+                anyValue.BoolValue = (bool)item["boolValue"]?.Value<bool>();
+            }
+            if (item["hasIntValue"]?.Value<bool>() == true)
+            {
+                anyValue.IntValue = (int)item["intValue"]?.Value<int>();
+            }
+            if (item["hasDoubleValue"]?.Value<bool>() == true)
+            {
+                anyValue.DoubleValue = (double)item["doubleValue"]?.Value<double>();
+            }
+            return anyValue;
+        }
+
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new NotImplementedException();
+        }
+    }
+
+
+}