Class BackupStatus

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

An engine's backups at one instant (Status, backup.status.json): a published snapshot, read without a lock. MinValue means "none" for every time.

public sealed record BackupStatus : IEquatable<BackupStatus>

Inheritance

object

BackupStatus

Implements

IEquatable<BackupStatus>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BackupStatus(BackupHealth, BackupHealthReason, string, BackupRunState, BackupRunPhase, long, long, long, BackupPointSummary, DateTime, DateTime, int, BackupFailure, long, long, long, long, long, int, long, int, int, BackupDrillSummary, BackupDrillSummary, BackupRetentionBlock, BackupArchiveStatus, Guid, DateTime)

An engine's backups at one instant (Status, backup.status.json): a published snapshot, read without a lock. MinValue means "none" for every time.

public BackupStatus(BackupHealth Health, BackupHealthReason Reason, string ReasonText, BackupRunState State, BackupRunPhase Phase, long ProgressPages, long ProgressOfPages, long ProgressBytes, BackupPointSummary LastPoint, DateTime LastSuccessUtc, DateTime NextDueUtc, int ConsecutiveFailures, BackupFailure LastFailure, long PointsTotal, long FailuresTotal, long CbwCopiesTotal, long CbwAbortsTotal, long SuspectPagesTotal, int ChainDepth, long StoreBytes, int RestorablePoints, int FreePageSuspects, BackupDrillSummary LastDrill, BackupDrillSummary LastPassedDrill, BackupRetentionBlock RetentionBlocked, BackupArchiveStatus Archive, Guid LastRequestId, DateTime UpdatedUtc)

Parameters

Health BackupHealth

The verdict.

Reason BackupHealthReason

Why.

ReasonText string

Why, in one sentence.

State BackupRunState

Idle, running, stopped.

Phase BackupRunPhase

What the running job does.

ProgressPages long

Pages the running capture has read.

ProgressOfPages long

Pages it will read.

ProgressBytes long

Bytes the running compaction has read.

LastPoint BackupPointSummary

The newest point this engine knows of on its timeline, or null.

LastSuccessUtc DateTime

When that point's tail copy ended.

NextDueUtc DateTime

When the schedule next takes a point (an estimate: the schedule runs on a monotonic clock); in the past while overdue (the instant it became due).

ConsecutiveFailures int

Failed backups in a row (refusals that only defer are not counted).

LastFailure BackupFailure

The last failure, or null.

PointsTotal long

Points this session published.

FailuresTotal long

Backups this session that failed.

CbwCopiesTotal long

Copy-before-write copies this session.

CbwAbortsTotal long

Captures this session abandoned because a writer could not wait.

SuspectPagesTotal long

Suspect pages in the points this session published.

ChainDepth int

The packs a restore of the newest point reads.

StoreBytes long

The store's pack bytes.

RestorablePoints int

The store's restorable points.

FreePageSuspects int

Suspect pages of the newest point on pages its occupancy marks free (no warning: nothing there is data).

LastDrill BackupDrillSummary

The newest drill, or null.

LastPassedDrill BackupDrillSummary

The newest drill that passed, or null.

RetentionBlocked BackupRetentionBlock

What the last retention could not meet.

Archive BackupArchiveStatus

The WAL archive.

LastRequestId Guid

The last backup.request whose job started.

UpdatedUtc DateTime

When this snapshot was published.

Properties

Archive

The WAL archive.

public BackupArchiveStatus Archive { get; init; }

Property Value

BackupArchiveStatus

CbwAbortsTotal

Captures this session abandoned because a writer could not wait.

public long CbwAbortsTotal { get; init; }

Property Value

long

CbwCopiesTotal

Copy-before-write copies this session.

public long CbwCopiesTotal { get; init; }

Property Value

long

ChainDepth

The packs a restore of the newest point reads.

public int ChainDepth { get; init; }

Property Value

int

ConsecutiveFailures

Failed backups in a row (refusals that only defer are not counted).

public int ConsecutiveFailures { get; init; }

Property Value

int

FailuresTotal

Backups this session that failed.

public long FailuresTotal { get; init; }

Property Value

long

FreePageSuspects

Suspect pages of the newest point on pages its occupancy marks free (no warning: nothing there is data).

public int FreePageSuspects { get; init; }

Property Value

int

Health

The verdict.

public BackupHealth Health { get; init; }

Property Value

BackupHealth

LastDrill

The newest drill, or null.

public BackupDrillSummary LastDrill { get; init; }

Property Value

BackupDrillSummary

LastFailure

The last failure, or null.

public BackupFailure LastFailure { get; init; }

Property Value

BackupFailure

LastPassedDrill

The newest drill that passed, or null.

public BackupDrillSummary LastPassedDrill { get; init; }

Property Value

