telemetry

Documentation

Index

• Variables
• type Payload
• type Telemeter
  • func New(nodesStatusGetter nodesStatusGetter, schemaManager schemaManager, ...) *Telemeter
  • func (tel *Telemeter) Start(ctx context.Context) error
  • func (tel *Telemeter) Stop(ctx context.Context) error

Variables

var PayloadType = struct {
	Init      string
	Update    string
	Terminate string
}{
	Init:      "INIT",
	Update:    "UPDATE",
	Terminate: "TERMINATE",
}

PayloadType is the discrete set of statuses which indicate the type of payload sent

Types

type Payload

type Payload struct {
	MachineID   strfmt.UUID `json:"machineId"`
	Type        string      `json:"type"`
	Version     string      `json:"version"`
	NumObjects  int64       `json:"objs"`
	OS          string      `json:"os"`
	Arch        string      `json:"arch"`
	UsedModules []string    `json:"usedModules,omitempty"`
}

Payload is the object transmitted for telemetry purposes

type Telemeter

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

Telemeter is responsible for managing the transmission of telemetry data

func New

func New(nodesStatusGetter nodesStatusGetter, schemaManager schemaManager,
	logger logrus.FieldLogger,
) *Telemeter

New creates a new Telemeter instance

func (*Telemeter) Start

func (tel *Telemeter) Start(ctx context.Context) error

Start begins telemetry for the node

func (*Telemeter) Stop

func (tel *Telemeter) Stop(ctx context.Context) error

Stop shuts down the telemeter