telemetry

Documentation

Index

• func SpanContext(ctx context.Context, methodName string) (context.Context, trace.Span)
• func Version() string
• type ActorMetrics
  • func NewMetrics(meter metric.Meter) (*ActorMetrics, error)
• type Option
  • func WithMeterProvider(provider metric.MeterProvider) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option
• type OptionFunc
  • func (f OptionFunc) Apply(c *Telemetry)
• type SystemMetrics
  • func NewSystemMetrics(meter metric.Meter) (*SystemMetrics, error)
• type Telemetry
  • func New(options ...Option) *Telemetry

Functions

func SpanContext

func SpanContext(ctx context.Context, methodName string) (context.Context, trace.Span)

func Version

func Version() string

Version is the current release version of goakt in use.

Types

type ActorMetrics

type ActorMetrics struct {
	// captures the number of times a given actor has panic
	PanicCount metric.Int64ObservableCounter
	// captures the actor mailbox size
	MailboxSize metric.Int64ObservableGauge
	// captures the number of time the actor has restarted
	RestartedCount metric.Int64ObservableCounter
	// captures the count of messages received by the actor
	ReceivedCount metric.Int64ObservableCounter
	// captures the duration of message received and processed
	ReceivedDurationHistogram metric.Float64Histogram
}

ActorMetrics define the type of metrics we are collecting from an actor

func NewMetrics

func NewMetrics(meter metric.Meter) (*ActorMetrics, error)

NewMetrics creates an instance of ActorMetrics

type Option

type Option interface {
	// Apply sets the Option value of a config.
	Apply(config *Telemetry)
}

Option is the interface that applies a configuration option.

func WithMeterProvider

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.

type OptionFunc

type OptionFunc func(*Telemetry)

OptionFunc implements the Option interface.

func (OptionFunc) Apply

func (f OptionFunc) Apply(c *Telemetry)

type SystemMetrics

type SystemMetrics struct {
	// captures the number of actors in the actor system
	ActorSystemActorsCount metric.Int64ObservableCounter
}

SystemMetrics define the type of metrics we are collecting from the actor system

func NewSystemMetrics

func NewSystemMetrics(meter metric.Meter) (*SystemMetrics, error)

NewSystemMetrics creates an instance of ActorMetrics

type Telemetry

type Telemetry struct {
	TracerProvider trace.TracerProvider
	Tracer         trace.Tracer

	MeterProvider metric.MeterProvider
	Meter         metric.Meter

	Metrics *ActorMetrics
}

Telemetry encapsulates some settings for an actor

func New

func New(options ...Option) *Telemetry

New creates an instance of Telemetry