scanner

Documentation

Index

• func HistoryScannerWorkflow(ctx workflow.Context) error
• func HistoryScavengerActivity(activityCtx context.Context) (history.ScavengerHeartbeatDetails, error)
• func TaskListScannerWorkflow(ctx workflow.Context) error
• func TaskListScavengerActivity(activityCtx context.Context) error
• type BootstrapParams
• type Config
• type Scanner
  • func New(resource resource.Resource, params *BootstrapParams) *Scanner
  • func (s *Scanner) Start() error

Functions

func HistoryScannerWorkflow

func HistoryScannerWorkflow(
	ctx workflow.Context,
) error

HistoryScannerWorkflow is the workflow that runs the history scanner background daemon

func HistoryScavengerActivity

func HistoryScavengerActivity(
	activityCtx context.Context,
) (history.ScavengerHeartbeatDetails, error)

HistoryScavengerActivity is the activity that runs history scavenger

func TaskListScannerWorkflow

func TaskListScannerWorkflow(
	ctx workflow.Context,
) error

TaskListScannerWorkflow is the workflow that runs the task-list scanner background daemon

func TaskListScavengerActivity

func TaskListScavengerActivity(
	activityCtx context.Context,
) error

TaskListScavengerActivity is the activity that runs task list scavenger

Types

type BootstrapParams

type BootstrapParams struct {
	// Config contains the configuration for scanner
	Config Config
	// TallyScope is an instance of tally metrics scope
	TallyScope tally.Scope
}

BootstrapParams contains the set of params needed to bootstrap the scanner sub-system

type Config

type Config struct {
	// ScannerPersistenceMaxQPS the max rate of calls to persistence
	// Right now is being used by historyScanner to determine the rate of persistence API calls
	ScannerPersistenceMaxQPS dynamicconfig.IntPropertyFn
	// Persistence contains the persistence configuration
	Persistence *config.Persistence
	// ClusterMetadata contains the metadata for this cluster
	ClusterMetadata cluster.Metadata
	// TaskListScannerEnabled indicates if taskList scanner should be started as part of scanner
	TaskListScannerEnabled dynamicconfig.BoolPropertyFn
	// HistoryScannerEnabled indicates if history scanner should be started as part of scanner
	HistoryScannerEnabled dynamicconfig.BoolPropertyFn
	// ShardScanners is a list of shard scanner configs
	ShardScanners []*shardscanner.ScannerConfig
}

Config defines the configuration for scanner

type Scanner

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

Scanner is the background sub-system that does full scans of database tables to cleanup resources, monitor anomalies and emit stats for analytics

func New

func New(
	resource resource.Resource,
	params *BootstrapParams,
) *Scanner

New returns a new instance of scanner daemon Scanner is the background sub-system that does full scans of database tables in an attempt to cleanup resources, monitor system anamolies and emit stats for analysis and alerting

func (*Scanner) Start

func (s *Scanner) Start() error

Start starts the scanner