history

Documentation

Index

• type Scavenger
  • func NewScavenger(numShards int32, db persistence.ExecutionManager, rps int, ...) *Scavenger
  • func (s *Scavenger) Run(ctx context.Context) (ScavengerHeartbeatDetails, error)
• type ScavengerHeartbeatDetails

Types

type Scavenger

type Scavenger struct {
	sync.WaitGroup
	sync.Mutex
	// contains filtered or unexported fields
}

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

func NewScavenger

func NewScavenger(
	numShards int32,
	db persistence.ExecutionManager,
	rps int,
	client historyservice.HistoryServiceClient,
	adminClient adminservice.AdminServiceClient,
	registry namespace.Registry,
	hbd ScavengerHeartbeatDetails,
	historyDataMinAge dynamicconfig.DurationPropertyFn,
	executionDataDurationBuffer dynamicconfig.DurationPropertyFn,
	enableRetentionVerification dynamicconfig.BoolPropertyFn,
	metricsClient metrics.Client,
	logger log.Logger,
) *Scavenger

NewScavenger returns an instance of history scavenger daemon The Scavenger can be started by calling the Run() method on the returned object. Calling the Run() method will result in one complete iteration over all of the history branches in the system. For each branch, the scavenger will attempt

• describe the corresponding workflow execution
• deletion of history itself, if there are no workflow execution

func (*Scavenger) Run

func (s *Scavenger) Run(ctx context.Context) (ScavengerHeartbeatDetails, error)

Run runs the scavenger

type ScavengerHeartbeatDetails

type ScavengerHeartbeatDetails struct {
	SuccessCount int
	ErrorCount   int
	SkipCount    int
	CurrentPage  int

	NextPageToken []byte
}

ScavengerHeartbeatDetails is the heartbeat detail for HistoryScavengerActivity