Allow passing task id when dispaching bgtasks

suraciii · suraciii · commit 99990dcab07d · 2024-07-20T18:58:40.000+08:00
add a sample
improve logs
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -16,7 +16,11 @@
     <PackageVersion Include="OpenTelemetry" Version="$(OtelVersion)" />
     <PackageVersion Include="OpenTelemetry.Exporter.InMemory" Version="$(OtelVersion)" />
     <PackageVersion Include="OpenTelemetry.Exporter.Console" Version="$(OtelVersion)" />
-    <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="$(OtelVersion)" />
+    <PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.9.0" />
+    <PackageVersion Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" Version="1.9.0-beta.2" />
+    <PackageVersion Include="OpenTelemetry.Exporter.Zipkin" Version="1.9.0" />
+    <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.9.0" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
     <PackageVersion Include="System.Collections.Immutable" Version="$(MExVersion)" />
     <PackageVersion Include="System.Diagnostics.DiagnosticSource" Version="8.0.1" />
     <PackageVersion Include="System.Threading.Channels" Version="8.0.0" />
diff --git a/DotNetToolkit.sln b/DotNetToolkit.sln
@@ -20,9 +20,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		global.json = global.json
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DCA.Extensions.BackgroundTask.MediatR", "src\DCA.Extensions.BackgroundTask.MediatR\DCA.Extensions.BackgroundTask.MediatR.csproj", "{57D9573C-487B-4B98-85C1-29F00A8DACC9}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DCA.Extensions.BackgroundTask.MediatR", "src\DCA.Extensions.BackgroundTask.MediatR\DCA.Extensions.BackgroundTask.MediatR.csproj", "{57D9573C-487B-4B98-85C1-29F00A8DACC9}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DCA.Extensions.BackgroundTask.MediatR.Test", "test\DCA.Extensions.BackgroundTask.MediatR.Test\DCA.Extensions.BackgroundTask.MediatR.Test.csproj", "{4AE336AA-2BB5-4073-A26F-20E946071D96}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DCA.Extensions.BackgroundTask.MediatR.Test", "test\DCA.Extensions.BackgroundTask.MediatR.Test\DCA.Extensions.BackgroundTask.MediatR.Test.csproj", "{4AE336AA-2BB5-4073-A26F-20E946071D96}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{32B7D449-4244-46CD-BB71-A3C8DCF692B5}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sample", "samples\Sample\Sample.csproj", "{0ADD59DD-13C7-4AD5-94BB-4DA73498DA71}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -50,6 +54,10 @@ Global
 		{4AE336AA-2BB5-4073-A26F-20E946071D96}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{4AE336AA-2BB5-4073-A26F-20E946071D96}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{4AE336AA-2BB5-4073-A26F-20E946071D96}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0ADD59DD-13C7-4AD5-94BB-4DA73498DA71}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0ADD59DD-13C7-4AD5-94BB-4DA73498DA71}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0ADD59DD-13C7-4AD5-94BB-4DA73498DA71}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0ADD59DD-13C7-4AD5-94BB-4DA73498DA71}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -60,6 +68,7 @@ Global
 		{9D38CDEB-6995-4568-A93B-2F5325386BFC} = {DCD02B36-60E6-440C-96EF-05A6B590497C}
 		{57D9573C-487B-4B98-85C1-29F00A8DACC9} = {90B56126-AFE5-436B-9F6E-6F5980D681E2}
 		{4AE336AA-2BB5-4073-A26F-20E946071D96} = {DCD02B36-60E6-440C-96EF-05A6B590497C}
+		{0ADD59DD-13C7-4AD5-94BB-4DA73498DA71} = {32B7D449-4244-46CD-BB71-A3C8DCF692B5}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {55D950D2-91EF-4D4D-8D5E-C5A41E46B1BF}
diff --git a/readme.md b/readme.md
@@ -13,15 +13,15 @@ dotnet add package DCA.Extensions.BackgroundTask --prerelease
 ```csharp
 // Register background task components
 services.AddBackgroundTask();
-// Register background dependency
+// Register dependency of background tasks
 services.AddScoped<ServiceA>();
 
 // dispatch a task to run in background
 var dispatcher = serviceProvider.GetRequiredService<IBackgroundTaskDispatcher>();
 await dispatcher.DispatchAsync<ServiceA>(async dep =>
 {
 	await dep.DoWork();
-});
+});  
 
 ```
 
