errors

package

v0.29.1 Latest Latest Go to latest Published: Apr 15, 2022 License: Apache-2.0 Imports: 3 Imported by: 12

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type AgentError struct {
	Description string
	Suggestion  string
	Details     ErrorDetails
}

AgentError is an error that occurs in the agent.

func NewError(description string, suggestion string, keyValues ...string) AgentError

NewError will create a new agent error.

func WithDetails(err error, keyValues ...string) AgentError

WithDetails will add details to an agent error

func Wrap(err error, context string) AgentError

Wrap adds context to the description for richer logs

func (e AgentError) Error() string

Error will return the error message.

func (e AgentError) MarshalLogObject(encoder zapcore.ObjectEncoder) error

MarshalLogObject will define the representation of this error when logging.

func (e AgentError) WithDetails(keyValues ...string) AgentError

WithDetails will return the error with additional details

type ErrorDetails map[string]string

ErrorDetails is a map of details for an agent error.

func (d ErrorDetails) MarshalLogObject(encoder zapcore.ObjectEncoder) error

MarshalLogObject will define the representation of details when logging.