eeacms/garie-browsertime repository overview

Tool to gather browsertime metrics and supports CRON jobs.

Highlights

• Poll for browsertime performance metrics on any website and stores the data into InfluxDB
• Generates web performance videos
• View all historic reports.
• Setup within minutes

⁠Overview of garie-browsertime

Garie-browsertime was developed as a plugin for the Garie⁠ Architecture.

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

Garie-browsertime 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 browsertime, google-speed-insight and lighthouse then checkout Garie⁠.

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

⁠Getting Started

⁠Prerequisites

• Docker installed

⁠Running garie-browsertime

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

First clone the repo.

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

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

{
  "plugins":{
        "browsertime":{
            "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-browsertime . && docker-compose up

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

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

⁠config.json

urls object

⁠CPUs usage

Limiting CPU usage is done by setting the value of cpuUsage in the config.json.

"plugins":{
	"my_plugin":{
		"cron": ...,
		"cpuUsage": 0.9,
	}
}

For more information please go to the [garie-plugin](https://github.com/eea/garie-plugin) repo.