Class ExecutionStatisticsQuery

Namespace

Quartz

Assembly

Quartz.dll

The runs of a scheduler, counted by result and timed, in buckets of fire time; optionally narrowed as an ExecutionHistoryQuery narrows a page.

public sealed record ExecutionStatisticsQuery : IEquatable<ExecutionStatisticsQuery>

Inheritance

object

ExecutionStatisticsQuery

Implements

IEquatable<ExecutionStatisticsQuery>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Every filter but JobGroup is ExecutionHistoryQuery's and means what it means there, so a chart beside a history page counts the rows that page lists.

A bucket starts at a whole multiple of BucketSize counted from MinValue: an hour bucket starts on the hour and a day bucket at midnight, UTC.

Fields

MinimumBucketSize

The narrowest BucketSize: one minute.

public static readonly TimeSpan MinimumBucketSize

Field Value

TimeSpan

Properties

BucketSize

How much fire time one bucket covers. Defaults to one hour; at least MinimumBucketSize.

public TimeSpan BucketSize { get; init; }

Property Value

TimeSpan

Exceptions

ArgumentOutOfRangeException

Shorter than MinimumBucketSize.

FailedFinally

Counts only the runs that failed for the last time (true), or only the rest (false). null, the default, counts them all.

public bool? FailedFinally { get; init; }

Property Value

bool?

Remarks

As FailedFinally.

FireInstanceId

Counts only the runs of this firing, matched exactly, or every firing's when null.

public string? FireInstanceId { get; init; }

Property Value

string

FiredBefore

Counts only the runs that fired before this instant, or up to now when null. Exclusive.

public DateTimeOffset? FiredBefore { get; init; }

Property Value

DateTimeOffset?

FiredFrom

Counts only the runs that fired at or after this instant, or from the start of the history when null.

public DateTimeOffset? FiredFrom { get; init; }

Property Value

DateTimeOffset?

Job

Counts only the runs of this job, matched exactly, or every job's when null.

public JobKey? Job { get; init; }

Property Value

JobKey

JobContains

Counts only the runs whose job key matches this, or every job's when null.

public string? JobContains { get; init; }

Property Value

string

Remarks

A Contains filter matches a key's group, its name, or the two joined as group.name, case-insensitively — the same reading the dashboard's history search has always had. Results are newest first, which is the one ordering a history page is read in.

JobGroup

Counts only the runs of the jobs in this group, matched exactly, or every group's when null.

public string? JobGroup { get; init; }

Property Value

string

Results

Counts only the runs whose EffectiveResult is one of these, or every result when null. An empty set counts nothing.

public IReadOnlyCollection<JobRunResult>? Results { get; init; }

Property Value

IReadOnlyCollection<JobRunResult>

SchedulerInstanceId

The node whose runs to count, or null for every node's.

public string? SchedulerInstanceId { get; init; }

Property Value

string

SchedulerName

The scheduler whose runs to count. Required: a store keeps every scheduler's rows together.

public required string SchedulerName { get; init; }

Property Value

string

Trigger

Counts only the runs this trigger fired, matched exactly, or every trigger's when null.

public TriggerKey? Trigger { get; init; }

Property Value

TriggerKey

TriggerContains

Counts only the runs whose trigger key matches this, or every trigger's when null.

public string? TriggerContains { get; init; }

Property Value

string

See Also

QueryExecutionStatistics(ExecutionStatisticsQuery, CancellationToken)