restarts

Documentation

Index

• Constants
• type RestartTracker
  • func NewRestartTracker(policy *structs.RestartPolicy, jobType string, ...) *RestartTracker
  • func (r *RestartTracker) GetCount() int
  • func (r *RestartTracker) GetPolicy() *structs.RestartPolicy
  • func (r *RestartTracker) GetReason() string
  • func (r *RestartTracker) GetState() (string, time.Duration)
  • func (r *RestartTracker) SetExitResult(res *drivers.ExitResult) *RestartTracker
  • func (r *RestartTracker) SetKilled() *RestartTracker
  • func (r *RestartTracker) SetPolicy(policy *structs.RestartPolicy)
  • func (r *RestartTracker) SetRestartTriggered(failure bool) *RestartTracker
  • func (r *RestartTracker) SetStartError(err error) *RestartTracker

Constants

const (
	ReasonNoRestartsAllowed  = "Policy allows no restarts"
	ReasonUnrecoverableError = "Error was unrecoverable"
	ReasonWithinPolicy       = "Restart within policy"
	ReasonDelay              = "Exceeded allowed attempts, applying a delay"
)

Types

type RestartTracker

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

func NewRestartTracker

func NewRestartTracker(policy *structs.RestartPolicy, jobType string, tlc *structs.TaskLifecycleConfig) *RestartTracker

func (*RestartTracker) GetCount

func (r *RestartTracker) GetCount() int

GetCount returns the current restart count

func (*RestartTracker) GetPolicy

func (r *RestartTracker) GetPolicy() *structs.RestartPolicy

GetPolicy returns a copy of the policy used to determine restarts.

func (*RestartTracker) GetReason

func (r *RestartTracker) GetReason() string

GetReason returns a human-readable description for the last state returned by GetState.

func (*RestartTracker) GetState

func (r *RestartTracker) GetState() (string, time.Duration)

GetState returns the tasks next state given the set exit code and start error. One of the following states are returned:

• TaskRestarting - Task should be restarted
• TaskNotRestarting - Task should not be restarted and has exceeded its restart policy.
• TaskTerminated - Task has terminated successfully and does not need a restart.

If TaskRestarting is returned, the duration is how long to wait until starting the task again.

func (*RestartTracker) SetExitResult

func (r *RestartTracker) SetExitResult(res *drivers.ExitResult) *RestartTracker

SetExitResult is used to mark the most recent wait result.

func (*RestartTracker) SetKilled

func (r *RestartTracker) SetKilled() *RestartTracker

SetKilled is used to mark that the task has been killed.

func (*RestartTracker) SetPolicy

func (r *RestartTracker) SetPolicy(policy *structs.RestartPolicy)

SetPolicy updates the policy used to determine restarts.

func (*RestartTracker) SetRestartTriggered

func (r *RestartTracker) SetRestartTriggered(failure bool) *RestartTracker

SetRestartTriggered is used to mark that the task has been signalled to be restarted. Setting the failure to true restarts according to the restart policy. When failure is false the task is restarted without considering the restart policy.

func (*RestartTracker) SetStartError

func (r *RestartTracker) SetStartError(err error) *RestartTracker

SetStartError is used to mark the most recent start error. If starting was successful the error should be nil.