Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 2.14 KB

README.md

File metadata and controls

64 lines (37 loc) · 2.14 KB
Raw

xk6-tracetest

This extension adds Tracetest support to k6!

That means that if you're testing an instrumented system, you can use this extension to trigger test runs.

Currently, it supports HTTP requests and the following propagation formats: tracecontext, baggage, b3 ot, jaeger and xray.

It is implemented using the xk6 extension system.

Build

To build a k6 binary with this extension, first ensure you have the prerequisites:

Then:

  1. Download xk6:
$ go install go.k6.io/xk6/cmd/xk6@latest
  1. Build the binary:
$ xk6 build --with github.com/kubeshop/xk6-tracetest@latest
  1. Run a script:
$ ./k6 run examples/list-pokemons.js --env XK6_TRACETEST_API_TOKEN=<your token> -o xk6-tracetest

Example

To run a full example take a look at the fully flesh demo we have for you in the Tracetest main mono repo: examples/tracetest-k6

Using the binary with Tracetest Core

Moving forward the latest updates will be only available from the tracetest App, if you want to keep using it with the OpenSource version make sure to build it with the version supporting it.

  1. Build the binary:
$ xk6 build --with github.com/kubeshop/[email protected] # OSS supported version

Available Variables

If you want to configure the tracetest k6 binary you can do it by using any of the following environment variables

  • XK6_TRACETEST_SERVER_URL: Updates the tracetest server url for API interactions (can be overwritten by the script config)
  • XK6_TRACETEST_SERVER_PATH: Updates the tracetest server path for API interactions (can be overwritten by the script config)
  • XK6_TRACETEST_TOKEN: Updates the tracetest server token that will be used to authenticate with the server (can be overwritten by the script config)

You can also set a default tracetest endpoint when running the k6 binary by using the following option:

./k6 run examples/list-pokemons.js -o xk6-tracetest=<server-url>