invariant

Documentation

Index

• func MarshalData(rc any) []byte
• type Invariant
• type InvariantCheckInput
• type InvariantCheckResult
• type InvariantRootCauseInput
• type InvariantRootCauseResult
• type RootCause
  • func (r RootCause) String() string

Functions

func MarshalData

func MarshalData(rc any) []byte

Types

type Invariant

type Invariant interface {
	Check(context.Context, InvariantCheckInput) ([]InvariantCheckResult, error)
	RootCause(context.Context, InvariantRootCauseInput) ([]InvariantRootCauseResult, error)
}

Invariant represents a condition of a workflow execution.

type InvariantCheckInput

type InvariantCheckInput struct {
	WorkflowExecutionHistory *types.GetWorkflowExecutionHistoryResponse
	Domain                   string
}

type InvariantCheckResult

type InvariantCheckResult struct {
	InvariantType string
	Reason        string
	Metadata      []byte
}

InvariantCheckResult is the result from the invariant check

type InvariantRootCauseInput

type InvariantRootCauseInput struct {
	Domain string
	Issues []InvariantCheckResult
}

type InvariantRootCauseResult

type InvariantRootCauseResult struct {
	RootCause RootCause
	Metadata  []byte
}

InvariantRootCauseResult is the root cause for the issues identified in the invariant check

type RootCause

type RootCause string

const (
	RootCauseTypeMissingPollers                        RootCause = "There are no pollers for the tasklist"
	RootCauseTypePollersStatus                         RootCause = "There are pollers for the tasklist. Check backlog status"
	RootCauseTypeNoHeartBeatTimeoutNoRetryPolicy       RootCause = "Heartbeat timeout and retry policy are not configured"
	RootCauseTypeHeartBeatingNotEnabledWithRetryPolicy RootCause = "Heartbeat timeout not enabled for activity but there is a retry policy configured"
	RootCauseTypeHeartBeatingEnabledWithoutRetryPolicy RootCause = "Heartbeat timeout enabled for activity but there is no retry policy configured"
	RootCauseTypeHeartBeatingEnabledMissingHeartbeat   RootCause = "Heartbeat timeout enabled for activity but timed out due to missing heartbeat"
	RootCauseTypeServiceSideIssue                      RootCause = "There is an issue in the worker service that is causing a failure. Check identity for service logs"
	RootCauseTypeServiceSidePanic                      RootCause = "There is a panic in the activity/workflow that is causing a failure"
	RootCauseTypeServiceSideCustomError                RootCause = "Customised error returned by the activity/workflow"
	RootCauseTypeBlobSizeLimit                         RootCause = "Workflow has exceeded the blob size limits configured for the domain"
)

func (RootCause) String

func (r RootCause) String() string