builtins

Documentation

Overview

Package builtins marshals internal (non-plugin) metric collectors (e.g. procfs, wmi, etc.)

Index

• type Builtins
  • func New(ctx context.Context) (*Builtins, error)
  • func (b *Builtins) Flush(id string) *cgm.Metrics
  • func (b *Builtins) IsBuiltin(id string) bool
  • func (b *Builtins) Run(ctx context.Context, id string) error

Types

type Builtins

type Builtins struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Builtins defines the internal metric collector manager

func New

func New(ctx context.Context) (*Builtins, error)

New creates a new builtins manager

func (*Builtins) Flush

func (b *Builtins) Flush(id string) *cgm.Metrics

Flush returns current metrics for all collectors

func (*Builtins) IsBuiltin

func (b *Builtins) IsBuiltin(id string) bool

IsBuiltin determines if an id is a builtin or not

func (*Builtins) Run

func (b *Builtins) Run(ctx context.Context, id string) error

Run triggers internal collectors to gather metrics