BackupDrillSummary

LastPoint

The newest point this engine knows of on its timeline, or null.

public BackupPointSummary LastPoint { get; init; }

Property Value

BackupPointSummary

LastRequestId

The last backup.request whose job started.

public Guid LastRequestId { get; init; }

Property Value

Guid

LastSuccessUtc

When that point's tail copy ended.

public DateTime LastSuccessUtc { get; init; }

Property Value

DateTime

NextDueUtc

When the schedule next takes a point (an estimate: the schedule runs on a monotonic clock); in the past while overdue (the instant it became due).

public DateTime NextDueUtc { get; init; }

Property Value

DateTime

Off

Backup not configured.

public static BackupStatus Off { get; }

Property Value

BackupStatus

Phase

What the running job does.

public BackupRunPhase Phase { get; init; }

Property Value

BackupRunPhase

PointsTotal

Points this session published.

public long PointsTotal { get; init; }

Property Value

long

ProgressBytes

Bytes the running compaction has read.

public long ProgressBytes { get; init; }

Property Value

long

ProgressOfPages

Pages it will read.

public long ProgressOfPages { get; init; }

Property Value

long

ProgressPages

Pages the running capture has read.

public long ProgressPages { get; init; }

Property Value

long

Reason

Why.

public BackupHealthReason Reason { get; init; }

Property Value

BackupHealthReason

ReasonText

Why, in one sentence.

public string ReasonText { get; init; }

Property Value

string

RestorablePoints

The store's restorable points.

public int RestorablePoints { get; init; }

Property Value

int

RetentionBlocked

What the last retention could not meet.

public BackupRetentionBlock RetentionBlocked { get; init; }

Property Value

BackupRetentionBlock

State

Idle, running, stopped.

public BackupRunState State { get; init; }

Property Value

BackupRunState

StoreBytes

The store's pack bytes.

public long StoreBytes { get; init; }

Property Value

long

SuspectPagesTotal

Suspect pages in the points this session published.

public long SuspectPagesTotal { get; init; }

Property Value

long

UpdatedUtc

When this snapshot was published.

public DateTime UpdatedUtc { get; init; }

Property Value

DateTime

Methods

Deconstruct(out BackupHealth, out BackupHealthReason, out string, out BackupRunState, out BackupRunPhase, out long, out long, out long, out BackupPointSummary, out DateTime, out DateTime, out int, out BackupFailure, out long, out long, out long, out long, out long, out int, out long, out int, out int, out BackupDrillSummary, out BackupDrillSummary, out BackupRetentionBlock, out BackupArchiveStatus, out Guid, out DateTime)

public void Deconstruct(out BackupHealth Health, out BackupHealthReason Reason, out string ReasonText, out BackupRunState State, out BackupRunPhase Phase, out long ProgressPages, out long ProgressOfPages, out long ProgressBytes, out BackupPointSummary LastPoint, out DateTime LastSuccessUtc, out DateTime NextDueUtc, out int ConsecutiveFailures, out BackupFailure LastFailure, out long PointsTotal, out long FailuresTotal, out long CbwCopiesTotal, out long CbwAbortsTotal, out long SuspectPagesTotal, out int ChainDepth, out long StoreBytes, out int RestorablePoints, out int FreePageSuspects, out BackupDrillSummary LastDrill, out BackupDrillSummary LastPassedDrill, out BackupRetentionBlock RetentionBlocked, out BackupArchiveStatus Archive, out Guid LastRequestId, out DateTime UpdatedUtc)

Parameters

Health BackupHealth

Reason BackupHealthReason

ReasonText string

State BackupRunState

Phase BackupRunPhase

ProgressPages long

ProgressOfPages long

ProgressBytes long

LastPoint BackupPointSummary

LastSuccessUtc DateTime

NextDueUtc DateTime

ConsecutiveFailures int

LastFailure BackupFailure

PointsTotal long

FailuresTotal long

CbwCopiesTotal long

CbwAbortsTotal long

SuspectPagesTotal long

ChainDepth int

StoreBytes long

RestorablePoints int

FreePageSuspects int

LastDrill BackupDrillSummary

LastPassedDrill BackupDrillSummary

RetentionBlocked BackupRetentionBlock

Archive BackupArchiveStatus

LastRequestId Guid

UpdatedUtc DateTime

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(BackupStatus?)

public bool Equals(BackupStatus? other)

Parameters

other BackupStatus

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BackupStatus?, BackupStatus?)

public static bool operator ==(BackupStatus? left, BackupStatus? right)

Parameters

left BackupStatus

right BackupStatus

Returns

bool

operator !=(BackupStatus?, BackupStatus?)

public static bool operator !=(BackupStatus? left, BackupStatus? right)

Parameters

left BackupStatus

right BackupStatus

Returns

bool