observability

Documentation

Index

• Variables
• func AcknowledgeError(err error, logger logging.Logger, span tracing.Span, descriptionFmt string, ...)
• func PrepareAndLogError(err error, logger logging.Logger, span tracing.Span, descriptionFmt string, ...) error
• func PrepareError(err error, span tracing.Span, descriptionFmt string, descriptionArgs ...any) error
• type Config
  • func (cfg *Config) ValidateWithContext(ctx context.Context) error

Variables

var (
	ProvidersObservability = wire.NewSet(
		wire.FieldsOf(
			new(*Config),
			"Logging",
			"Tracing",
		),
	)
)

Functions

func AcknowledgeError

func AcknowledgeError(err error, logger logging.Logger, span tracing.Span, descriptionFmt string, descriptionArgs ...any)

AcknowledgeError standardizes our error handling by logging and tracing consistently.

func PrepareAndLogError

func PrepareAndLogError(err error, logger logging.Logger, span tracing.Span, descriptionFmt string, descriptionArgs ...any) error

PrepareAndLogError standardizes our error handling by logging, tracing, and formatting an error consistently.

func PrepareError

func PrepareError(err error, span tracing.Span, descriptionFmt string, descriptionArgs ...any) error

PrepareError standardizes our error handling by logging, tracing, and formatting an error consistently.

Types

type Config

type Config struct {
	Logging loggingcfg.Config `json:"logging" toml:"logging,omitempty"`
	Tracing tracingcfg.Config `json:"tracing" toml:"tracing,omitempty"`
	// contains filtered or unexported fields
}

Config contains settings about how we report our metrics.

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.