diff --git a/samples/Sample/Program.cs b/samples/Sample/Program.cs
@@ -0,0 +1,41 @@
+using DCA.Extensions.BackgroundTask;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Trace;
+
+
+var builder = WebApplication.CreateBuilder(args);
+builder.Services
+    .AddOpenTelemetry()
+    .WithTracing(b => b
+        .AddSource("DCA.DotNetToolkit")
+        .AddAspNetCoreInstrumentation()
+        .AddZipkinExporter())
+    .WithMetrics(b => b
+        .AddMeter("DCA.DotNetToolkit")
+        .AddPrometheusExporter());
+
+
+builder.Services.AddBackgroundTask();
+builder.Services.AddScoped<ServiceA>();
+
+var app = builder.Build();
+app.UseOpenTelemetryPrometheusScrapingEndpoint();
+
+app.MapPost("/fast-api", async (IBackgroundTaskDispatcher background) =>
+{
+    for (int i = 0; i < 100; i++)
+    {
+        await background.DispatchAsync<ServiceA>(async serviceA => await serviceA.DoWork());
+    }
+    return Results.Ok();
+});
+
+app.Run();
+
+public class ServiceA
+{
+    public async Task DoWork()
+    {
+        await Task.Delay(10 * 1000);
+    }
+}
diff --git a/samples/Sample/Properties/launchSettings.json b/samples/Sample/Properties/launchSettings.json
@@ -0,0 +1,14 @@
+﻿{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "applicationUrl": "http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "OTEL_TRACES_SAMPLER": "always_on",
+        "OTEL_SERVICE_NAME": "sample"
+      }
+    }
+  }
+}
diff --git a/samples/Sample/Sample.csproj b/samples/Sample/Sample.csproj
@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="OpenTelemetry.Exporter.Console" />
+    <PackageReference Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" />
+    <PackageReference Include="OpenTelemetry.Exporter.Zipkin" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\DCA.Extensions.BackgroundTask\DCA.Extensions.BackgroundTask.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/samples/Sample/appsettings.Development.json b/samples/Sample/appsettings.Development.json
@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}
diff --git a/samples/Sample/appsettings.json b/samples/Sample/appsettings.json
@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}
diff --git a/samples/Sample/test.http b/samples/Sample/test.http
@@ -0,0 +1,7 @@
+# For more info on HTTP files go to https://aka.ms/vs/httpfile
+
+POST http://localhost:5000/fast-api
+Content-Type: application/json
+
+{
+}
diff --git a/src/DCA.Extensions.BackgroundTask.MediatR/MediatorDispatcherExtensions.cs b/src/DCA.Extensions.BackgroundTask.MediatR/MediatorDispatcherExtensions.cs
@@ -12,20 +12,22 @@ public static class MediatorDispatcherExtensions
     /// <typeparam name="TTask">Task payload type</typeparam>
     /// <param name="dispatcher"></param>
     /// <param name="task">Task payload</param>
