eeacms/garie-lighthouse repository overview

Tool to gather lighthouse metrics and supports CRON jobs.

Highlights

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

⁠Overview of garie-lighthouse

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.

⁠Getting Started

⁠Prerequisites

• Docker installed

⁠Running garie-lighthouse

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

First clone the repo.

git clone https://github.com/eea/garie-lighthouse.git

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

{
  "plugins":{
        "lighthouse":{
            "cron": "0 */4 * * *"
        }
    },
  "urls": [
    {
      "url": "https://www.eea.europa.eu/"
    },
    {
      "url": "https://biodiversity.europa.eu/"
    }
  ]
}

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.

⁠Data collected

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.

⁠config.json

urls object

For more information please go to the garie-plugin⁠ repo.