observability

Documentation

Index

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

Variables

var (
	// Providers represents this package's offering to the dependency manager.
	Providers = wire.NewSet(
		wire.FieldsOf(new(*Config),
			"Metrics",
			"Tracing",
		),
	)
)

Functions

func AcknowledgeError

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

AcknowledgeError standardizes our error handling by logging and tracing consistently.

func NoteEvent

func NoteEvent(logger logging.Logger, span tracing.Span, descriptionFmt string, descriptionArgs ...interface{})

NoteEvent standardizes our logging and tracing notifications.

func PrepareError

func PrepareError(err error, logger logging.Logger, span tracing.Span, descriptionFmt string, descriptionArgs ...interface{}) error

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

Types

type Config

type Config struct {
	Tracing tracing.Config `json:"tracing" mapstructure:"tracing" toml:"tracing,omitempty"`
	Metrics metrics.Config `json:"metrics" mapstructure:"metrics" toml:"metrics,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.