Merge pull request #472 from solliancenet/cj-agent-factory-logging

Add logging to Agent Factory
solliancenet · Jan 15, 2024 · cbafd48 · cbafd48
2 parents 2920eb9 + e3a7ec2
commit cbafd48
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 25 deletions.
diff --git a/src/dotnet/AgentFactory/Agents/AgentBase.cs b/src/dotnet/AgentFactory/Agents/AgentBase.cs
@@ -1,17 +1,7 @@
 using FoundationaLLM.AgentFactory.Core.Interfaces;
 using FoundationaLLM.AgentFactory.Core.Models.Messages;
-using FoundationaLLM.AgentFactory.Core.Models.Orchestration.DataSourceConfigurations;
-using FoundationaLLM.AgentFactory.Core.Models.Orchestration.Metadata;
-using FoundationaLLM.AgentFactory.Core.Models.Orchestration;
 using FoundationaLLM.AgentFactory.Interfaces;
-using FoundationaLLM.AgentFactory.Models.Orchestration;
 using FoundationaLLM.Common.Models.Orchestration;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using System.Runtime.CompilerServices;
 
 namespace FoundationaLLM.AgentFactory.Core.Agents
 {
@@ -63,10 +53,8 @@ public AgentBase(
         /// This will setup the agent based on its metadata.
         /// </summary>
         /// <returns></returns>
-        public virtual async Task Configure(string userPrompt, string sessionId)
-        {
+        public virtual async Task Configure(string userPrompt, string sessionId) =>
             await Task.CompletedTask;
-        }
 
         /// <summary>
         /// The call to execute a completion after the agent is configured.

diff --git a/src/dotnet/AgentFactory/Agents/AgentBuilder.cs b/src/dotnet/AgentFactory/Agents/AgentBuilder.cs
@@ -4,6 +4,7 @@
 using FoundationaLLM.AgentFactory.Models.Orchestration;
 using FoundationaLLM.Common.Interfaces;
 using FoundationaLLM.Common.Models.Cache;
+using Microsoft.Extensions.Logging;
 
 namespace FoundationaLLM.AgentFactory.Core.Agents
 {
@@ -23,6 +24,7 @@ public class AgentBuilder
         /// <param name="orchestrationServices"></param>
         /// <param name="promptHubAPIService"></param>
         /// <param name="dataSourceHubAPIService"></param>
+        /// <param name="loggerFactory">The logger factory used to create new loggers.</param>
         /// <returns></returns>
         /// <exception cref="ArgumentException"></exception>
         public static async Task<AgentBase> Build(
@@ -33,8 +35,16 @@ public static async Task<AgentBase> Build(
             IAgentHubAPIService agentHubAPIService,
             IEnumerable<ILLMOrchestrationService> orchestrationServices,
             IPromptHubAPIService promptHubAPIService,
-            IDataSourceHubAPIService dataSourceHubAPIService)
+            IDataSourceHubAPIService dataSourceHubAPIService,
+            ILoggerFactory loggerFactory)
         {
+            var logger = loggerFactory.CreateLogger<AgentBuilder>();
+            if (callContext.AgentHint == null)
+                logger.LogInformation("The AgentBuilder is starting to build an agent without an agent hint.");
+            else
+                logger.LogInformation("The AgentBuilder is starting to build an agent with the following agent hint: {AgentName},{IsPrivateAgent}.",
+                    callContext.AgentHint.Name, callContext.AgentHint.Private);
+
             var agentResponse = callContext.AgentHint != null
                 ? await cacheService.Get<AgentHubResponse>(
                     new CacheKey(callContext.AgentHint.Name!, "agent"),
@@ -45,6 +55,9 @@ public static async Task<AgentBase> Build(
 
             var agentInfo = agentResponse!.Agent;
 
+            logger.LogInformation("The AgentBuilder received the following agent from the AgentHub: {AgentName}.",
+                agentResponse.Agent!.Name);
+
             // TODO: Extend the Agent Hub API service response to include the orchestrator
             var orchestrationType = string.IsNullOrWhiteSpace(agentResponse.Agent!.Orchestrator) 
                 ? "LangChain"
@@ -54,13 +67,13 @@ public static async Task<AgentBase> Build(
             if (!validType)
                 throw new ArgumentException($"The agent factory does not support the {orchestrationType} orchestration type.");
             var orchestrationService = SelectOrchestrationService(llmOrchestrationType, orchestrationServices);
-
 
             AgentBase? agent = null;
             agent = new DefaultAgent(
                 agentInfo!,
                 cacheService, callContext,
-                orchestrationService, promptHubAPIService, dataSourceHubAPIService);           
+                orchestrationService, promptHubAPIService, dataSourceHubAPIService,
+                loggerFactory.CreateLogger<DefaultAgent>());           
 
             await agent.Configure(userPrompt, sessionId);
 

diff --git a/src/dotnet/AgentFactory/Agents/DefaultAgent.cs b/src/dotnet/AgentFactory/Agents/DefaultAgent.cs
@@ -9,6 +9,7 @@
 using FoundationaLLM.AgentFactory.Core.Services;
 using FoundationaLLM.Common.Models.Cache;
 using FoundationaLLM.Common.Models.Context;
+using Microsoft.Extensions.Logging;
 
 namespace FoundationaLLM.AgentFactory.Core.Agents
 {
@@ -20,6 +21,7 @@ public class DefaultAgent : AgentBase
         private LLMOrchestrationCompletionRequest _completionRequestTemplate = null!;
         private readonly ICacheService _cacheService;
         private readonly ICallContext _callContext;
+        private readonly ILogger<DefaultAgent> _logger;
 
         /// <summary>
         /// Constructor for default agent.
@@ -30,17 +32,20 @@ public class DefaultAgent : AgentBase
         /// <param name="orchestrationService"></param>
         /// <param name="promptHubService"></param>
         /// <param name="dataSourceHubService"></param>
+        /// <param name="logger">The logger used for logging.</param>
         public DefaultAgent(
             AgentMetadata agentMetadata,
             ICacheService cacheService,
             ICallContext callContext,
             ILLMOrchestrationService orchestrationService,
             IPromptHubAPIService promptHubService,
-            IDataSourceHubAPIService dataSourceHubService)
+            IDataSourceHubAPIService dataSourceHubService,
+            ILogger<DefaultAgent> logger)
             : base(agentMetadata, orchestrationService, promptHubService, dataSourceHubService)
         {
             _cacheService = cacheService;
             _callContext = callContext;
+            _logger = logger;
         }
 
         /// <summary>
@@ -69,6 +74,9 @@ public override async Task Configure(string userPrompt, string sessionId)
                     sessionId
                   );
 
+            _logger.LogInformation("The DefaultAgent received the following prompt from the Prompt Hub: {PromptName}.",
+                promptResponse!.Prompt!.Name);
+
             // Get data sources listed for the agent.
             var dataSourceResponse = _callContext.AgentHint != null
                 ? await _cacheService.Get<DataSourceHubResponse>(
@@ -78,6 +86,9 @@ public override async Task Configure(string userPrompt, string sessionId)
                     TimeSpan.FromHours(1))
                 : await _dataSourceHubService.ResolveRequest(_agentMetadata.AllowedDataSourceNames!, sessionId);
 
+            _logger.LogInformation("The DefaultAgent received the following data sources from the Data Source Hub: {DataSourceList}.",
+                string.Join(",", dataSourceResponse!.DataSources!.Select(ds => ds.Name)));
+
             List<MetadataBase> dataSourceMetadata = new List<MetadataBase>();
 
             var dataSources = dataSourceResponse!.DataSources!;

diff --git a/src/dotnet/AgentFactory/Interfaces/IWarmupService.cs b/src/dotnet/AgentFactory/Interfaces/IWarmupService.cs
@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace FoundationaLLM.AgentFactory.Core.Interfaces
+{
+    /// <summary>
+    /// Defines 
+    /// </summary>
+    public interface IWarmupService
+    {
+    }
+}
diff --git a/src/dotnet/AgentFactory/Services/AgentFactoryService.cs b/src/dotnet/AgentFactory/Services/AgentFactoryService.cs
@@ -28,6 +28,7 @@ public class AgentFactoryService : IAgentFactoryService
     private readonly IDataSourceHubAPIService _dataSourceHubAPIService;
 
     private readonly ILogger<AgentFactoryService> _logger;
+    private readonly ILoggerFactory _loggerFactory;
 
     /// <summary>
     /// Constructor for the Agent Factory Service.
@@ -38,15 +39,15 @@ public class AgentFactoryService : IAgentFactoryService
     /// <param name="agentHubService"></param>    
     /// <param name="promptHubService"></param>    
     /// <param name="dataSourceHubService"></param>    
-    /// <param name="logger"></param>
+    /// <param name="loggerFactory">The logger factory used to create loggers.</param>
     public AgentFactoryService(
         IEnumerable<ILLMOrchestrationService> orchestrationServices,
         ICacheService cacheService,
         ICallContext callContext,
         IAgentHubAPIService agentHubService,
         IPromptHubAPIService promptHubService,
         IDataSourceHubAPIService dataSourceHubService,
-        ILogger<AgentFactoryService> logger)
+        ILoggerFactory loggerFactory)
     {
         _orchestrationServices = orchestrationServices;
         _cacheService = cacheService;
@@ -55,7 +56,8 @@ public AgentFactoryService(
         _promptHubAPIService = promptHubService;
         _dataSourceHubAPIService = dataSourceHubService;
 
-        _logger = logger;
+        _loggerFactory = loggerFactory;
+        _logger = _loggerFactory.CreateLogger<AgentFactoryService>();
     }
 
     /// <summary>
@@ -90,7 +92,8 @@ public async Task<CompletionResponse> GetCompletion(CompletionRequest completion
                 _agentHubAPIService,
                 _orchestrationServices,
                 _promptHubAPIService,
-                _dataSourceHubAPIService);
+                _dataSourceHubAPIService,
+                _loggerFactory);
 
             return await agent.GetCompletion(completionRequest);
         }
@@ -123,7 +126,8 @@ public async Task<SummaryResponse> GetSummary(SummaryRequest summaryRequest)
                 _agentHubAPIService,
                 _orchestrationServices,
                 _promptHubAPIService,
-                _dataSourceHubAPIService);
+                _dataSourceHubAPIService,
+                _loggerFactory);
 
             return await agent.GetSummary(summaryRequest);
         }

