phantomas

Headless Chromium-based modular web performance metrics collector. And why phantomas? Well, because :)

Requirements

NodeJS 8+

Installation

npm install phantomas

This will install a recent version of Chromium supported by puppeteer module.

Usage example

const phantomas = require('phantomas'),
    promise = phantomas('http://example.com/');

promise.
	then(results => {
		console.log('Metrics', results.getMetrics());
		console.log('Offenders', results.getAllOffenders());
    }).
    catch(res => {
		console.error(res);
    });

// events handling
promise.on('recv', response => {
	console.log('Response: %s %s [%s]', response.method, response.url, response.contentType);
});

Development version

To get the latest development version of phantomas (and install all required dependencies):

git clone git@github.com:macbre/phantomas.git
npm install

Having problems?

Please refer to /Troubleshooting.md

Features

modular approach - each metric is generated by a separate "module"
phantomas "core" acts as an events emitter that each module can hook into
in-depth metrics such as: number of events bound via jQuery, calls to window.writeor complex and duplicated CSS selectors (via analyze-css)
JSON and CSV as available output formats for easy integration with automated reporting / monitoring tools
easy integration with Continuous Integration tools via TAP format and assertions handling
metrics can be sent via StatsD or stored in elasticsearch
easy integration with other nodejs projects via CommonJS module (see API docs)
metrics can be emitted from JavaScript code of the page phantomas is run against (thanks to helper functions available in window.__phantomas)
device profiles allow phantomas to emulate mobile or tablet (by setting a proper user agent and viewport)