feat!: add optional servicename to backgroundserviceoptions

Author: Per Kops

sample/Atc.Hosting.TimeFile.Sample/TimeFileScheduleWorkerOptions.cs

@@ -8,6 +8,8 @@ public class TimeFileScheduleWorkerOptions : IBackgroundScheduleServiceOptions
 
     public string CronExpression { get; set; } = "*/5 * * * *";
 
+    public string? ServiceName { get; set; }
+
     public override string ToString()
-        => $"{nameof(OutputDirectory)}: {OutputDirectory}, {nameof(CronExpression)}: {CronExpression}";
+        => $"{nameof(OutputDirectory)}: {OutputDirectory}, {nameof(CronExpression)}: {CronExpression}, {nameof(ServiceName)}: {ServiceName}";
 }

sample/Atc.Hosting.TimeFile.Sample/TimeFileWorkerOptions.cs

@@ -10,6 +10,8 @@ public class TimeFileWorkerOptions : IBackgroundServiceOptions
 
     public ushort RepeatIntervalSeconds { get; set; } = 20;
 
+    public string? ServiceName { get; set; }
+
     public override string ToString()
-        => $"{nameof(OutputDirectory)}: {OutputDirectory}, {nameof(StartupDelaySeconds)}: {StartupDelaySeconds}, {nameof(RepeatIntervalSeconds)}: {RepeatIntervalSeconds}";
+        => $"{nameof(OutputDirectory)}: {OutputDirectory}, {nameof(StartupDelaySeconds)}: {StartupDelaySeconds}, {nameof(RepeatIntervalSeconds)}: {RepeatIntervalSeconds}, {nameof(ServiceName)}: {ServiceName}";
 }

sample/Atc.Hosting.TimeFile.Sample/appsettings.json

@@ -7,5 +7,6 @@
   "TimeFileScheduleWorker": {
     "OutputDirectory": "C:\\Temp\\TimeFileWorkerTesting",
     "CronExpression": " */1 * * * *",
+    "ServiceName": "time-file-worker-service-custom-name"
   }
 }

src/Atc.Hosting/BackgroundScheduleServiceBase.cs

@@ -16,7 +16,7 @@ protected BackgroundScheduleServiceBase(
         this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
         ServiceOptions = backgroundScheduleServiceOptions ?? throw new ArgumentNullException(nameof(backgroundScheduleServiceOptions));
         this.healthService = healthService ?? throw new ArgumentNullException(nameof(healthService));
-        ServiceName = typeof(T).Name;
+        ServiceName = backgroundScheduleServiceOptions.ServiceName ?? typeof(T).Name;
     }
 
     /// <summary>

src/Atc.Hosting/BackgroundServiceBase.cs

@@ -21,7 +21,7 @@ protected BackgroundServiceBase(
         this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
         ServiceOptions = backgroundServiceOptions ?? throw new ArgumentNullException(nameof(backgroundServiceOptions));
         this.healthService = healthService ?? throw new ArgumentNullException(nameof(healthService));
-        ServiceName = typeof(T).Name;
+        ServiceName = backgroundServiceOptions.ServiceName ?? typeof(T).Name;
     }
 
     /// <summary>

src/Atc.Hosting/DefaultBackgroundScheduleServiceOptions.cs

@@ -9,4 +9,12 @@ public class DefaultBackgroundScheduleServiceOptions : IBackgroundScheduleServic
     /// Gets the cron expression for scheduling - the default value is "*/5 * * * *" (every 5 minutes).
     /// </summary>
     public string CronExpression { get; set; } = "*/5 * * * *";
+
+    /// <summary>
+    /// Gets or sets the name of the service.
+    /// </summary>
+    /// <value>
+    /// The name of the service.
+    /// </value>
+    public string? ServiceName { get; set; }
 }

src/Atc.Hosting/DefaultBackgroundServiceOptions.cs

@@ -15,7 +15,15 @@ public class DefaultBackgroundServiceOptions : IBackgroundServiceOptions
     /// </summary>
     public ushort RepeatIntervalSeconds { get; set; } = 30;
 
+    /// <summary>
+    /// Gets or sets the name of the service.
+    /// </summary>
+    /// <value>
+    /// The name of the service.
+    /// </value>
+    public string? ServiceName { get; set; }
+
     /// <inheritdoc />
     public override string ToString()
-        => $"{nameof(StartupDelaySeconds)}: {StartupDelaySeconds}, {nameof(RepeatIntervalSeconds)}: {RepeatIntervalSeconds}";
+        => $"{nameof(StartupDelaySeconds)}: {StartupDelaySeconds}, {nameof(RepeatIntervalSeconds)}: {RepeatIntervalSeconds}, {nameof(ServiceName)}: {ServiceName}";
 }

src/Atc.Hosting/IBackgroundScheduleServiceOptions.cs

@@ -36,7 +36,7 @@ namespace Atc.Hosting;
 /// </item>
 /// </list>
 /// </remarks>
-public interface IBackgroundScheduleServiceOptions
+public interface IBackgroundScheduleServiceOptions : IBackgroundServiceBaseOptions
 {
     /// <summary>
     /// Gets the cron expression for scheduling.

src/Atc.Hosting/IBackgroundServiceBaseOptions.cs

@@ -0,0 +1,6 @@
+namespace Atc.Hosting;
+
+public interface IBackgroundServiceBaseOptions
+{
+    public string? ServiceName { get; set; }
+}

src/Atc.Hosting/IBackgroundServiceOptions.cs

@@ -3,7 +3,7 @@ namespace Atc.Hosting;
 /// <summary>
 /// The interface definition for BackgroundServiceOptions used in <see cref="BackgroundServiceBase{T}"/>.
 /// </summary>
-public interface IBackgroundServiceOptions
+public interface IBackgroundServiceOptions : IBackgroundServiceBaseOptions
 {
     /// <summary>
     /// Defines the delay period before the first unit of work.