Class StructuredLoggingJobHistoryPlugin

Namespace

Quartz.Plugins.History

Assembly

Quartz.Plugins.dll

Logs a history of all job executions (and execution vetoes) via structured logging.

[SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "The template is the user's, configured at run time, and its named placeholders are what a structured sink resolves into properties - which is the whole reason this plugin exists. A [LoggerMessage] template is fixed at compile time, and rendering this one first would flatten exactly what is being preserved. Every call is already behind an IsEnabled check, so the allocation CA1848 exists to avoid is already avoided. LogCallSiteTest.Allowed records the same decision from the source side.")]
public sealed class StructuredLoggingJobHistoryPlugin : ISchedulerPlugin, IJobListener

Inheritance

object

StructuredLoggingJobHistoryPlugin

Implements

ISchedulerPlugin

IJobListener

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This is a structured logging alternative to LoggingJobHistoryPlugin. Unlike LoggingJobHistoryPlugin, message templates use named parameters (e.g. {JobName}, {TriggerGroup}) instead of index-based placeholders. This makes log output compatible with structured logging sinks like Serilog and NLog, and avoids template cache memory leaks.

Message templates can be customized via properties. The parameter names in the templates must match the default names exactly (they are positionally mapped).

Constructors

StructuredLoggingJobHistoryPlugin()

Creates the plugin with the static logger and the system clock, for a plugin the loader built from a quartz.plugin.<name>.type key and so had nothing to inject into.

public StructuredLoggingJobHistoryPlugin()

StructuredLoggingJobHistoryPlugin(ILogger<StructuredLoggingJobHistoryPlugin>, TimeProvider)

Creates the plugin with the logger and clock a container resolved, which is what UseStructuredJobLogging uses.

public StructuredLoggingJobHistoryPlugin(ILogger<StructuredLoggingJobHistoryPlugin> logger, TimeProvider timeProvider)

Parameters

logger ILogger<StructuredLoggingJobHistoryPlugin>

Where the history events go.

timeProvider TimeProvider

The clock the events are stamped with.

Properties

JobFailedMessage

Gets or sets the message that is logged when a Job fails its execution.

public string JobFailedMessage { get; }

Property Value

string

JobSuccessMessage

Gets or sets the message that is logged when a Job successfully completes its execution.

public string JobSuccessMessage { get; }

Property Value

string

JobToBeFiredMessage

Gets or sets the message that is logged when a Job is about to be executed.

public string JobToBeFiredMessage { get; }

Property Value

string

JobWasVetoedMessage

Gets or sets the message that is logged when a Job execution is vetoed by a trigger listener.

public string JobWasVetoedMessage { get; }

Property Value

string

Name

Get the name of the IJobListener.

public string Name { get; }

Property Value

string

Methods

Initialize(string, IScheduler, CancellationToken)

Called during creation of the IScheduler in order to give the ISchedulerPlugin a chance to Initialize.

public ValueTask Initialize(string pluginName, IScheduler scheduler, CancellationToken cancellationToken = default)

Parameters

pluginName string

scheduler IScheduler

cancellationToken CancellationToken

Returns

ValueTask

JobExecutionVetoed(IJobExecutionContext, CancellationToken)

Called by the IScheduler when a IJobDetail was about to be executed (an associated ITrigger has occurred), but a ITriggerListener vetoed it's execution.

public ValueTask JobExecutionVetoed(IJobExecutionContext context, CancellationToken cancellationToken = default)

Parameters

context IJobExecutionContext

cancellationToken CancellationToken

Returns

ValueTask

See Also

JobToBeExecuted(IJobExecutionContext, CancellationToken)

JobToBeExecuted(IJobExecutionContext, CancellationToken)

Called by the IScheduler when a IJobDetail is about to be executed (an associated ITrigger has occurred).

This method will not be invoked if the execution of the Job was vetoed by a ITriggerListener.

public ValueTask JobToBeExecuted(IJobExecutionContext context, CancellationToken cancellationToken = default)

Parameters

context IJobExecutionContext

cancellationToken CancellationToken

Returns

ValueTask

See Also

JobExecutionVetoed(IJobExecutionContext, CancellationToken)

JobWasExecuted(IJobExecutionContext, JobExecutionException?, CancellationToken)

Called by the IScheduler after a IJobDetail has been executed, and before the associated ITrigger's Triggered(ICalendar?) method has been called.

public ValueTask JobWasExecuted(IJobExecutionContext context, JobExecutionException? jobException, CancellationToken cancellationToken = default)

Parameters

context IJobExecutionContext

jobException JobExecutionException

cancellationToken CancellationToken

Returns

ValueTask