go.temporal.io/server@v1.23.0/common/pingable.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package common
    26  
    27  import "time"
    28  
    29  type (
    30  	// Pingable is interface to check for liveness of a component, to detect deadlocks.
    31  	// This call should not block.
    32  	Pingable interface {
    33  		GetPingChecks() []PingCheck
    34  	}
    35  
    36  	PingCheck struct {
    37  		// Name of this component.
    38  		Name string
    39  		// The longest time that Ping can take. If it doesn't return in that much time, that's
    40  		// considered a deadlock and the deadlock detector may take actions to recover, like
    41  		// killing the process.
    42  		Timeout time.Duration
    43  		// Perform the check. The typical implementation will just be Lock() and then Unlock()
    44  		// on a mutex, returning nil. Ping can also return more Pingables for sub-components
    45  		// that will be checked independently. These should form a tree and not lead to cycles.
    46  		Ping func() []Pingable
    47  
    48  		// Metrics recording:
    49  		// Timer id within DeadlockDetectorScope (or zero for no metrics)
    50  		MetricsName string
    51  	}
    52  )