npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

k6-html-result-reporter

v1.0.16

Published

Generate k6 html test result report from CSV output data.

Downloads

22

Readme

k6 HTML Result Reporter

Note

This k6 HTML result report generator is inspired from https://github.com/benc-uk/k6-reporter which provides pretty good report after the completion of performance test.

The report will provide the transaction response times and performance statistics using the data from CSV output file.

The report includes summary report along with response times charts and full transaction list in a table.

Prerequisites

The report is generated from the csv result output when the test is executed. For example if the script is test.js use -o csv=<path of the output file>. Example:

-% k6 run -o csv=./results/result.csv test.js

HTML report is not generated if result is not output to CSV file. The report is generated using the data from the output file. More information https://k6.io/docs/get-started/results-output/

Installation

npm i k6-html-result-reporter

Usage

The report generation should be executed after the whole test is completed. For example create execute-report.ts file with the following code. Replace the file paths.

import {readFileSync, writeFileSync} from 'fs';
import Papa from 'papaparse';

const filePath = '<csv_result_file>';
const reportFilePath = '<path to save html file>';

export function execute() {
    let fileData: Buffer = readFileSync(filePath);
    let data: any = Papa.parse(fileData.toString(), { header: true, skipEmptyLines: true }).data;
    let htmlReport: string = generateReport(data);
    writeFileSync(reportFilePath, htmlReport);
}

execute();

The example above uses papaparse to read from CSV file. For more information visit: https://www.papaparse.com/

Execute the commands to first create a JS file and then execute the JS file.

-% tsc execute-report.ts
-% node execute-report.js

The above step is required if the scripts are developed using TypeScript.

For convenience put all the commands in shell script and execute it. Example:

#!/bin/zsh

k6 run -o csv=output_file_path test_file_path

tsc execute-report.ts

node execute-report.js

Replace the file paths with actual file names and paths used in the test.

Should also work if the result is output as JSON using -o json=output_file_path and sending the JSON file data as input parameter to the function. The input data should be an array.

Function accepts two parameters.

inputData: any - CSV data read from the result file.
title: string (optional) - Report title. Defaults to k6 Performance Test Report - yyyy-mm-dd

Report

Summary Charts Charts Transactions