metrics

Documentation

Overview

Package metrics implements k6/metrics and let script work with custom metrics.

Index

• Variables
• type Metric
• type ModuleInstance
  • func (mi *ModuleInstance) Exports() modules.Exports
  • func (mi *ModuleInstance) XCounter(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object
  • func (mi *ModuleInstance) XGauge(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object
  • func (mi *ModuleInstance) XRate(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object
  • func (mi *ModuleInstance) XTrend(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object
• type RootModule
  • func New() *RootModule
  • func (*RootModule) NewModuleInstance(m modules.VU) modules.Instance

Variables

var ErrMetricsAddInInitContext = common.NewInitContextError("Adding to metrics in the init context is not supported")

ErrMetricsAddInInitContext is error returned when adding to metric is done in the init context

Types

type Metric

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

Metric is a wrapper around custom metrics

type ModuleInstance

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

ModuleInstance represents an instance of the metrics module

func (*ModuleInstance) Exports

func (mi *ModuleInstance) Exports() modules.Exports

Exports returns the exports of the metrics module

func (*ModuleInstance) XCounter

func (mi *ModuleInstance) XCounter(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object

XCounter is a counter constructor

func (*ModuleInstance) XGauge

func (mi *ModuleInstance) XGauge(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object

XGauge is a gauge constructor

func (*ModuleInstance) XRate

func (mi *ModuleInstance) XRate(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object

XRate is a rate constructor

func (*ModuleInstance) XTrend

func (mi *ModuleInstance) XTrend(call sobek.ConstructorCall, rt *sobek.Runtime) *sobek.Object

XTrend is a trend constructor

type RootModule

type RootModule struct{}

RootModule is the root metrics module

func New

func New() *RootModule

New returns a new RootModule.

func (*RootModule) NewModuleInstance

func (*RootModule) NewModuleInstance(m modules.VU) modules.Instance

NewModuleInstance implements modules.Module interface