history

Documentation

Index

• type Scavenger
  • func NewScavenger(db p.HistoryManager, rps int, client history.Client, ...) *Scavenger
  • func (s *Scavenger) Run(ctx context.Context) (ScavengerHeartbeatDetails, error)
• type ScavengerHeartbeatDetails

Types

type Scavenger

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

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

func NewScavenger

func NewScavenger(
	db p.HistoryManager,
	rps int,
	client history.Client,
	hbd ScavengerHeartbeatDetails,
	metricsClient metrics.Client,
	logger log.Logger,
	maxWorkflowRetentionInDays dynamicconfig.IntPropertyFn,
	domainCache cache.DomainCache,
) *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 {
	NextPageToken []byte
	CurrentPage   int
	SkipCount     int
	ErrorCount    int
	SuccCount     int
}

ScavengerHeartbeatDetails is the heartbeat detail for HistoryScavengerActivity