crazymaribell / site-performance-tracker

Allows you to detect and track site performance metrics

Site Performance Tracker

This WordPress plugin allows you to detect and track site performance metrics. It is using a browser's PerformanceObserver API for measuring the metrics.

The plugin integrates with the Google Analytics and sends timing events on a few predefined events. It is important though to identify the most significant elements on your page like a hero element and add a custom performance marks in those locations in order to get the most meaningful metrics.

An inspiration for this plugin was a Google Developers guide around user-centric performance metrics.

---

License: GPLv2

Contributors: delawski, kasparsd, xwp

Installation

Copy the plugin files to the wp-content/plugins folder inside your WordPress directory.

Usage

By default the plugin will report the following metrics:

• PerformancePaintTiming events:
  • first-paint (FP)
  • first-contentful-paint (FCP)
• NavigationTiming events:
  • domContentLoadedEventEnd
  • domInteractive
  • domComplete
• PerformanceMark injected in the WordPress hooks:
  • mark_after_wp_head
  • mark_before_wp_footer
  • mark_after_wp_footer

Adding Custom Marks

You can add a mark in important locations on your page using the xwp/performance_tracker/render_mark action and providing the mark slug like this:

do_action( 'xwp/performance_tracker/render_mark', 'after_hero' );

This will add a new performance mark called mark_after_hero.

An alternative way to add a performance mark is to use the the_site_performance_mark() function like this:

if ( function_exists( 'the_site_performance_mark' ) ) {
	the_site_performance_mark( 'after_hero' );
}

You can also get the JS code alone by using the get_the_performance_mark() function:

if ( function_exists( 'get_the_performance_mark' ) ) {
	$parformance_mark_js = get_the_performance_mark( 'after_hero' );
}

Hooks

There are the following hooks available to further customize the way the plugin works:

Disable the plugin

Programmatically disable the plugin.

apply_filters( 'site_performance_tracker_disabled', boolean $is_disabled = false );

Disable default hooks

This will prevent adding custom performance marks for wp_head and wp_footer hooks.

apply_filters( 'site_performance_tracker_disable_default_hooks', boolean $disable_default_hooks = false );

Category name

Change the category name used when sending events to Google Analytics.

apply_filters( 'site_performance_tracker_category_name', string $category_name = 'Performance Metrics' );

Entry types

Filter the entry types that are being measured byy PerformanceObserver.

apply_filters( 'site_performance_tracker_event_types', array $entry_types = [ 'paint', 'navigation', 'mark' ] );

Changelog

0.2.0 - February 22, 2019

• Make autoload.php optional to support project-wide autoload.
• Add an action xwp/performance_tracker/render_mark as an alternative way for adding performance marks in the front-end.
• Bugfix: Use proper JS escaping (as per WordPress VIP review).

0.1.1 - February 18, 2019

• The plugin is no longer using a singleton pattern. Instead it is just a regular class that is being instantiated in the main plugin file.
• Namespace has been added.
• The PHP version check has been added (>= 5.3).
• The helper functions are extracted to a separate file and they are now using static functions inside the class.
• The $default_entry_types array is no longer defined as static.

0.1.0 - February 15, 2019

• Initial release.