k6

package

v0.55.1 Latest Latest Go to latest Published: Dec 19, 2024 License: AGPL-3.0 Imports: 9 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grafana/k6

Documentation ¶

Overview ¶

Package k6 implements the module imported as 'k6' from inside k6.

Index ¶

Variables
type K6
type RootModule
- func New() *RootModule
- func (*RootModule) NewModuleInstance(vu modules.VU) modules.Instance

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrGroupInInitContext is returned when group() are using in the init context.
	ErrGroupInInitContext = common.NewInitContextError("Using group() in the init context is not supported")

	// ErrCheckInInitContext is returned when check() are using in the init context.
	ErrCheckInInitContext = common.NewInitContextError("Using check() in the init context is not supported")
)

Functions ¶

This section is empty.

Types ¶

type K6 ¶

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

K6 represents an instance of the k6 module.

func (*K6) Check ¶

func (mi *K6) Check(arg0, checks sobek.Value, extras ...sobek.Value) (bool, error)

Check will emit check metrics for the provided checks.

func (*K6) Exports ¶ added in v0.36.0

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

Exports returns the exports of the k6 module.

func (*K6) Fail ¶

func (*K6) Fail(msg string) (sobek.Value, error)

Fail is a fancy way of saying `throw "something"`.

func (*K6) Group ¶

func (mi *K6) Group(name string, val sobek.Value) (sobek.Value, error)

Group wraps a function call and executes it within the provided group name.

func (*K6) RandomSeed ¶ added in v0.22.0

func (mi *K6) RandomSeed(seed int64)

RandomSeed sets the seed to the random generator used for this VU.

func (*K6) Sleep ¶

func (mi *K6) Sleep(secs float64)

Sleep waits the provided seconds before continuing the execution.

type RootModule ¶ added in v0.36.0

type RootModule struct{}

RootModule is the global module instance that will create module instances for each VU.

func New ¶ added in v0.18.0

func New() *RootModule

New returns a pointer to a new RootModule instance.

func (*RootModule) NewModuleInstance ¶ added in v0.36.0

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

NewModuleInstance implements the modules.Module interface to return a new instance for each VU.

Source Files ¶

View all Source files

k6.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
crypto Package crypto provides common hashing function for the k6	Package crypto provides common hashing function for the k6
x509 Package x509 provides X.509 certificate parsing for the k6	Package x509 provides X.509 certificate parsing for the k6
data Package data implements `k6/data` js module for k6.	Package data implements `k6/data` js module for k6.
encoding Package encoding provides encoding/decoding functionality for the k6	Package encoding provides encoding/decoding functionality for the k6
execution Package execution implements k6/execution which lets script find out more about it is execution.	Package execution implements k6/execution which lets script find out more about it is execution.
experimental Package experimental includes experimental module features	Package experimental includes experimental module features
csv Package csv provides a CSV parser for k6.	Package csv provides a CSV parser for k6.
fs Package fs provides a k6 module that allows users to interact with files from the local filesystem as per the [File API design document].	Package fs provides a k6 module that allows users to interact with files from the local filesystem as per the [File API design document].
streams Package streams provides support for the Web Streams API.	Package streams provides support for the Web Streams API.
grpc Package grpc is the root module of the k6-grpc extension.	Package grpc is the root module of the k6-grpc extension.
html generated by js/modules/k6/html/gen/gen_elements.go; DO NOT EDIT	generated by js/modules/k6/html/gen/gen_elements.go; DO NOT EDIT
gen Package main - this package generates some of the code for k6/html	Package main - this package generates some of the code for k6/html
http Package http implements the k6/http js module for k6.	Package http implements the k6/http js module for k6.
metrics Package metrics implements k6/metrics and let script work with custom metrics.	Package metrics implements k6/metrics and let script work with custom metrics.
timers Package timers is implementing setInterval setTimeout and co.	Package timers is implementing setInterval setTimeout and co.
ws Package ws implements a k6/ws for k6.	Package ws implements a k6/ws for k6.