CONTRIBUTING.md

Contributing

Branches and Pull Requests

The main branch is considered the source of stable releases. Please open a PR with your proposed change.

Building Extended K6 Binary

1. Download and install Go if required.

2. Install XK6 tool

3. Clone repository into a new folder.

4. Go to the new folder.

5. Build the extension with make build command. Find new K6 binary in ./bin subfolder.

6. Run K6 tests with it using --out otlp flag, like

   ./bin/k6 run --out otlp --config <./samples/config.json> ./samples/test.js

Upload metrics to Vision sandbox

Example of local configuration file (VPN Required):

{
  "collectors": {
    "otlp": {
      "metrics_url": "http(s)://<opentelemetry-collector>/v1/metrics",
      "headers": {
        "job": "tests"
      },
      "push_interval": "10s",
      "timeout": "3s",
      "gzip": true,
      "insecure": false,
      "add_id_attributes": true
    }
  }
}