https://github.com/joanlopez/xk6-custosummary

A k6 extension & output that serves as an alternative to the standard summary.
https://github.com/joanlopez/xk6-custosummary

Last synced: about 8 hours ago
JSON representation

A k6 extension & output that serves as an alternative to the standard summary.

• Host: GitHub
• URL: https://github.com/joanlopez/xk6-custosummary
• Owner: joanlopez
• Created: 2024-10-30T18:33:36.000Z (7 days ago)
• Default Branch: main
• Last Pushed: 2024-10-30T19:46:27.000Z (7 days ago)
• Last Synced: 2024-10-30T20:30:10.127Z (7 days ago)
• Language: Go
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# xk6-custosummary

**`xk6-custosummary`** is an [extension for k6](https://k6.io/docs/extensions).

It adds _extraofficial_ support for a "customizable" summary.

## Getting started

Using the `xk6-custosummary` extension involves building a k6 binary incorporating it.

A detailed guide on how to do this using a [Docker](https://www.docker.com/) or [Go](https://go.dev/) environment

is available in the [extension's documentation](https://grafana.com/docs/k6/latest/extensions/build-k6-binary-using-go/).

In the current state, building directly from the source code using Go could be helpful. We list below the suggested steps:

### Prepare the local environment

1. Make sure `git` and `go` are available commands.

2. Install [xk6](https://github.com/grafana/xk6#local-installation) as suggested in 

the [local installation](https://github.com/grafana/xk6#local-installation) documentation's section.

3. Clone the `xk6-custosummary` repository and move inside the project's folder.

### Build the binary

1. Build a k6 binary incorporating the `xk6-custosummary` extension

```bash

xk6 build --with github.com/joanlopez/xk6-custosummary=.

```

2. Run a test script with the newly built binary

```bash

./k6 run script.js

```

## Usage

Once [built](#getting-started) into a k6 executable using [xk6](https://github.com/grafana/xk6),

the extension can be imported by load test scripts as the `k6/x/custosummary` JavaScript module.

## Support

Please, note that this extension is not officially supported by Grafana Labs/k6 core team.