shard

Documentation

Index

• type ControlFlowFailure
• type FixKeys
• type FixReport
• type FixResult
• type FixStats
• type Fixer
  • func NewFixer(ctx context.Context, shardID int, manager invariant.Manager, ...) Fixer
• type ScanKeys
• type ScanReport
• type ScanResult
• type ScanStats
• type Scanner
  • func NewScanner(ctx context.Context, shardID int, iterator pagination.Iterator, ...) Scanner

Types

type ControlFlowFailure

type ControlFlowFailure struct {
	Info        string
	InfoDetails string
}

ControlFlowFailure indicates an error occurred which makes it impossible to even attempt to check or fix one or more execution(s). Note that it is not a ControlFlowFailure if a check or fix fails, it is only a ControlFlowFailure if an error is encountered which makes even attempting to check or fix impossible.

type FixKeys

type FixKeys struct {
	Skipped *store.Keys
	Failed  *store.Keys
	Fixed   *store.Keys
}

FixKeys are the keys to the blobs that were uploaded during fix. Keys can be nil if there were no uploads.

type FixReport

type FixReport struct {
	ShardID int
	Stats   FixStats
	Result  FixResult
}

FixReport is the report of running Fix on a single shard

type FixResult

type FixResult struct {
	ShardFixKeys       *FixKeys
	ControlFlowFailure *ControlFlowFailure
}

FixResult indicates the result of running fix on a shard. Exactly one of ControlFlowFailure or FixKeys will be non-nil.

type FixStats

type FixStats struct {
	ExecutionCount int64
	FixedCount     int64
	SkippedCount   int64
	FailedCount    int64
}

FixStats indicates the stats of executions that were handled by shard Fix.

type Fixer

type Fixer interface {
	Fix() FixReport
}

Fixer is used to fix all executions in a shard. It is responsible for three things: 1. Confirming that each execution it scans is corrupted. 2. Attempting to fix any confirmed corrupted executions. 3. Recording skipped executions, failed to fix executions and successfully fix executions to durable store. 4. Producing a FixReport

func NewFixer

func NewFixer(
	ctx context.Context,
	shardID int,
	manager invariant.Manager,
	iterator store.ScanOutputIterator,
	blobstoreClient blobstore.Client,
	blobstoreFlushThreshold int,
	progressReportFn func(),
) Fixer

NewFixer constructs a new fixer

type ScanKeys

type ScanKeys struct {
	Corrupt *store.Keys
	Failed  *store.Keys
}

ScanKeys are the keys to the blobs that were uploaded during scan. Keys can be nil if there were no uploads.

type ScanReport

type ScanReport struct {
	ShardID int
	Stats   ScanStats
	Result  ScanResult
}

ScanReport is the report of running Scan on a single shard.

type ScanResult

type ScanResult struct {
	ShardScanKeys      *ScanKeys
	ControlFlowFailure *ControlFlowFailure
}

ScanResult indicates the result of running scan on a shard. Exactly one of ControlFlowFailure or ScanKeys will be non-nil

type ScanStats

type ScanStats struct {
	ExecutionsCount             int64
	CorruptedCount              int64
	CheckFailedCount            int64
	CorruptionByType            map[invariant.Name]int64
	CorruptedOpenExecutionCount int64
}

ScanStats indicates the stats of executions which were handled by shard Scan.

type Scanner

type Scanner interface {
	Scan() ScanReport
}

Scanner is used to scan over all executions in a shard. It is responsible for three things: 1. Checking invariants for each execution. 2. Recording corruption and failures to durable store. 3. Producing a ScanReport

func NewScanner

func NewScanner(
	ctx context.Context,
	shardID int,
	iterator pagination.Iterator,
	blobstoreClient blobstore.Client,
	blobstoreFlushThreshold int,
	manager invariant.Manager,
	progressReportFn func(),
) Scanner

NewScanner constructs a new scanner