errors

func GetCauses ¶ added in v1.0.25

func GetCauses(err error) []Cause

GetCauses returns the nested causes of a MeshKit error created with NewV3, or nil for any other error (including New and NewV2 errors, whose flat lists are unpaired).

func Is ¶

func Is(err error) (*Error, bool)

func New ¶

func New(code string, severity Severity, sdescription []string, ldescription []string, probablecause []string, remedy []string) *Error

New returns a MeshKit error using the provided parameters.

In order to create MeshKit compatible errors that can be handled by the errorutil tool, consider the following points:

The first parameter, 'code', has to be passed as the error code constant (or variable), not a string literal.

The second parameter, 'severity', has its own type; consult its Go-doc for further details.

The remaining parameters are string arrays for short and long description, probable cause, and suggested remediation. Use string literals in these string arrays, not constants or variables, for any static texts or format strings. Capitalize the first letter of each statement. Call expressions can be used but will be ignored by the tool when exporting error details for the documentation. Do not concatenate strings using the '+' operator, just add multiple elements to the string array.

Example:

errors.New(ErrConnectCode,
           errors.Alert,
           []string{"Connection to broker failed"},
           []string{err.Error()},
           []string{"Endpoint might not be reachable"},
           []string{"Make sure the NATS endpoint is reachable"})

func AsErrorV2 ¶ added in v1.0.25

func AsErrorV2(err error) (ErrorV2, bool)

AsErrorV2 returns the MeshKit error in err's chain as an ErrorV2 value: the *ErrorV2 itself, or an *Error converted with no AdditionalInfo. ok is false when err carries no MeshKit error. It gives readers the raw description, cause and remediation lines (and Causes for NewV3) without the joining the Get* accessors apply.

func NewV2 ¶

func NewV2(code string, severity Severity, sdescription []string, ldescription []string, probablecause []string, remedy []string, additionalInfo interface{}) *ErrorV2

func NewV3 ¶ added in v1.0.25

func NewV3(code string, severity Severity, sdescription []string, ldescription []string, causes []Cause) *ErrorV2

NewV3 returns a MeshKit error whose probable causes each carry the remediations that answer them (meshery/meshkit#1138, meshery/schemas#1334).

The flat ProbableCause and SuggestedRemediation fields, and so GetCause, GetRemedy, Error() and every existing reader, are derived from causes with FlattenCauses. An empty ActionPolicy is stored as Manual. An unknown policy is kept as written, never coerced: ValidateCauses and errorutil reject it, and EffectivePolicy treats it as Manual so nothing runs by mistake.

As with New and NewV2, pass the code constant, and write every description, id, action and policy as a string literal (or a package-level Remediation variable for a shared remediation) so errorutil can export the definition.

Example:

var remReconnect = errors.Remediation{ID: "reconnect", Description: "Reconnect once the cluster is reachable.",
    Action: "connection.reconnect", ActionPolicy: errors.RequiresApproval}

errors.NewV3(ErrConnectCode, errors.Alert,
    []string{"Unable to connect to the cluster"},
    []string{"Meshery Server could not reach the cluster's API server"},
    []errors.Cause{
        {ID: "cluster-unreachable", Description: "The cluster's API server is not reachable.",
            Remediations: []errors.Remediation{
                {ID: "check-network", Description: "Check the network path to the API server."},
                remReconnect,
            }},
        {ID: "credentials-expired", Description: "The connection's credentials have expired.",
            Remediations: []errors.Remediation{
                {ID: "refresh-credentials", Description: "Refresh the credentials.",
                    Action: "connection.refresh-credentials", ActionPolicy: errors.Automatic},
                remReconnect,
            }},
    })

errorutil rejects description lists or causes not written as []string and []errors.Cause literals (a variable or nil, for example), and any description element that is not a string literal. To carry instance text such as err.Error(), append it to the returned error's LongDescription after NewV3 returns.

func GetSeverity ¶

func GetSeverity(err error) Severity

func SeverityNamed ¶ added in v1.0.25

func SeverityNamed(name string) (Severity, bool)

SeverityNamed returns the MeshKit Severity whose constant is named name, as errorutil reads it from source (`Alert` for errors.Alert).