From 74315ef289bf1e045fe19f07e28712f0af2ed318 Mon Sep 17 00:00:00 2001 From: David Boyne Date: Tue, 15 May 2018 09:01:45 +0100 Subject: [PATCH] DB - Updated ReadME with examples of the metrics that are gathered --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ff1302a..6a11ea5 100644 --- a/README.md +++ b/README.md @@ -61,12 +61,39 @@ Example: `http://localhost:8080/lighthouse?url=http://www.google.co.uk&product=g Example: `http://localhost:8080/page-speed-insights?url=http://www.google.co.uk&product=google` -### Viewing dashboards +### Viewing your dashboards You can view your dashboards at [http://localhost](http://localhost). You will be asked to login. Please use the credentials below. - username: admin - password: secret - - +# Metrics + +| Metric | Description | +|--------------------------------------------------------|---------------------------------------------------| +| light_house_accessibility | Accessibility score from lighthouse (0/100). | +| light_house_best_practices | Best practices score from lighthouse (0/100) | +| light_house_first_interactive | The time to first interaction (ms) | +| light_house_first_meaningful_paint | The time to first meaningful paint (ms) | +| light_house_performance | Performance score from lighthouse (0/100) | +| light_house_progressive_web_app | Progressive web app score from lighthouse (0/100) | +| light_house_redirects | Number of redirects | +| light_house_seo | SEO Score from lighthouse (0/100) | +| light_house_speed_index_metric | Speed index | +| light_house_time_to_first_byte | Time to first byte (ms) | +| page_speed_insights_page_stats_cssResponseBytes | Total CSS Response in bytes | +| page_speed_insights_page_stats_htmlResponseBytes | Total HTML response in bytes | +| page_speed_insights_page_stats_imageResponseBytes | Total Image response in bytes | +| page_speed_insights_page_stats_javascriptResponseBytes | Total JavaScript response in bytes | +| page_speed_insights_page_stats_numberCssResources | Total CSS response in bytes | +| page_speed_insights_page_stats_numberJsResources | Total number of JavaScript files | +| page_speed_insights_speed_score_desktop | Speed score in desktop | +| page_speed_insights_speed_score_mobile | Speed score in mobile | +## Viewing Metrics in Prometheus + +You can view any metrics gathered by Garie in the [prometheus dashboard](http://localhost:9090/). + +You can view lighthouse metrics by typing `lighthouse_` in the input box. You should see all avalaible lighthouse metics. + +You can also see page speed insight metrics by typing `page_speed_insights` into the input box.