grafana / xk6-notification

A k6 extension for creating notifications.
Apache License 2.0
19 stars 4 forks source link
k6 k6-extension shoutrrr xk6
shoutrrr gopher with a k6 cap ## xk6-notification This is a [k6](https://go.k6.io/k6) extension using the [xk6](https://github.com/grafana/xk6) system.


:exclamation: This is a proof of concept

As such, it isn't supported by the k6 team, and may break in the future. USE AT YOUR OWN RISK!

Build

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

Then:

  1. Install xk6:

    $ go install go.k6.io/xk6/cmd/xk6@latest
  2. Build the binary:

    $ xk6 build --with github.com/grafana/xk6-notification@latest

Usage

import http from 'k6/http';
import notification from 'k6/x/notification';

const url = 'slack://token:token@channel/';

export function setup() {
  notification.send(url, 'Starting test');
}

export default function () {
  http.get('http://test.k6.io');
}

export function teardown(data) {
  notification.send(url, 'Finishing test');
}

Token example (more information): slack://xoxb:123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N@C001CH4NN3L

Documentation

For a full documentation of the api and how to use it, see the official shoutrrr documentation.