+    /// <param name="id">Task id</param>
     /// <param name="channel">Channel name</param>
     /// <param name="startNow">Should this tast start now</param>
     /// <returns></returns>
     public static ValueTask DispatchAsync<TTask>(
         this IBackgroundTaskDispatcher dispatcher,
         TTask task,
+        string? id = null,
         string? channel = null,
         bool startNow = true) where TTask : IRequest
     {
         var context = new MediatorTaskContext<TTask>(
             dispatcher.ServiceProvider,
             task
         );
-        return dispatcher.DispatchAsync(Execute, context, channel, startNow);
+        return dispatcher.DispatchAsync(Execute, context, id, channel, startNow);
 
         static ValueTask Execute(MediatorTaskContext<TTask> context)
         {
diff --git a/src/DCA.Extensions.BackgroundTask/BackgroundTask.cs b/src/DCA.Extensions.BackgroundTask/BackgroundTask.cs
@@ -8,6 +8,7 @@ public interface IBackgroundTaskContext;
 
 public interface IBackgroundTask : IThreadPoolWorkItem
 {
+    string? Id { get; }
     bool Started { get; }
     void Start();
     ValueTask WaitToCompleteAsync();
@@ -60,10 +61,14 @@ internal async ValueTask ExecuteAsync()
         {
             activity?.SetTag("task.id", id);
         }
+
+
+        Logs.BackgroundTaskExecuting(logger, id);
         try
         {
             await taskDelegate(context).ConfigureAwait(false);
             activity?.SetStatus(ActivityStatusCode.Ok);
+            Logs.BackgroundTaskExecuted(logger, id);
         }
         catch (Exception ex)
         {
diff --git a/src/DCA.Extensions.BackgroundTask/BackgroundTaskChannel.cs b/src/DCA.Extensions.BackgroundTask/BackgroundTaskChannel.cs
@@ -91,7 +91,7 @@ public async ValueTask DispatchAsync(IBackgroundTask task, bool startNow)
         };
         Metrics.CounterInflightBackgroundTasks.Add(1, tagList);
         Metrics.CounterDispatchedTasks.Add(1);
-        Logs.BackgroundTaskDispatched(_logger, Key);
+        Logs.BackgroundTaskDispatched(_logger, Key, task.Id);
 
         if (startNow)
         {
diff --git a/src/DCA.Extensions.BackgroundTask/BackgroundTaskChannelReader.cs b/src/DCA.Extensions.BackgroundTask/BackgroundTaskChannelReader.cs
@@ -41,13 +41,13 @@ private async Task ReadLoop()
                     Metrics.CounterProcessedTasks.Add(1, tagList);
                     if (!task.Started)
                     {
-                        Logs.TaskStarting(logger, key);
+                        Logs.TaskStarting(logger, key, task.Id);
                         task.Start();
                     }
                     var vt = task.WaitToCompleteAsync();
                     if (!vt.IsCompletedSuccessfully)
                     {
-                        Logs.TaskWaitingToComplete(logger, key);
+                        Logs.TaskWaitingToComplete(logger, key, task.Id);
                         await vt.ConfigureAwait(false);
                     }
                     Checkpoint = task;
diff --git a/src/DCA.Extensions.BackgroundTask/BackgroundTaskDispatcher.cs b/src/DCA.Extensions.BackgroundTask/BackgroundTaskDispatcher.cs
@@ -4,48 +4,25 @@
 
 namespace DCA.Extensions.BackgroundTask;
 
-/// <summary>
-/// Background task dispatcher
-/// </summary>
-public interface IBackgroundTaskDispatcher
-{
-    /// <summary>
-    /// An <see cref="IServiceProvider"/> instance, used to create a scope for each task execution
-    /// </summary>
-    IServiceProvider ServiceProvider { get; }
-
-    /// <summary>
-    /// Dispatch a background task
-    /// </summary>
-    /// <typeparam name="TContext">Type of task context</typeparam>
-    /// <param name="taskDelegate">Task delegate</param>
-    /// <param name="taskContext">Task context</param>
-    /// <param name="channel">Channel key</param>
-    /// <param name="startNow">Should the task start immediately</param>
-    /// <returns></returns>
-    ValueTask DispatchAsync<TContext>(
-        Func<TContext, ValueTask> taskDelegate,
-        TContext taskContext,
-        string? channel = null,
-        bool startNow = true) where TContext : IBackgroundTaskContext;
-}
-
 public sealed class BackgroundTaskDispatcher(
     FrozenDictionary<string, BackgroundTaskChannel> channels,
-    ILogger<BackgroundTaskDispatcher> logger,
+    //ILogger<BackgroundTaskDispatcher> logger,
+    ILoggerFactory loggerFactory,
     IServiceProvider serviceProvider)
     : IBackgroundTaskDispatcher
 {
+    private readonly ILogger logger = loggerFactory.CreateLogger<IBackgroundTask>();
     public IServiceProvider ServiceProvider { get; } = serviceProvider;
 
     public ValueTask DispatchAsync<TContext>(
         Func<TContext, ValueTask> taskDelegate,
         TContext taskContext,
+        string? id = null,
         string? channel = null,
         bool startNow = true) where TContext : IBackgroundTaskContext
     {
         var task = new BackgroundTask<TContext>(
-            null,
+            id ?? Guid.NewGuid().ToString(),
             taskDelegate,
             taskContext,
             logger,
diff --git a/src/DCA.Extensions.BackgroundTask/BackgroundTaskDispatcherExtensions.cs b/src/DCA.Extensions.BackgroundTask/BackgroundTaskDispatcherExtensions.cs
@@ -15,20 +15,22 @@ public static class BackgroundTaskDispatcherExtensions
     /// <typeparam name="TDependency">Dependency type</typeparam>
     /// <param name="dispatcher"></param>
     /// <param name="taskDelegate">Task delegate</param>
+    /// <param name="id">Task id</param>
     /// <param name="channel">Channel name</param>
     /// <param name="startNow">Should this tast start now</param>
     /// <returns></returns>
     public static ValueTask DispatchAsync<TDependency>(
         this IBackgroundTaskDispatcher dispatcher,
         Func<TDependency, ValueTask> taskDelegate,
+        string? id = null,
         string? channel = null,
         bool startNow = true) where TDependency : notnull
     {
         var context = new DelegateBackgroundTaskContext<TDependency>(
             dispatcher.ServiceProvider,
             taskDelegate
         );
-        return dispatcher.DispatchAsync(Execute, context, channel, startNow);
+        return dispatcher.DispatchAsync(Execute, context, id, channel, startNow);
 
         static ValueTask Execute(DelegateBackgroundTaskContext<TDependency> context)
         {
diff --git a/src/DCA.Extensions.BackgroundTask/IBackgroundTaskDispatcher.cs b/src/DCA.Extensions.BackgroundTask/IBackgroundTaskDispatcher.cs
@@ -0,0 +1,29 @@
+﻿namespace DCA.Extensions.BackgroundTask;
+
+/// <summary>
+/// Background task dispatcher
+/// </summary>
+public interface IBackgroundTaskDispatcher
+{
+    /// <summary>
+    /// An <see cref="IServiceProvider"/> instance, used to create a scope for each task execution
+    /// </summary>
+    IServiceProvider ServiceProvider { get; }
+
+    /// <summary>
+    /// Dispatch a background task
+    /// </summary>
+    /// <typeparam name="TContext">Type of task context</typeparam>
+    /// <param name="taskDelegate">Task delegate</param>
+    /// <param name="taskContext">Task context</param>
+    /// <param name="id">Task id</param>
+    /// <param name="channel">Channel key</param>
+    /// <param name="startNow">Should the task start immediately</param>
+    /// <returns></returns>
+    ValueTask DispatchAsync<TContext>(
+        Func<TContext, ValueTask> taskDelegate,
+        TContext taskContext,
+        string? id = null,
+        string? channel = null,
+        bool startNow = true) where TContext : IBackgroundTaskContext;
+}
diff --git a/src/DCA.Extensions.BackgroundTask/Telemetry/Logs.cs b/src/DCA.Extensions.BackgroundTask/Telemetry/Logs.cs

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ public interface IBackgroundTaskContext;`
`8`	`8`
`9`	`9`	`public interface IBackgroundTask : IThreadPoolWorkItem`
`10`	`10`	`{`
	`11`	`+ string? Id { get; }`
`11`	`12`	`bool Started { get; }`
`12`	`13`	`void Start();`
`13`	`14`	`ValueTask WaitToCompleteAsync();`
`@@ -60,10 +61,14 @@ internal async ValueTask ExecuteAsync()`
`60`	`61`	`{`
`61`	`62`	`activity?.SetTag("task.id", id);`
`62`	`63`	`}`
	`64`	`+`
	`65`	`+`
	`66`	`+ Logs.BackgroundTaskExecuting(logger, id);`
`63`	`67`	`try`
`64`	`68`	`{`
`65`	`69`	`await taskDelegate(context).ConfigureAwait(false);`
`66`	`70`	`activity?.SetStatus(ActivityStatusCode.Ok);`
	`71`	`+ Logs.BackgroundTaskExecuted(logger, id);`
`67`	`72`	`}`
`68`	`73`	`catch (Exception ex)`
`69`	`74`	`{`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public async ValueTask DispatchAsync(IBackgroundTask task, bool startNow)`
`91`	`91`	`};`
`92`	`92`	`Metrics.CounterInflightBackgroundTasks.Add(1, tagList);`
`93`	`93`	`Metrics.CounterDispatchedTasks.Add(1);`
`94`		`- Logs.BackgroundTaskDispatched(_logger, Key);`
	`94`	`+ Logs.BackgroundTaskDispatched(_logger, Key, task.Id);`
`95`	`95`
`96`	`96`	`if (startNow)`
`97`	`97`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,13 +41,13 @@ private async Task ReadLoop()`
`41`	`41`	`Metrics.CounterProcessedTasks.Add(1, tagList);`
`42`	`42`	`if (!task.Started)`
`43`	`43`	`{`
`44`		`- Logs.TaskStarting(logger, key);`
	`44`	`+ Logs.TaskStarting(logger, key, task.Id);`
`45`	`45`	`task.Start();`
`46`	`46`	`}`
`47`	`47`	`var vt = task.WaitToCompleteAsync();`
`48`	`48`	`if (!vt.IsCompletedSuccessfully)`
`49`	`49`	`{`
`50`		`- Logs.TaskWaitingToComplete(logger, key);`
	`50`	`+ Logs.TaskWaitingToComplete(logger, key, task.Id);`
`51`	`51`	`await vt.ConfigureAwait(false);`
`52`	`52`	`}`
`53`	`53`	`Checkpoint = task;`