observability

package

v0.0.0-...-9518a5e Latest Latest Go to latest Published: Oct 6, 2021 License: MIT Imports: 9 Imported by: 0

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

Repository

gitlab.com/verygoodsoftwarenotvirus/todo

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
keys
logging
metrics Package metrics provides metrics collection functions and structs	Package metrics provides metrics collection functions and structs
mock Package mock provides mockable implementations of every interface defined in the outer metrics package.	Package mock provides mockable implementations of every interface defined in the outer metrics package.
tracing Package tracing provides common functions for attaching values to trace spans	Package tracing provides common functions for attaching values to trace spans

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL