executions

Documentation

Index

• type ScannerWorkflowParams
• type Scavenger
  • func NewScavenger(params ScannerWorkflowParams, frontendClient frontend.Client, ...) *Scavenger
  • func (s *Scavenger) Alive() bool
  • func (s *Scavenger) Start()
  • func (s *Scavenger) Stop()

Types

type ScannerWorkflowParams

type ScannerWorkflowParams struct {
	VisibilityQuery string // optionally can be provided to limit the scope of the scan

}

ScannerWorkflowParams are the parameters passed to the executions scanner workflow

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(
	params ScannerWorkflowParams,
	frontendClient frontend.Client,
	historyDB p.HistoryManager,
	metricsClient metrics.Client,
	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