Documentation
¶
Index ¶
- func ExecutionsScannerWorkflow(ctx workflow.Context) error
- func ExecutionsScavengerActivity(activityCtx context.Context) error
- func HistoryScannerWorkflow(ctx workflow.Context) error
- func HistoryScavengerActivity(activityCtx context.Context) (history.ScavengerHeartbeatDetails, error)
- func TaskQueueScannerWorkflow(ctx workflow.Context) error
- func TaskQueueScavengerActivity(activityCtx context.Context) error
- type Config
- type Scanner
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExecutionsScannerWorkflow ¶ added in v0.27.0
func ExecutionsScannerWorkflow(
ctx workflow.Context,
) error
ExecutionsScannerWorkflow is the workflow that runs the executions scanner background daemon
func ExecutionsScavengerActivity ¶ added in v0.27.0
func ExecutionsScavengerActivity(
activityCtx context.Context,
) error
ExecutionsScavengerActivity is the activity that runs executions scavenger
func HistoryScannerWorkflow ¶ added in v0.27.0
func HistoryScannerWorkflow(
ctx workflow.Context,
) error
HistoryScannerWorkflow is the workflow that runs the history scanner background daemon
func HistoryScavengerActivity ¶ added in v0.27.0
func HistoryScavengerActivity(
activityCtx context.Context,
) (history.ScavengerHeartbeatDetails, error)
HistoryScavengerActivity is the activity that runs history scavenger
func TaskQueueScannerWorkflow ¶ added in v0.27.0
func TaskQueueScannerWorkflow(
ctx workflow.Context,
) error
TaskQueueScannerWorkflow is the workflow that runs the task queue scanner background daemon
func TaskQueueScavengerActivity ¶ added in v0.27.0
func TaskQueueScavengerActivity(
activityCtx context.Context,
) error
TaskQueueScavengerActivity is the activity that runs task queue scavenger
Types ¶
type Config ¶
type Config struct {
MaxConcurrentActivityExecutionSize dynamicconfig.IntPropertyFn
MaxConcurrentWorkflowTaskExecutionSize dynamicconfig.IntPropertyFn
MaxConcurrentActivityTaskPollers dynamicconfig.IntPropertyFn
MaxConcurrentWorkflowTaskPollers dynamicconfig.IntPropertyFn
// PersistenceMaxQPS the max rate of calls to persistence
PersistenceMaxQPS dynamicconfig.IntPropertyFn
// Persistence contains the persistence configuration
Persistence *config.Persistence
// TaskQueueScannerEnabled indicates if taskQueue scanner should be started as part of scanner
TaskQueueScannerEnabled dynamicconfig.BoolPropertyFn
// BuildIdScavengerEnabled indicates if the build id scavenger should be started as part of scanner
BuildIdScavengerEnabled dynamicconfig.BoolPropertyFn
// HistoryScannerEnabled indicates if history scanner should be started as part of scanner
HistoryScannerEnabled dynamicconfig.BoolPropertyFn
// ExecutionsScannerEnabled indicates if executions scanner should be started as part of scanner
ExecutionsScannerEnabled dynamicconfig.BoolPropertyFn
// HistoryScannerDataMinAge indicates the cleanup threshold of history branch data
// Only clean up history branches that older than this threshold
HistoryScannerDataMinAge dynamicconfig.DurationPropertyFn
// HistoryScannerVerifyRetention indicates if the history scavenger to do retention verification
HistoryScannerVerifyRetention dynamicconfig.BoolPropertyFn
// ExecutionScannerPerHostQPS the max rate of calls to scan execution data per host
ExecutionScannerPerHostQPS dynamicconfig.IntPropertyFn
// ExecutionScannerPerShardQPS the max rate of calls to scan execution data per shard
ExecutionScannerPerShardQPS dynamicconfig.IntPropertyFn
// ExecutionDataDurationBuffer is the data TTL duration buffer of execution data
ExecutionDataDurationBuffer dynamicconfig.DurationPropertyFn
// ExecutionScannerWorkerCount is the execution scavenger task worker number
ExecutionScannerWorkerCount dynamicconfig.IntPropertyFn
// ExecutionScannerHistoryEventIdValidator indicates if the execution scavenger to validate history event id.
ExecutionScannerHistoryEventIdValidator dynamicconfig.BoolPropertyFn
// RemovableBuildIdDurationSinceDefault is the minimum duration since a build id was last default in its
// containing set for it to be considered for removal.
RemovableBuildIdDurationSinceDefault dynamicconfig.DurationPropertyFn
// BuildIdScavengerVisibilityRPS is the rate limit for visibility calls from the build id scavenger
BuildIdScavengerVisibilityRPS dynamicconfig.FloatPropertyFn
}
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 anamolies and emit stats for analytics
func New ¶
func New(
logger log.Logger,
cfg *Config,
sdkClientFactory sdk.ClientFactory,
metricsHandler metrics.Handler,
executionManager persistence.ExecutionManager,
metadataManager persistence.MetadataManager,
visibilityManager manager.VisibilityManager,
taskManager persistence.TaskManager,
historyClient historyservice.HistoryServiceClient,
adminClient adminservice.AdminServiceClient,
matchingClient matchingservice.MatchingServiceClient,
registry namespace.Registry,
currentClusterName string,
) *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