Rewording blog post for 5.0 release

This commit is contained in:
Jonathan Lee 2017-04-23 23:35:54 -04:00 committed by GitHub
parent 5138a0e21f
commit c02bedb4bb
1 changed files with 28 additions and 28 deletions

View File

@ -9,42 +9,42 @@ nav: blog
---
# Say hello to 5.0
Almost 6 months ago we released 4.0 and it was a lot of hard work to get that out: Adding HTTP/2 support, complete rewriting everything and making it more modular. We needed to release 4.0 but everything wasn't crisp. My personal opinion is that we missed out the final touch on the HTML result pages. We have that now with 5.0 :)
It was almost 6 months ago when we released 4.0 and to get that out was a lot of hard work. Not only did we add HTTP/2 support, but we also did a complete rewriting of everything to make it more modular. With that we needed to release 4.0, but everything wasn't as refined as we wanted. One big piece we missed out on was the final touches on the HTML result pages. Fear not we have that now with 5.0! :)
But first lets check what we have added the last months:
But first lets check what we have added in the last months:
* Video with SpeedIndex/firstVisualChange/lastVisualChange and VisualComplete 85%. This is real SpeedIndex where we record a video of the screen and use [VisualMetrics](https://github.com/WPO-Foundation/visualmetrics/) to analyze and get the metrics.
* Upload the [HTML result to Amazon S3](https://results.sitespeed.io/en.wikipedia.org/2017-04-10-06-00-04/pages/en.wikipedia.org/wiki/Barack_Obama/).
* A better way to [set connectivity using Docker networks]({{site.baseurl}}/documentation/sitespeed.io/browsers/#change-connectivity).
* Cleaner default Grafana dashboard with links to the HTML results.
* Newer and cleaner version of [PerfCascade](https://github.com/micmro/PerfCascade) that makes the waterfall of the HAR files look great!
* Collect the timeline log and netlog from Chrome.
* A new and cleaner version of [PerfCascade](https://github.com/micmro/PerfCascade) that makes the waterfall of the HAR files look that much better!
* Collection of the timeline log and netlog from Chrome.
Before we go on about the new things in 5.0 we wanna tell you about the status of the project:
We have had more 500 000 downloads of sitespeed.io (611k + the ones we had before we moved to NodeJS and Docker)! We have a lot of more things we want to add and now are the time to help us!
We have had more 500,000 downloads of sitespeed.io (611k + the ones we had before we moved to NodeJS and Docker)! We have a lot more things we want to add and we need your help more than ever!
We have a Slack channel for developers [that you should join](https://sitespeedio.herokuapp.com/)! There you can get help with building plugins or if you want to contribute to sitespeed.io. If you have questions how to run sitespeed.io, please use [Github issues](https://github.com/sitespeedio/sitespeed.io/issues/new).
We have a Slack channel for developers [that you should join](https://sitespeedio.herokuapp.com/)! This is the place you can get help with building plugins or contribute back to sitespeed.io. If you have questions on how to run sitespeed.io, please use [Github issues](https://github.com/sitespeedio/sitespeed.io/issues/new).
Between latest 4.7 and now 5.0 we have focused on getting the HTML mean and clean. Let's check out the changed in 5.0.
Between the latest 4.7 and now 5.0 we have focused on getting the HTML mean and clean. Let's check out the changed in 5.0.
## UX improvements
We structure the data better now, the whole experience using 5.0 is so much better than 4.0 :)
We have have re-structure the data and the whole experience using 5.0 is way better than 4.0! :)
### Video
If you have tried sitespeed.io since we introduced video support you have seen that we have a really crisp video. One cool thing is that we display the visual metrics in the video when it happens. The video now also includes Visual Complete 85% so it is easy to see when that happens.
If you have tried sitespeed.io since we first introduced video support you have seen that we have a really crisp video. One cool thing is that we display the visual metrics in the video when it happens. The video now also includes Visual Complete 85%, so it is easier to see when that happens compared to the other metrics.
We also made it easier to download the video. Checkout the yellow button for downloading. You can download the video, the HAR files, Chrome timeline (if you configured that) and the sitespeed.io log from that run. It's not a big thing but it makes life a little easier.
We also made it easier to download the video. Checkout the yellow button for downloading. This now means you can download the video, the HAR files, Chrome timeline (if you configured that,) and the sitespeed.io log from each run. This is great if you have external tools that can leverage any of these files for alternative or additional analysis.
![The video includes metrics by default]({{site.baseurl}}/img/video5.0.png)
{: .img-thumbnail}
<p class="image-info">
<em class="small center">The video includes metrics by default but you can turn that off if you want.</em>
<em class="small center">The video includes metrics by default, but you can turn that off if you want.</em>
</p>
### Timing metrics
The Browsertime result page was a little hard to read. To make it easier we have split the metrics in visual metrics and metrics from the browser.
The Browsertime result page was a little hard to understand. To make this easier we have split the metrics in visual metrics and metrics from the browser.
![Metrics are now easier to see the Browsertime result tab]({{site.baseurl}}/img/visualmetrics-browsertime.png)
{: .img-thumbnail}
@ -54,55 +54,55 @@ The Browsertime result page was a little hard to read. To make it easier we have
### Find that run
On the page summary (where you see summary metrics for all the runs) it is now super easy to match a metric to a specific run. All min/median/max metrics are linked to the run that hold that metric.
On the page summary (where you see summary metrics for all runs) it is now really easy to match a metric to a specific run. All min/median/max metrics are linked to the run that hold it's respective metric.
This is super useful if come from Grafana and want to match a specific run that was graphed.
This is extremely useful if you are coming from Grafana and you want to match a specific run that was being graphed.
![It is now easy to find the run that had that metric]({{site.baseurl}}/img/findthatrun.png)
{: .img-thumbnail}
<p class="image-info">
<em class="small center">All metric numbers are now links, pointing to that run that had that metric</em>
<em class="small center">All metric numbers are now links, pointing to the run that had that specific metric</em>
</p>
### WebPageTest
We are still in love with WebPageTest and improved the look and feel of the WebPageTest result page. We also automatically download the HAR file, Chrome timeline JSON and the images for the waterfall graphs, so that the result is self contained. No more beacons back when your user access your result pages.
We are still in love with WebPageTest and have improved the look and feel of the WebPageTest result page. We also automatically download the HAR file, Chrome timeline JSON and the images for the waterfall graphs, so that the result is self contained. No more beacons back when your user accesses the result pages.
We show more metrics than before and also follow the structure of metrics that we use for Browsertime.
![New look and feel for WebPageTest metrics]({{site.baseurl}}/img/wpt-5.0.png)
{: .img-thumbnail}
## Logs
As we mentioned before you can now download the logs easily from the HTML by adding <code>--html.logDownloadLink</code> to your CLI parameters.
As we mentioned earlier you can now download the logs easily from the HTML by adding <code>--html.logDownloadLink</code> to your CLI parameters.
![Download the log]({{site.baseurl}}/img/download-log.png)
{: .img-thumbnail}
## InfluxDB
We have had a long time goal to support one other TSDB than Graphite and now we officially support InfluxDB. We have [one example dashboard](https://dashboard.sitespeed.io/dashboard/db/wip-influxdb?orgId=1) that you can use and maybe we can have more example dashboards in the future.
We have had a long time goal to support one other TSDB than Graphite and we are happy to announce that we now officially support InfluxDB. We have [one example dashboard](https://dashboard.sitespeed.io/dashboard/db/wip-influxdb?orgId=1) that you can use and we will have more example dashboards in the future!
This is extremely new so it could be miss out on functionality, if that's the case, create an issue and we will work to fix that!
While this is extremely exciting it is also extremely new, so it could be miss out on functionality, if that's the case, create an issue and help us make this support just as good as graphite!
A special thank you [@theist](https://github.com/theist) and [@eripa](https://github.com/eripa) who helped us fix the InfluxDB integration so the structure is better than we had in the original version.
A special thank you to [@theist](https://github.com/theist) and [@eripa](https://github.com/eripa) who helped us fix the InfluxDB integration so the structure is better than we had in the original version.
![InfluxDB dashboard]({{site.baseurl}}/img/influxdb-dashboard.png)
{: .img-thumbnail}
## Browsertime 1.1
Sitespeed.io 5.0 uses Browsertime 1.1 that we released yesterday. And what a ride it has been for the first beta 1.0 of Browsertime eight months ago and now 1.1! We will soon do a blog post about 1.0 but I want to talk about the latest thing we added before releasing that final version.
Sitespeed.io 5.0 uses Browsertime 1.1 that we released yesterday. What a ride it has been for the first 1.0 beta just eight months ago to now at 1.1! We will soon release a blog post about 1.1, but I want to talk about some of the latest features we added before releasing this final version.
### Video and SpeedIndex from your Android device
I would still call it experimental support for video and SpeedIndex for Chrome on Android. We need help to test it out on different devices. Right now you need to setup the dependencies needed for VisualMetrics yourself so it some work to get that going. Check out the [how to](https://github.com/sitespeedio/browsertime#test-on-your-mobile-device) what you need to setup.
While still in experimental support for video and SpeedIndex for Chrome on Android we need help to test it out on different devices. Right now you need to setup the dependencies needed for VisualMetrics yourself, so it some work to get that going. Check out the [how to](https://github.com/sitespeedio/browsertime#test-on-your-mobile-device) on what you need to setup.
![Video and SpeedIndex on Android](https://raw.githubusercontent.com/sitespeedio/sitespeed.io/master/docs/img/barack.gif)
{: .img-thumbnail}
Warning: This is really addictive! When I integrated latest Browsertime in sitespeed.io I got stuck a couple of hours testing different sites on my low end Huawei Android phone.
Warning: This is really addictive! When I integrated the latest Browsertime in sitespeed.io I got stuck for a couple of hours testing different sites on my low end Huawei Android phone.
Our Docker container don't support Android at the moment but we hope we can add it in the future. Let us know if you can help us with that!
Our Docker container does not currently support Android at the moment, but we hope we can add it in the future. Let us know if you have any experience and can help us with that!
### Your own request headers and blocking request
We finally have been able to add support for adding your own request headers and blocking requests by domain, by creating [our own Browser extension](https://github.com/sitespeedio/browsertime-extension). In this release it works in Chrome and soon in Firefox (we need Tobias [fix](https://github.com/SeleniumHQ/selenium/pull/3846) to land in Selenium for supporting the new extension layout in Firefox).
### Your own request headers and the ability to block request
We have finally been able to add support for your own request headers as well as blocking requests by domain, via creating [our own Browser extension](https://github.com/sitespeedio/browsertime-extension). In this release it works in Chrome and will soon in Firefox (we need a [fix](https://github.com/SeleniumHQ/selenium/pull/3846) from Tobias to land in Selenium for supporting the new extension layout in Firefox). In the meantime here are a few examples with chrome on setting request headers or blocking requests.
Adding a request header:
@ -116,8 +116,8 @@ Blocking all request on my.example.com:
$ docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io/ --block my.example.com
~~~
## Not backward compatible changes in 5.0
There's one change in 5.0 that changes the default behavior: TSProxy isn't default for connectivity since it doesn't work as we want together with Selenium. We also removed tc as default running Docker. When you change connectivity you should use our [Docker network setup](https://www.sitespeed.io/documentation/sitespeed.io/browsers/#change-connectivity)!
## Non backward compatible changes in 5.0
We try extremely hard to not break backwards compatibility where we can but, there is one change in 5.0 that has and it's around network throttling and the default behavior: With Sitespeed.io standalone TSProxy is no longer the default for connectivity, since it doesn't work as well as we wanted together with Selenium. We have also removed tc as the default when running with Docker. If you want to change connectivity with Docker you should use the new [Docker network setup](https://www.sitespeed.io/documentation/sitespeed.io/browsers/#change-connectivity)!
/Peter