diff --git a/src/dotnet/AgentFactory/Services/WarmupService.cs b/src/dotnet/AgentFactory/Services/WarmupService.cs
@@ -0,0 +1,19 @@
+using FoundationaLLM.AgentFactory.Core.Interfaces;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace FoundationaLLM.AgentFactory.Core.Services
+{
+    /// <summary>
+    /// Implements warmup capabilities
+    /// </summary>
+    public class WarmupService(
+        IAgentHubAPIService agentHubService,
+        IPromptHubAPIService promptHubService,
+        IDataSourceHubAPIService dataSourceHubService) : IWarmupService
+    {
+    }
+}
diff --git a/src/dotnet/AgentFactoryAPI/Program.cs b/src/dotnet/AgentFactoryAPI/Program.cs
@@ -1,4 +1,3 @@
-using System.Net;
 using Asp.Versioning;
 using Azure.Identity;
 using FoundationaLLM.AgentFactory.Core.Interfaces;
@@ -17,7 +16,6 @@
 using FoundationaLLM.Common.Services;
 using FoundationaLLM.Common.Settings;
 using Microsoft.ApplicationInsights.AspNetCore.Extensions;
-using Microsoft.Extensions.Http.Resilience;
 using Microsoft.Extensions.Options;
 using Polly;
 using Swashbuckle.AspNetCore.SwaggerGen;
@@ -92,6 +90,7 @@ public static void Main(string[] args)
             builder.Services.AddScoped<ILLMOrchestrationService, LangChainService>();
 
             builder.Services.AddSingleton<ICacheService, MemoryCacheService>();
+            builder.Services.ActivateSingleton<ICacheService>();
             builder.Services.AddScoped<IAgentFactoryService, AgentFactoryService>();
             builder.Services.AddScoped<IAgentHubAPIService, AgentHubAPIService>();
             builder.Services.AddScoped<IDataSourceHubAPIService, DataSourceHubAPIService>();
@@ -105,7 +104,6 @@ public static void Main(string[] args)
             // Register the downstream services and HTTP clients.
             RegisterDownstreamServices(builder);
 
-
             builder.Services
                 .AddApiVersioning(options =>
                 {