Automating functionality exams on your WP Company with PageSpeed Insights API

Change the placeholders along with your exact information that you simply retrieved previous.

Step 2: Use the Kinsta API to retrieve a listing of corporate websites

To get the checklist of web sites on your Kinsta account, you want to make use of Kinsta API v2 and the /websites endpoint.

Right here’s how you'll get admission to the API by the use of cURL:

// 1. Fetch the checklist of web sites from Kinsta
$url_kinsta = "https://api.kinsta.com/v2/websites?corporate=" . $kinsta_company_id . "&include_environments=true";
$ch = curl_init($url_kinsta);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $kinsta_api_key]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$res_kinsta = curl_exec($ch);
$data_kinsta = json_decode($res_kinsta, true);
curl_close($ch);

$websites = $data_kinsta['company']['sites'] ?? [];
echo "Discovered " . rely($websites) . " websites to investigate.n";

Observe that we used the question parameter includes_environments=true to retrieve atmosphere main points (reside and staging).

Subsequent, question the Google PSI API and ship the information to the Slack app.

PageSpeed Insights metrics and Slack notifications

Now, you want to ship the URL of every retrieved website to the PageSpeed Insights API. Whilst you name the carrier, PageSpeed Insights runs a functionality test and returns an object containing functionality metrics. Your script will ship this information to the Slack API, which can generate the corresponding messages.

Right here’s the code so as to add in your script:

foreach ($websites as $website) {
	$site_label = $website['display_name'];
	$primary_domain = "";

	// 2. Seek the downloaded information without delay for the reside atmosphere
	$environments = $website['environments'] ?? [];

	foreach ($environments as $env) {
		if ($env['name'] === 'reside') {
			$raw_domain = $env['primaryDomain'] ?? $env['primary_domain'] ?? null;
			$primary_domain = is_array($raw_domain) ? ($raw_domain['name'] ?? "") : $raw_domain;
			ruin;
		}
	}

	if (empty($primary_domain)) {
		echo "Skipping $site_label (No Are living area discovered).n";
		proceed;
	}

	echo "Inspecting $primary_domain... ";

	// 3. PageSpeed research
	$psi_url = "https://www.googleapis.com/pagespeedonline/v5/runPagespeed?url=https://" . urlencode($primary_domain) . "&key=$google_api_key&class=functionality&technique=cellular";
	
	$res_psi = @file_get_contents($psi_url);
	if ($res_psi === false) {
		echo "PSI Error.n";
		proceed;
	}

	$data_psi = json_decode($res_psi, true);

	$rating = ($data_psi['lighthouseResult']['categories']['performance']['score'] ?? 0) * 100;
	$fcp   = $data_psi['lighthouseResult']['audits']['first-contentful-paint']['displayValue'] ?? 'N/A';
	$lcp   = $data_psi['lighthouseResult']['audits']['largest-contentful-paint']['displayValue'] ?? 'N/A';

	// 4. Ship wealthy notification to Slack
	$report_link = "https://pagespeed.internet.dev/research?url=https://" . $primary_domain . "&technique=cellular";
	
	$slack_msg = [
		"text" => "🚀 *Performance Report: $site_label*nURL: `https://$primary_domain` nn" .
			"• *Score:* `$score` n" .
			"• *FCP:* $fcp n" .
			"• *LCP:* $lcpnn" .
			"[ <$report_link|View Full Report> ]"
	];

	$ch = curl_init($slack_webhook_url);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($slack_msg));
	curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_exec($ch);
	curl_close($ch);

	echo "Executed.n";
}

echo "--- MONITORING COMPLETED ---n";

Briefly, this code iterates over the weather of the $websites array. For every component of the array, it fetches Core Internet Vitals and posts a message to Slack.

Trying out the script

You'll attach along with your container the use of SSH and run your PHP script without delay from the terminal. This permits you to briefly troubleshoot your script and obtain functionality leads to Slack in real-time.

In MyKinsta, navigate to WordPress Websites > Web page Identify. Scroll all the way down to the Number one SFTP/SSH person phase and to find the SSH terminal command box. It must glance one thing like this:

ssh wordpress@host-name -p port-number

Reproduction the SSH terminal command and paste it into the terminal. You’ll be precipitated to go into the password supplied in the similar phase. Press Input, and you are going to be hooked up in your container atmosphere.

Now you'll check your code. From the command line, navigate to the folder the place you uploaded the script. On this instance, we used the public folder:

cd public

Subsequent, use the next command to run the script:

php performance-monitor.php

The script echoes a message for every motion it plays. As soon as it has completed operating, you must see a listing of messages very similar to the next:

--- STARTING FULL PERFORMANCE MONITORING ---
Discovered 5 websites to investigate.
Inspecting site1.kinsta.cloud... Executed.
Inspecting site2.kinsta.cloud... Executed.
Inspecting site3.kinsta.cloud... Executed.
Inspecting instance.com... Executed.
Inspecting site5.kinsta.cloud... Executed.
--- MONITORING COMPLETED ---

If PSI fails to reply in a well timed approach, the script strikes directly to the following website. On this case, you are going to see a message that appears like this:

