runtimeemitter

Documentation

Index

• type Emitter
  • func New(sender Sender, opts ...RuntimeEmitterOption) *Emitter
  • func NewV1(sender V1Sender, opts ...RuntimeEmitterOption) *Emitter
  • func (e *Emitter) Run()
• type RuntimeEmitterOption
  • func WithInterval(d time.Duration) RuntimeEmitterOption
• type Sender
• type V1Sender

Types

type Emitter

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

Emitter will emit a gauge with runtime stats via the sender on the given interval. default interval is 15 seconds.

func New

func New(sender Sender, opts ...RuntimeEmitterOption) *Emitter

New returns an Emitter that is configured with the given sender and RuntimeEmitterOptions.

func NewV1

func NewV1(sender V1Sender, opts ...RuntimeEmitterOption) *Emitter

NewV1 returns an Emitter that is configured with the given v1 sender and RuntimeEmitterOptions.

func (*Emitter) Run

func (e *Emitter) Run()

Run starts the ticker with the configured interval and emits a gauge on that interval. This method will block but the user may run in a go routine.

type RuntimeEmitterOption

type RuntimeEmitterOption func(e *Emitter)

RuntimeEmitterOption is the option provides configuration for an Emitter.

func WithInterval

func WithInterval(d time.Duration) RuntimeEmitterOption

WithInterval returns a RuntimeEmitterOption to configure the interval at which the runtime emitter emits gauges.

type Sender

type Sender interface {
	EmitGauge(opts ...loggregator.EmitGaugeOption)
}

Sender is the interface of the client that can be used to emit gauge metrics.

type V1Sender

type V1Sender interface {
	SendComponentMetric(name string, value float64, unit string) error
}

V1Sender is the interface of the v1 client that can be used to emit value metrics.