executions

Documentation

Index

• func NewHistoryEventIDValidator(shardID int32, executionManager persistence.ExecutionManager) *historyEventIDValidator
• func NewMutableStateValidator(registry namespace.Registry, ...) *mutableStateValidator
• type MutableState
• type MutableStateValidationResult
• type Scavenger
  • func NewScavenger(activityContext context.Context, numHistoryShards int32, ...) *Scavenger
  • func (s *Scavenger) Alive() bool
  • func (s *Scavenger) Start()
  • func (s *Scavenger) Stop()
• type Validator

Functions

func NewHistoryEventIDValidator

func NewHistoryEventIDValidator(
	shardID int32,
	executionManager persistence.ExecutionManager,
) *historyEventIDValidator

NewHistoryEventIDValidator returns new instance.

func NewMutableStateValidator

func NewMutableStateValidator(
	registry namespace.Registry,
	executionDataDurationBuffer dynamicconfig.DurationPropertyFn,
) *mutableStateValidator

NewMutableStateValidator returns new instance.

Types

type MutableState

type MutableState struct {
	*persistencespb.WorkflowMutableState
}

type MutableStateValidationResult

type MutableStateValidationResult struct {
	// contains filtered or unexported fields
}

type Scavenger

type Scavenger struct {
	// contains filtered or unexported fields
}

Scavenger is the type that holds the state for executions scavenger daemon

func NewScavenger

func NewScavenger(
	activityContext context.Context,
	numHistoryShards int32,
	perHostQPS dynamicconfig.IntPropertyFn,
	perShardQPS dynamicconfig.IntPropertyFn,
	executionDataDurationBuffer dynamicconfig.DurationPropertyFn,
	executionTaskWorker dynamicconfig.IntPropertyFn,
	enableHistoryEventIDValidator dynamicconfig.BoolPropertyFn,
	executionManager persistence.ExecutionManager,
	registry namespace.Registry,
	historyClient historyservice.HistoryServiceClient,
	adminClient adminservice.AdminServiceClient,
	metricsHandler metrics.Handler,
	logger log.Logger,
) *Scavenger

NewScavenger returns an instance of executions scavenger daemon The Scavenger can be started by calling the Start() method on the returned object. Calling the Start() method will result in one complete iteration over all of the open workflow executions in the system. For each executions, will attempt to validate the workflow execution and emit metrics/logs on validation failures.

The scavenger will retry on all persistence errors infinitely and will only stop under two conditions

• either all executions are processed successfully (or)
• Stop() method is called to stop the scavenger

func (*Scavenger) Alive

func (s *Scavenger) Alive() bool

Alive returns true if the scavenger is still running

func (*Scavenger) Start

func (s *Scavenger) Start()

Start starts the scavenger

func (*Scavenger) Stop

func (s *Scavenger) Stop()

Stop stops the scavenger

type Validator

type Validator interface {
	Validate(ctx context.Context, mutableState *MutableState) ([]MutableStateValidationResult, error)
}