api

package

v0.50.0 Latest Latest Go to latest Published: Mar 25, 2024 License: AGPL-3.0 Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/grafana/k6

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api contains the REST API implementation for k6. It also registers the services endpoints like pprof

Index ¶

func GetServer(runCtx context.Context, addr string, profilingEnabled bool, ...) *http.Server

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetServer ¶ added in v0.43.0

func GetServer(
	runCtx context.Context,
	addr string,
	profilingEnabled bool,
	runState *lib.TestRunState,
	samples chan metrics.SampleContainer,
	me *engine.MetricsEngine,
	es *execution.Scheduler,
) *http.Server

GetServer returns a http.Server instance that can serve k6's REST API.

Types ¶

This section is empty.

Source Files ¶

View all Source files

server.go

Directories ¶

Path	Synopsis
v1 Package v1 implements the v1 of the k6's REST API	Package v1 implements the v1 of the k6's REST API
client Package client provides a simple go-client for the k6's REST API.	Package client provides a simple go-client for the k6's REST API.

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