https://github.com/sitespeedio/plugin-gpsi
GPSI plugin for sitespeed.io
https://github.com/sitespeedio/plugin-gpsi
gpsi plugin sitespeedio
Last synced: 10 months ago
JSON representation
GPSI plugin for sitespeed.io
- Host: GitHub
- URL: https://github.com/sitespeedio/plugin-gpsi
- Owner: sitespeedio
- License: mit
- Created: 2017-11-18T20:54:28.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T06:18:38.000Z (over 1 year ago)
- Last Synced: 2025-06-15T20:44:52.191Z (11 months ago)
- Topics: gpsi, plugin, sitespeedio
- Language: JavaScript
- Size: 510 KB
- Stars: 11
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sitespeed.io plugin for GPSI (Google PageSpeed Insights)
[](https://travis-ci.org/sitespeedio/plugin-gpsi)
Run GPSI as a plugin for sitespeed.io
Run by giving **--gpsi.key YOUR_GPSI_KEY** to sitespeed.io.
You can read more about sitespeed.io plugins [here](https://www.sitespeed.io/documentation/sitespeed.io/plugins/).
Get your [GSPI key from Google](https://support.google.com/cloud/answer/6158862).
## Test with current master
If you have checked out as the same level as sitespeed.io you run it like this (else just change the path).
```bash
git clone https://github.com/sitespeedio/sitespeed.io.git
cd sitespeed.io
npm install
bin/sitespeed.js --plugins.add ../plugin-gpsi/lib/index.js --gpsi.key YOUR_SECRET_KEY https://www.sitespeed.io/ -n 1
```
## Run in production
If you want to run GPSI with your other sitespeed.io test, follow the instructions in the [add a plugin docs](https://www.sitespeed.io/documentation/sitespeed.io/plugins/#add-a-plugin).
## sitespeed.io version
You need sitespeed.io 6.0 or later to run the plugin.
## How do I know it works?
You will get an extra tab called GPSI on each individual URL that you test.
## GPSI vs Lighthouse
GPSI runs Lighthouse in the backend. You can see which Lighthouse version in the HTML produced by the plugin. The plugin collects accessibility, seo, pwa, best-practices and performance scores.
## Data sent to Graphite/InfluxDB
By default the plugin sends the GSPI score for the tested page for the five categories: accessibility, seo, pwa, best-practices and performance.
It also sends the loadingExperience for the page. That includes the actual percentile for First Contentful Paint and First Input Delay and the percentage of fast/moderate/slow users.
And it also sends a summary on domain level for the loading experience, meaning you can keep track of those metrics by running the plugin once a day.