expv2

Documentation

Overview

Package expv2 contains a Cloud output using a Protobuf binary format for encoding payloads.

Index

• type Output
  • func New(logger logrus.FieldLogger, conf cloudapi.Config, cloudClient *cloudapi.Client) (*Output, error)
  • func (o *Output) AddMetricSamples(s []metrics.SampleContainer)
  • func (o *Output) SetReferenceID(refID string)
  • func (o *Output) SetTestRunStopCallback(stopFunc func(error))
  • func (o *Output) Start() error
  • func (o *Output) StopWithTestError(testErr error) error

Types

type Output

type Output struct {
	output.SampleBuffer
	// contains filtered or unexported fields
}

Output sends result data to the k6 Cloud service.

func New

func New(logger logrus.FieldLogger, conf cloudapi.Config, cloudClient *cloudapi.Client) (*Output, error)

New creates a new cloud output.

func (*Output) AddMetricSamples

func (o *Output) AddMetricSamples(s []metrics.SampleContainer)

AddMetricSamples receives the samples streaming.

func (*Output) SetReferenceID

func (o *Output) SetReferenceID(refID string)

SetReferenceID sets the Cloud's test run ID.

func (*Output) SetTestRunStopCallback

func (o *Output) SetTestRunStopCallback(stopFunc func(error))

SetTestRunStopCallback receives the function that that stops the engine when it is called. It should be called on critical errors.

func (*Output) Start

func (o *Output) Start() error

Start starts the goroutine that would listen for metric samples and send them to the cloud.

func (*Output) StopWithTestError

func (o *Output) StopWithTestError(testErr error) error

StopWithTestError gracefully stops all metric emission from the output.