Tool to gather lighthouse metrics and supports CRON jobs and webhooks.

Highlights

• Poll for lighthouse performance metrics on any website and stores the data into InfluxDB
• Webhook support
• Understand your performance metrics with recommend improvements thanks to lighthouse reports
• View all historic lighthouse reports.
• Setup within minutes

Garie-lighthouse was developed as a plugin for the Garie Architecture.

Garie is an out the box web performance toolkit, and garie-lighthouse is a plugin that generates and stores lighthouse data into InfluxDB.

Garie-lighthouse can also be run outside the Garie environment and run as standalone.

If your interested in an out the box solution that supports multiple performance tools like lighthouse, google-speed-insight and web-page-test then checkout Garie.

If you want to run garie-lighthouse standalone you can find out how below.

• Docker installed

You can get setup with the basics in a few minutes.

First clone the repo.

git clone git@github.com:boyney123/garie-lighthouse.git

Next setup you're config. Edit the config.json and add websites to the list.

{
	"cron": "00 00 */6 * * *",
	"urls": [
		{
			"url": "https://www.comparethemarket.com",
			"report": true
		},
		{
			"url": "https://www.bbc.co.uk",
			"report": true
		},
		{
			"url": "https://www.cnn.com",
			"report": true
		}
	]
}

Once you finished edited your config, lets build our docker image and setup our environment.

docker build -t garie-lighthouse . && docker-compose up

This will build your copy of garie-lighthouse and run the application.

On start garie-lighthouse will start to gather performance metrics for the websites added to the config.json.

Lighthouse comes with loads of audits out the box. You can view all metrics in the reports.

Garie-lighthouse filters what data is stored into influxDB and returned in the webhook.

Viewing lighthouse reports is straight forward. Once you have your application running just go to localhost:3000/reports and you should see all the reports lighthouse has generated.

If you don't want to generate reports you can turn this off in the config.json by setting report to false.

Garie-lighthouse also supports webhooks. You will need to POST to localhost:3000/collect.

Payload

Payload Example

{
  "url": "https://www.bbc.co.uk",
  "report": true
}

By default, reports on webhook's are not generated unless you set report to true

urls object

module.exports = {
  url: 'https://www.bbc.co.uk',
  plugins: [
    {
      name: 'lighthouse',
      report: true
    }
  ]
};

module.exports = {
  url: 'https://www.bbc.co.uk',
  plugins: [
    {
      name: 'lighthouse',
      report: true,
      config: {
        extends: 'lighthouse:default',
        settings: {
          emulatedFormFactor: 'desktop'
        }
      }
    }
  ]
};

module.exports = {
  url: 'https://www.bbc.co.uk',
  plugins: [
    {
      name: 'lighthouse',
      report: true,
      init: async (url, page) => {
        await page.goto(url);
        await page.waitForSelector('[name=username]');
        await page.focus('[name=username]');
        await page.keyboard.type('testuser');
        await page.waitForSelector('[name=password]');
        await page.focus('[name=password]');
        await page.keyboard.type('password');
        await page.click('[type=submit]');
      }
    }
  ]
};