Documentation
¶
Overview ¶
Package cloud implements an Output that flushes to the k6 Cloud platform.
Index ¶
- Constants
- func New(params output.Params) (output.Output, error)
- type Output
- func (out *Output) Description() string
- func (out *Output) SetTestRunStopCallback(stopFunc func(error))
- func (out *Output) SetThresholds(scriptThresholds map[string]metrics.Thresholds)
- func (out *Output) Start() error
- func (out *Output) Stop() errordeprecated
- func (out *Output) StopWithTestError(testErr error) error
Constants ¶
const TestName = "k6 test"
TestName is the default k6 Cloud test name
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Output ¶
type Output struct {
// contains filtered or unexported fields
}
Output sends result data to the k6 Cloud service.
func (*Output) Description ¶
Description returns the URL with the test run results.
func (*Output) SetTestRunStopCallback ¶
SetTestRunStopCallback receives the function that stops the engine on error
func (*Output) SetThresholds ¶
func (out *Output) SetThresholds(scriptThresholds map[string]metrics.Thresholds)
SetThresholds receives the thresholds before the output is Start()-ed.
func (*Output) Start ¶
Start calls the k6 Cloud API to initialize the test run, and then starts the goroutine that would listen for metric samples and send them to the cloud.
func (*Output) StopWithTestError ¶
StopWithTestError gracefully stops all metric emission from the output: when all metric samples are emitted, it makes a cloud API call to finish the test run. If testErr was specified, it extracts the RunStatus from it.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package expv2 contains a Cloud output using a Protobuf binary format for encoding payloads.
|
Package expv2 contains a Cloud output using a Protobuf binary format for encoding payloads. |
|
pbcloud
Package pbcloud contains the Protobuf definitions used for the metrics flush RPCs.
|
Package pbcloud contains the Protobuf definitions used for the metrics flush RPCs. |
|
Package insights contains the logic for the k6 cloud insights output.
|
Package insights contains the logic for the k6 cloud insights output. |
|
Package cloud implements an Output that flushes to the k6 Cloud platform using the version1 of the protocol flushing a json-based payload.
|
Package cloud implements an Output that flushes to the k6 Cloud platform using the version1 of the protocol flushing a json-based payload. |