👁 Image
Quartz.Plugins 3.18.1

Quartz.Plugins provides some useful ready-mady plugins for your convenience.

Installation

You need to add NuGet package reference to your project which uses Quartz.

Install-Package Quartz.Plugins

Configuration

Plugins are configured by using either DI configuration extensions or adding required configuration keys.

Configuration key in in format quartz.plgin.{name-to-refer-with}.{property}.

on how to configure each plugin

Features

LoggingJobHistoryPlugin

Logs a history of all job executions (and execution vetoes) and writes the entries to configured logging infrastructure.

StructuredLoggingJobHistoryPlugin

Structured logging alternative to LoggingJobHistoryPlugin. Uses named message template parameters (e.g. {JobName}, {TriggerGroup}) instead of index-based placeholders, making log output compatible with structured logging sinks like Serilog and NLog. This avoids template cache memory leaks that can occur with the original plugin.

Message templates can be customized via properties. When customizing, the parameter names in templates are positionally mapped, so they must appear in the same order as the defaults.

Available template properties:

DI configuration:

services.AddQuartz(q =>
{
 q.UseStructuredJobLogging();
});

::: tip Recommended over LoggingJobHistoryPlugin when using structured logging providers (Serilog, NLog, etc.). :::

StructuredLoggingTriggerHistoryPlugin

Structured logging alternative to LoggingTriggerHistoryPlugin. Logs trigger firings, misfires, and completions using named message template parameters for structured logging compatibility.

Message templates can be customized via properties. When customizing, the parameter names in templates are positionally mapped, so they must appear in the same order as the defaults.

Available template properties:

DI configuration:

services.AddQuartz(q =>
{
 q.UseStructuredTriggerLogging();
});

::: tip Recommended over LoggingTriggerHistoryPlugin when using structured logging providers (Serilog, NLog, etc.). :::

ShutdownHookPlugin

This plugin catches the event of the VM terminating (such as upon a CRTL-C) and tells the scheduler to Shutdown.

XMLSchedulingDataProcessorPlugin

This plugin loads XML file(s) to add jobs and schedule them with triggers as the scheduler is initialized, and can optionally periodically scan thefile for changes.

::: warning The periodically scanning of files for changes is not currently supported in a clustered environment. :::

JsonSchedulingDataProcessorPlugin

This plugin loads JSON file(s) to add jobs and schedule them with triggers as the scheduler is initialized, and can optionally periodically scan the file for changes. It is the JSON analog of XMLSchedulingDataProcessorPlugin.

::: warning The periodically scanning of files for changes is not currently supported in a clustered environment. :::

DI configuration:

services.AddQuartz(q =>
{
 q.UseJsonSchedulingConfiguration(x =>
 {
 x.Files = new[] { "quartz_jobs.json" };
 x.ScanInterval = TimeSpan.FromMinutes(1);
 x.FailOnFileNotFound = true;
 x.FailOnSchedulingError = true;
 });
});

Property configuration:

quartz.plugin.json.type = Quartz.Plugin.Json.JsonSchedulingDataProcessorPlugin, Quartz.Plugins
quartz.plugin.json.fileNames = quartz_jobs.json
quartz.plugin.json.scanInterval = 60
quartz.plugin.json.failOnFileNotFound = true
quartz.plugin.json.failOnSchedulingError = true

See for the full JSON file format and trigger type reference.

JobInterruptMonitorPlugin

This plugin catches the event of job running for a long time (more than the configured max time) and tells the scheduler to "try" interrupting it if enabled.

::: tip Quartz 3.3 or later required. :::

Each job configuration needs to have JobInterruptMonitorPlugin.JobDataMapKeyAutoInterruptable key's value set to true in order for plugin to monitor the execution timeout. Jobs can also define custom timeout value instead of global default by using key JobInterruptMonitorPlugin.JobDataMapKeyMaxRunTime.

var job = JobBuilder.Create<SlowJob>()
 .WithIdentity("slowJob")
 .UsingJobData(JobInterruptMonitorPlugin.JobDataMapKeyAutoInterruptable, true)
 // allow only five seconds for this job, overriding default configuration
 .UsingJobData(JobInterruptMonitorPlugin.JobDataMapKeyMaxRunTime, TimeSpan.FromSeconds(5).TotalMilliseconds.ToString(CultureInfo.InvariantCulture))
 .Build();