Skip to content

Commit ec2cead

Browse files
ids
1 parent fa10d98 commit ec2cead

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ This repository is for [K6 output extension](https://k6.io/docs/extensions/). Th
44

55
## Usage
66

7-
Get the Extended K6 Binary
7+
The released binary is expected to run in containers or linux-like hosts of `amd64` architecture.
8+
For Windows 10+ environments you can run it in WSL2.
9+
For other environments, please build your version from sources.
10+
11+
### Get the pre-build extended K6 binary
812

913
- Find the [latest release}(https://github.com/mdsol/xk6-output-otlp/releases).
1014
- Download `k6.tar.gz` archive, and extract the `k6` binary with
@@ -13,12 +17,6 @@ Get the Extended K6 Binary
1317
tar -xvzf k6.tar.gz
1418
```
1519

16-
- Run K6 tests like
17-
18-
```sh
19-
./k6 run --out otlp --config <config-file> <test-file>
20-
```
21-
2220
### Configuration
2321

2422
Configuration parameters can be set in a JSON configuration file or using environment variables:
@@ -59,6 +57,12 @@ Environment variables:
5957
| `K6_OTLP_TREND_CONVERSION` | `gauges` | `gauges` or `histogram`. Conversion type for metrics of type `trend`. |
6058
| `K6_OTLP_SERVER_URL` | `http://localhost:8080/v1/metrics`| OTLP metrics endpoint url. Usually ends with `/v1/metrics` |
6159

60+
### Run K6 tests like
61+
62+
```sh
63+
./k6 run --out otlp --config <config-file> <test-file>
64+
```
65+
6266
## K6 Metrics Conversion
6367

6468
The Grafana K6 testing utility uses a metric model that requires some metrics conversion before sending to Opentelemetry Collector or other OTLP receiver.

0 commit comments

Comments
 (0)