Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kubeshop/xk6-tracetest
https://github.com/kubeshop/xk6-tracetest
xk6
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kubeshop/xk6-tracetest
- Owner: kubeshop
- License: apache-2.0
- Created: 2023-01-19T16:17:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T17:25:22.000Z (5 months ago)
- Last Synced: 2024-10-24T13:58:42.071Z (4 months ago)
- Topics: xk6
- Language: Go
- Homepage:
- Size: 13.1 MB
- Stars: 9
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xk6-tracetest
This extension adds Tracetest support to [k6](https://github.com/grafana/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](https://github.com/grafana/xk6) extension system.
## Build
To build a `k6` binary with this extension, first ensure you have the prerequisites:
- [Go toolchain](https://go101.org/article/go-toolchain.html)
- Git
Then:
1. Download `xk6`:
```bash
$ go install go.k6.io/xk6/cmd/xk6@latest
```
2. Build the binary:
```bash
$ xk6 build --with github.com/kubeshop/xk6-tracetest@latest
```
3. Run a script:
```bash
$ ./k6 run examples/list-pokemons.js --env XK6_TRACETEST_API_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](https://github.com/kubeshop/tracetest/tree/main/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:
```bash
$ 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=`