github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/engine/framework/config/timeouts.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package config
    15  
    16  import "time"
    17  
    18  // TimeoutConfig defines timeout related config used in master-worker framework
    19  type TimeoutConfig struct {
    20  	WorkerTimeoutDuration            time.Duration
    21  	WorkerTimeoutGracefulDuration    time.Duration
    22  	WorkerHeartbeatInterval          time.Duration
    23  	WorkerReportStatusInterval       time.Duration
    24  	MasterHeartbeatCheckLoopInterval time.Duration
    25  	CloseWorkerTimeout               time.Duration
    26  }
    27  
    28  var defaultTimeoutConfig = TimeoutConfig{
    29  	WorkerTimeoutDuration:            time.Second * 15,
    30  	WorkerTimeoutGracefulDuration:    time.Second * 5,
    31  	WorkerHeartbeatInterval:          time.Second * 3,
    32  	WorkerReportStatusInterval:       time.Second * 3,
    33  	MasterHeartbeatCheckLoopInterval: time.Second * 1,
    34  	CloseWorkerTimeout:               time.Second * 3,
    35  }.Adjust()
    36  
    37  // Adjust validates the TimeoutConfig and adjusts it
    38  func (config TimeoutConfig) Adjust() TimeoutConfig {
    39  	var tc TimeoutConfig = config
    40  	// worker timeout duration must be 2 times larger than worker heartbeat interval
    41  	if tc.WorkerTimeoutDuration < 2*tc.WorkerHeartbeatInterval+time.Second*3 {
    42  		tc.WorkerTimeoutDuration = 2*tc.WorkerHeartbeatInterval + time.Second*3
    43  	}
    44  	return tc
    45  }
    46  
    47  // DefaultTimeoutConfig returns a default timeout config
    48  func DefaultTimeoutConfig() TimeoutConfig {
    49  	return defaultTimeoutConfig
    50  }