template

Documentation

Overview

Package template performs output operations for the extension

Index

• type Config
  • func NewConfig(p output.Params) (Config, error)
• type Output
  • func New(p output.Params) (*Output, error)
  • func (o *Output) Description() string
  • func (o *Output) Start() error
  • func (o *Output) Stop() error
  • func (o *Output) StopWithTestError(testErr error) error

Types

type Config

type Config struct {
	Address      string
	PushInterval time.Duration
}

Config is the config for the template collector

func NewConfig

func NewConfig(p output.Params) (Config, error)

NewConfig creates a new Config instance from the provided output.Params

type Output

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

Output implements the lib.Output interface

func New

func New(p output.Params) (*Output, error)

New creates an instance of the collector

func (*Output) Description

func (o *Output) Description() string

Description returns a human-readable description of the output that will be shown in `k6 run`

func (*Output) Start

func (o *Output) Start() error

Start performs initialization tasks prior to Engine using the output

func (*Output) Stop

func (o *Output) Stop() error

Stop to satisfy old output.Output interface it's deprecated and will be removed in the future StopWithTestError will be used instead

func (*Output) StopWithTestError

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

StopWithTestError flushes all remaining metrics and finalizes the test run