JGUZDV.JobHost 1.7.1

JGUZDV.JobHost

JGUZDV.JobHost is a .NET package designed to simplify the creation of background jobs in a Windows service using the IHostBuilder and Quartz.net. You can easily register jobs with a cron schedule, and they will be executed in the background as part of a Windows service.

Configuration

You can configure your schedules in the appsettings.json. The default sectionName is "HostedJobs"

{
  "HostedJobs": {
    "MyJob": "* * * * * ?",
    "MyJob2": "* 0/5 * * * ?",
    "MyJob3": "false", //this prevents the job from being registered e.g. for appsettings.development.json
    "DisableDevelopmentJobSelection": "true" // optional: disables the job selestion screen and runs the jobs with the given schedule in appsettings.Development.json
  }
}

OpenTelemetry configuration

If you wish to use OpenTelemetry within your application you can define a section in your appsettings.json named "OpenTelemetry" that looks as follows: Since OpenTelemetry is added automatically within the JobHost.CreateJobHostBuilder() method through .

  ...
  "OpenTelemetry": {
    "AzureMonitor": {
      "ConnectionString": "<AzureMonitorConnectionString>"
    },
    "ServiceNamespace": "<AppNamespace>",
    "ServiceName": "<AppName>",
    "Metrics": {
      "MeterName": "<AppMeterName>",
      "MeterVersion": "<AppMeterVersion>"
    }
  },
  ...

This Example shows the full difinition of the "OpenTelemetry" section. If you wish to see a more detailed explanation, please refer to the JGUZDV.Extensions.OpenTelemetry NuGet-Package.

Usage

Your jobs must implement the IJob interface from Quartz.net. To use JGUZDV.JobHost, you can create an HostApplicationBuilder and register jobs with a cron schedule. The jobs will be executed in the background as part of a Windows service. If you wish to use metrics, you need to implement a service that inherits from JGUZDVBaseMeter and register it as a singleton, as shown in JGUZDV.Extensions.OpenTelemetry.

Here's a basic example:

using Microsoft.Extensions.DependencyInjection;
using JGUZDV.JobHost;

class Program
{
    static void Main(string[] args)
    {
        var host = JobHost.CreateJobHostBuilder(args, configureWindowsService, quartzHostedServiceOptions)
            .AddHostedJob<MyJob>() // with the configuration above the job runs every second
            .AddHostedJob<MyJob2>() // with the configuration above the job runs every 5 minutes (at 0, 5, 10, 15.... etc Minutes)
            
        host.Services.AddSingleton<MeterContainer>(); // as shown in the JGUZDV.Extensions.OpenTelemetry example
            
        var app = host.Build();

        _ = app.RunAsync();
    }
}