k6-modern-report
v1.0.1
Published
Modern HTML Reporter for k6 with dark mode, charts, and expert analysis.
Downloads
191
Readme
k6-modern-report
A modern, comprehensive HTML reporter for k6 performance tests.
Features
- Dark Mode Support: Automatically defaults to dark mode with a toggle.
- Interactive Charts: Uses Chart.js for visualizing response times and request status.
- Expert Analysis: Provides an automatic "Expert Analysis" score and summary based on your test results (APDEX, Failure Rate, Latency).
- PDF Export: Built-in button to export the HTML report as a PDF.
- Thresholds & Checks: Detailed view of all k6 checks and thresholds.
Installation
npm install k6-modern-reportUsage
Option 1: Direct Execution (No Build Step Required)
If you want to run your test directly with k6 run without setting up a bundler (like esbuild or webpack), import the file directly from node_modules.
Example Test Script:
import http from 'k6/http';
import { generateReport } from './node_modules/k6-modern-report/src/index.js'; // Adjust path if needed
export function handleSummary(data) {
return generateReport(data, 'report.html');
}
export default function () {
http.get('https://test.k6.io');
}Run:
k6 run test.jsOption 2: Using a Bundler (Recommended for larger projects)
If you are using a bundler like esbuild or webpack (or k6-template-es6), you can import the package normally.
Example Test Script:
import { generateReport } from 'k6-modern-report';
export function handleSummary(data) {
return generateReport(data, 'report.html');
}Build & Run:
npm run bundle
k6 run dist/test.js