--- STARTING FULL PERFORMANCE MONITORING ---
Discovered 5 websites to investigate.
Inspecting site1.kinsta.cloud... Executed.
Inspecting site2.kinsta.cloud... Executed.
Inspecting site3.kinsta.cloud... Executed.
Inspecting instance.com... PSI Error.
Inspecting site5.kinsta.cloud... Executed.
--- MONITORING COMPLETED ---

Because the script processes Google PSI responses, it sends a message in your Slack channel. For every website effectively analyzed through PSI, you must see a Slack message lovely very similar to the next:

Superior. You’ve simply created your automatic tracking gadget.

Now, you might wish to regulate it to suit your particular wishes. For example, for those who set up loads of shopper websites, sending a Slack message for every website may well be inefficient.

It's essential, alternatively, arrange a situation that exams the website’s general rating and sends a message to the Slack channel provided that the worth returned through the PSI API is under a specified threshold (e.g., 90). The next code would do the trick:

$threshold = 90;

// 4. Ship wealthy notification to Slack
// The alert is brought about provided that the present rating is precisely less than our restrict.
if ($rating < $threshold) View Full Audit Report> ]"
	];

	// Execute the CURL request to the Slack Webhook
	$ch = curl_init($slack_webhook_url);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($slack_msg));
	curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_exec($ch);
	curl_close($ch);

	echo "Executed.n";
 else {
	echo "Rating is perfect ($rating). No alert despatched.n";
}

Replace your script, save the record, and add it once more. Then, connect with the server by the use of SSH, navigate to the suitable folder, and run the next command once more:

php performance-monitor.php

Should you selected a unique call on your script, regulate the command accordingly.

The terminal must now display a chain of messages very similar to the next:

--- STARTING FULL PERFORMANCE MONITORING ---
Discovered 5 websites to investigate.
Inspecting site1.kinsta.cloud... Rating is perfect (100). No alert despatched.
Inspecting site2.kinsta.cloud... Rating is perfect (95). No alert despatched.
Inspecting site3.kinsta.cloud... Rating is perfect (100). No alert despatched.
Inspecting instance.com... Rating under threshold. Sending Slack alert... Executed.
Inspecting site5.kinsta.cloud... Rating under threshold. Sending Slack alert... Executed.
--- MONITORING COMPLETED ---

In Slack, you are going to obtain a message for every website with an general rating under the 90 threshold.

That’s nice, isn’t it? However you'll optimize the method even additional. Wouldn’t you favor to avoid wasting much more time through operating the script mechanically at set periods while not having to get admission to your command-line device?

Sure, you guessed it. You wish to have a cron activity.

Automate the method the use of a cron activity

There are a number of techniques to arrange a cron activity on Kinsta. Even if you'll do it thru WordPress, Kinsta customers can upload server cron jobs to every website container.

To arrange a cron activity on Kinsta, create a cron command and upload it in your container’s crontab record by the use of SSH.

For instance, it's good to use a command like the next:

0 10 * * * /usr/bin/php /www/yoursite_123/public/your-script.php >> /www/yoursite_123/performance_monitor.log 2>&1

Here's what this command does:

• 0 10 * * * units the script to be completed on a daily basis at 10 AM.
• /usr/bin/php is absolutely the trail of the PHP interpreter at the server.
• /www/yoursite_123/public/your-script.php is absolutely the trail of the script. Remember to test the trail and the true call of your script at the server.
• The >> operator (append redirection) appends new information to the tip of the desired record.
• /www/yoursite_123/performance_monitor.log signifies the record wherein all textual content revealed through the script can be stored.
• The 2>&1 command instructs the server to direct mistakes to the similar record.

We can no longer speak about cron instructions in additional element right here. You'll discuss with the documentation from The Open Team or use a crontab device, equivalent to Crontab Generator or Cronitor.

After development your cron command, you want so as to add it in your website container. You'll both ask our improve staff to do that for you or do it your self by the use of SSH. If you select the latter, get started through typing the next command:

crontab -e

You'll be requested to choose an editor. Make a choice “nano” in case you are not sure.

Within the editor, paste your command on the finish of the record. Save the record and go back to the command line. You must then see a message confirming that your adjustments had been finished effectively.

crontab putting in new crontab

That’s it. The script will now run at set periods and ship a message to the Slack channel of your selection with the asked metrics on your shopper websites which might be acting poorly.

Scaling up: What else are you able to automate with the Kinsta API?

The script offered on this article may also be custom designed and expanded additional. For example, it's good to combine different services and products, equivalent to Trello or Asana, export information, or ship periodic e-mail digests to shoppers.

Automating your functionality exams for your shoppers’ websites is just the start. Integrating the Kinsta API along with your staff’s day-to-day equipment can develop into your company’s operations through getting rid of guide website control and upkeep duties, bettering potency, and decreasing working prices. You’ll additionally reinforce carrier high quality, scale back supply instances, and make sure the most efficient imaginable revel in on your shoppers.

The Kinsta API allows you to automate more than a few duties, together with growing staging environments, selectively pushing adjustments from staging to manufacturing, having access to error logs, clearing the website cache, managing backups, and extra. Those options make managing WordPress websites fast and simple, permitting you to scale with self belief.

In a position to take your company to the following degree? Discover our plans or touch our gross sales staff to talk about your particular wishes.

Satisfied scaling!

The publish Automating functionality exams on your WP Company with PageSpeed Insights API gave the impression first on Kinsta®.

[ continue ]