global

Documentation

Index

• Variables
• func Debug(msg string, keysAndValues ...interface{})
• func Error(err error, msg string, keysAndValues ...interface{})
• func Handle(err error)
• func Info(msg string, keysAndValues ...interface{})
• func MeterProvider() metric.MeterProvider
• func SetErrorHandler(h ErrorHandler)
• func SetLogger(l logr.Logger)
• func SetMeterProvider(mp metric.MeterProvider)
• func SetTextMapPropagator(p propagation.TextMapPropagator)
• func SetTracerProvider(tp trace.TracerProvider)
• func TextMapPropagator() propagation.TextMapPropagator
• func TracerProvider() trace.TracerProvider
• func Warn(msg string, keysAndValues ...interface{})
• type ErrDelegator
  • func (d *ErrDelegator) Handle(err error)
• type ErrLogger
  • func (h *ErrLogger) Handle(err error)
• type ErrorHandler
  • func GetErrorHandler() ErrorHandler

Variables

var (
	// GlobalErrorHandler provides an ErrorHandler that can be used
	// throughout an OpenTelemetry instrumented project. When a user
	// specified ErrorHandler is registered (`SetErrorHandler`) all calls to
	// `Handle` and will be delegated to the registered ErrorHandler.
	GlobalErrorHandler = defaultErrorHandler()
)

Functions

func Debug

func Debug(msg string, keysAndValues ...interface{})

Debug prints messages about all internal changes in the API or SDK.

func Error

func Error(err error, msg string, keysAndValues ...interface{})

Error prints messages about exceptional states of the API or SDK.

func Handle

func Handle(err error)

Handle is a convenience function for ErrorHandler().Handle(err).

func Info

func Info(msg string, keysAndValues ...interface{})

Info prints messages about the general state of the API or SDK. This should usually be less than 5 messages a minute.

func MeterProvider

func MeterProvider() metric.MeterProvider

MeterProvider is the internal implementation for global.MeterProvider.

func SetErrorHandler

func SetErrorHandler(h ErrorHandler)

SetErrorHandler sets the global ErrorHandler to h.

The first time this is called all ErrorHandler previously returned from GetErrorHandler will send errors to h instead of the default logging ErrorHandler. Subsequent calls will set the global ErrorHandler, but not delegate errors to h.

func SetLogger

func SetLogger(l logr.Logger)

SetLogger overrides the globalLogger with l.

To see Warn messages use a logger with `l.V(1).Enabled() == true` To see Info messages use a logger with `l.V(4).Enabled() == true` To see Debug messages use a logger with `l.V(8).Enabled() == true`.

func SetMeterProvider

func SetMeterProvider(mp metric.MeterProvider)

SetMeterProvider is the internal implementation for global.SetMeterProvider.

func SetTextMapPropagator

func SetTextMapPropagator(p propagation.TextMapPropagator)

SetTextMapPropagator is the internal implementation for global.SetTextMapPropagator.

func SetTracerProvider

func SetTracerProvider(tp trace.TracerProvider)

SetTracerProvider is the internal implementation for global.SetTracerProvider.

func TextMapPropagator

func TextMapPropagator() propagation.TextMapPropagator

TextMapPropagator is the internal implementation for global.TextMapPropagator.

func TracerProvider

func TracerProvider() trace.TracerProvider

TracerProvider is the internal implementation for global.TracerProvider.

func Warn

func Warn(msg string, keysAndValues ...interface{})

Warn prints messages about warnings in the API or SDK. Not an error but is likely more important than an informational event.

Types

type ErrDelegator

type ErrDelegator struct {
	// contains filtered or unexported fields
}

func (*ErrDelegator) Handle

func (d *ErrDelegator) Handle(err error)

type ErrLogger

type ErrLogger struct {
	// contains filtered or unexported fields
}

ErrLogger logs errors if no delegate is set, otherwise they are delegated.

func (*ErrLogger) Handle

func (h *ErrLogger) Handle(err error)

Handle logs err if no delegate is set, otherwise it is delegated.

type ErrorHandler

type ErrorHandler interface {
	// Handle handles any error deemed irremediable by an OpenTelemetry
	// component.
	Handle(error)
}

ErrorHandler handles irremediable events.

func GetErrorHandler

func GetErrorHandler() ErrorHandler

GetErrorHandler returns the global ErrorHandler instance.

The default ErrorHandler instance returned will log all errors to STDERR until an override ErrorHandler is set with SetErrorHandler. All ErrorHandler returned prior to this will automatically forward errors to the set instance instead of logging.

Subsequent calls to SetErrorHandler after the first will not forward errors to the new ErrorHandler for prior returned instances.