Documentation / Performance Dashboard
Monitor the performance of your web site using the performance dashboard.
- What you need
- Up and running in (almost) 5 minutes
- Example dashboards
- Configure running your tests
- Configure Graphite
- Using S3 for HTML and video
- Production Guidelines
What you need
Up and running in (almost) 5 minutes
- Download our Docker compose file:
curl -O https://raw.githubusercontent.com/sitespeedio/sitespeed.io/master/docker/docker-compose.yml
docker-compose up -d(make sure you run the latest Docker compose version)
- Run sitespeed to get some metrics:
docker-compose run sitespeed.io https://www.sitespeed.io/ --graphite.host=graphite
- Access the dashboard: http://127.0.0.1:3000 (if you use docker machine you need to get the ip with
- When you are done you can shut down and remove all the Docker containers by running
docker-compose stop && docker-compose rm. Container data will be kept.
- To start from scratch, also remove the Graphite and Grafana data volumes by running
docker volume rm performancedashboard_graphite performancedashboard_grafana.
If you want to play with the dashboards, the default login is sitespeedio and password is …well check out the docker-compose.yml file.
When you run this in production make sure to checkout our production guidelines.
Docker compose file #
We have prepared a Docker Compose file that downloads and sets up Graphite/Grafana and sitespeed.io with a couple of example dashboards. It works perfectly when you want to try it out on localhost, but if you want to run it in production, you should modify it by making sure that the metrics are stored outside of your container/volumes. If you prefer InfluxDB over Graphite, you can use that too, but right now we only have one ready-made dashboard for InfluxDB (thank you Olivier Jan for contributing to that dashboard!).
Pre-made dashboards #
We insert ready-made dashboards with a Docker container using curl, making it easy for you to get started. You can check out the container with the dashboards here: https://github.com/sitespeedio/grafana-bootstrap-docker
The example dashboards are generic dashboards that will work with all data/metrics you collect using sitespeed.io. We worked hard to make them and the great thing is that you can use them as base dashboards, then create additional dashboards if you like.
The dashboards has a couple of templates (the dropdowns at the top of the page) that makes the dashboard interactive and dynamic. A dashboard that show metrics for a specific page has the following templates:
The path is the first path after the namespace. Using the default values, the namespace looks like this: sitespeed_io.default.
When you choose one of the values in a template, the rest will be populated. You can choose from checking metrics for a specific page, browser, and connectivity.
The default namespace is sitespeed_io.default and the example dashboards are built upon a constant template variable called $base that is the first part of the namespace (that default is sitespeed_io but feel free to change that, and then change the constant).
Page summary #
The page summary shows metrics for a specific URL/page.
The page timings summary #
The page timings summary focus on Visual Metrics and is the number one dashboard you should use when you look for visual regressions.
Site summary #
The site summary show metrics for a site (a summary of all URLs tested for that domain).
The leaderboard #
WebPageTest dashboards #
We have two optional dashboards for WebPageTest to show how you can build them if you use WebPageTest through sitespeed.io.
WebPageTest page summary #
Have we told you that we love WebPageTest? Yes, we have and here is an example of a default WebPageTest page summary where you can look at results for individual URLs.
WebPageTest site summary #
And then there is also a dashboard for all tested pages of a site.
Whatever you want #
Do you need anything else? Since we store all the data in Graphite and use Grafana you can create your own dashboards, which is super simple!
If you are new to Grafana you should checkout the basic concepts as a start. Grafana is used by Cern, NASA and many many tech companies like Paypal, Ebay and Digital Ocean and it will surely work for you too :)
Configure running your tests
You have the dashboard and you need to collect metrics. You do that on one or multiple other servers. Do not do it on the same server as the dashboard setup since you want to have an as isolated environment as possible for your tests.
Go to the docmumentation on how to continuously run your tests and learn how you can do that.
When you run the dashboard on a standalone server, you need to make sure your agents send the metrics to your Graphite server. Configure
--graphite.host to the public IP address of your server. The default port when sending metrics to Graphite is 2003, so you don’t have to include that.
We provide an example Graphite Docker container and when you put that into production, you need to change the configuration. Checkout our Graphite documentation.
Using S3 for HTML and video
You can store the HTML result on your local agent that runs sitespeed.io, or you can dump the data to S3 or GCS and serve it from there. To use S3, you first need to set up an S3 bucket. And to set up a Google Cloud storage (GCS) bucket.
Then you configure sitespeed.io to send the data to S3 by configuring the bucket name (and AWS key/secret if that’s not available on your server). For GCS you need to provide the name of the bucket, service account key and the project id.
You now have the result on S3 or GCS and you’re almost done. You should also configure to send annotations to Graphite for each run.
You can send annotations to Graphite to mark when a run happens so you can go from the dashboard to any HTML-results page.
You do that by configuring the URL that will serve the HTML with the CLI param resultBaseURL (the base URL for your S3 or GCS bucket) and configure the HTTP Basic auth username/password used by Graphite. You can do that by setting
You can also modify the annotation and append our own text/HTML and add your own tags. Append a message to the annotation with
--graphite.annotationMessage. That way you can add links to a specific branch or whatever you feel that can help you. If needed set a custom title with
--graphite.annotationTitle instead of the default title that displays the number of runs of the test.
You can add extra tags with
--graphite.annotationTag. For multiple tags, add the parameter multiple times. Just make sure that the tags doesn’t collide with our internal tags.
Here are a couple of things you should check before you setup sitespeed.io for production.
Setup (important!) #
To run this in production (=not on your local dev machine) you should make some modifications:
- Always run sitespeed.io on a stand-alone instance
- This avoids causing discrepancies in results, due to things like competing resources or network traffic. Then you just run sitespeed.io with docker run … (only docker compose for Graphite/Grafana).
- Run Grafana/Graphite on another server instance.
- Change the default user and password for Grafana.
- Change the default user and password for Graphite.
- Make sure you have configured storage-aggregation.conf in Graphite to fit your needs.
- Configure your storage-schemas.conf how long you wanna store your metrics.
- MAX_CREATES_PER_MINUTE is usually quite low in carbon.conf. That means you will not get all the metrics created for the first run, so you can increase it.
- Map the Graphite volume to a physical directory outside of Docker to have better control (both Whisper and graphite.db). Map them like this on your physical server (make sure to copy the empty graphite.db file):
- Remove the sitespeedio/grafana-bootstrap from the Docker compose file, you only need that for the first run.
- Optional: Disable anonymous users access in Grafana.
Memory & CPU #
How large will your instances need to be? You need to have enough memory for Chrome/Firefox (yep they can really use a lot of memory for some sites). Before we used a $80 instance on Digital Ocean (8GB memory, 4 Core processors) but we switched to use AWS c5.large for dashboard.sitespeed.io. The reason is that the metrics are so more stable on AWS than Digital Ocean. We have tried out most cloud providers and AWS gave us the most stable metrics.
If you test a lot a pages (100+) in the same run, your NodeJS process can run out of memory (default memory for NodeJS is 1.76 GB). You can change and increase by setting MAX_OLD_SPACE_SIZE like this in your compose file:
services: sitespeed.io: environment: - MAX_OLD_SPACE_SIZE=3072
Sitespeed.io is Open Source and totally free. But what does it cost to have an instance of sitespeed.io up and running?
Setting up an AWS instance c5.large has an upfront price $515 for a year (it is much cheaper to pay upfront). Or you can use a Optimized Droplet for $40 a month at Digital Ocean (they have served us well in our testing).
You also need to pay for S3 (to store the videos and HTML). For https://dashboard.sitespeed.io we pay $10-15 per month (depending how long time you want to store the data).
Do your organisation already use Graphite/InfluxDB and Grafana? Then use what you have. Else you need to have a server hosting Graphite/Grafana. We pay $20 per month at Digital Ocean for that. Depending on how many metrics and for how long time you wanna store them, you maybe need and extra disk. And you should also always backup your data.
How many runs can you do per month? Many of the paid services you also pay per run or have a maximum amount of runs. With our one instance at AWS we do 11 runs for 9 different URLs then we run 5 runs for 4 other URLs. That is 119 runs per hour. 2856 per day and 85680. We test Wikipedia at our instance so it can be that your site is a little slower, then you will not be able to make the same amount of runs per month.
- $515 per AWS agent or $480 on Digital Ocean (80000+ tests per month per agent) per year
- S3 $10-15 with data
- Server for Graphite/Grafana
You also need to think of the time it takes for you to set it up and upgrade new Docker containers when there are new browser versions and new versions of sitespeed.io. Updating to a new Docker container on one server usually takes less than 2 minutes :)