Siirry pääsisältöön

Suorituskyvyn profilointi: Xdebug & Webgrind

Opi löytämään WordPress-sivuston hitaat PHP-funktiot paikallisessa kehitysympäristössä Xdebug- ja Webgrind-työkalujen avulla. Katso ohjeet profiloinnin käynnistämiseen ja tulosten analysointiin.

Xdebug on PHP-laajennus koodin vianetsintään ja suorituskyvyn profilointiin, ja Webgrind on selainpohjainen työkalu Xdebugin tuottamien profilointitietojen visuaaliseen analysointiin. Molemmat työkalut ovat valmiiksi asennettuina Seravon paikallisessa Docker-kehitysympäristössä.

Huom: Xdebug on tarkoitettu ainoastaan paikalliseen kehitysympäristöön, sillä se hidastaa PHP-suoritusta merkittävästi. Jos haluat profiloida tuotanto- tai varjoympäristön suorituskykyä, käytä Tideways-profilointityökalua.

Vaihe 1: Ota Xdebug käyttöön kehityskontissa

Oletuksena Xdebug on pois päältä paikallisessa Docker-ympäristössä, jotta sivusto toimii mahdollisimman nopeasti. Kytke Xdebug päälle kehityskontin sisällä (seravo-docker ssh):

wp-xdebug-on

Kun olet lopettanut profiloinnin, kytke Xdebug takaisin pois päältä komennolla:

wp-xdebug-off

Vaihe 2: Profiloi sivu ja avaa tulokset Webgrindissä

Kun Xdebug on aktivoitu, voit profiloida minkä tahansa paikallisen sivuston sivulatauksen lisäämällä URL-osoitteen perään parametrin ?XDEBUG_PROFILE (tai &XDEBUG_PROFILE, jos osoitteessa on jo muita parametreja).

Esimerkki: WordPressin hallintapaneelin profilointi

  1. Avaa selaimessa profiloitava sivu parametrin kanssa, esimerkiksi:

    http://wordpress.local/wp-admin/?XDEBUG_PROFILE

    (Sivulataus kestää tavallista kauemmin, koska Xdebug tallentaa samalla jokaisen funktiokutsun suoritusajan cachegrind.out.*-tiedostoon.)

  2. Avaa Webgrind selaimessa osoitteessa http://webgrind.<sivusto>.local/ (oletuksena http://webgrind.wordpress.local/).

  3. Valitse ylävalikosta tuorein cachegrind-tiedosto (tai jätä valinnaksi Auto (newest)) ja klikkaa Update.

Xdebug in Vagrant

Webgrind-käyttöliittymä näyttää PHP-funktioiden suoritusajat, kutsukerrat ja suhteelliset kustannukset profiloinnin jälkeen.

Webgrind-tulosten lukeminen

Webgrind listaa kaikki sivulatauksen aikana suoritetut PHP-funktiot. Kiinnitä huomiota erityisesti kolmeen sarakkeeseen:

  • Invocation Count: Kuinka monta kertaa kyseistä funktiota kutsuttiin sivulatauksen aikana. Suuri luku voi paljastaa tarpeettoman silmukan tai toistuvan tietokantakyselyn.

  • Total Self Cost: Kuinka paljon aikaa kului juuri kyseisen funktion oman koodin suorittamiseen (ilman sen tekemiä alikutsuja). Tämä paljastaa varsinaiset pullonkaulat.

  • Total Inclusive Cost: Funktion kokonaissuoritusaika mukaan lukien kaikki sen kutsumat alifunktiot.

Vinkki: Profilointitiedostot tallentuvat kontin /tmp/-hakemistoon ja voivat kasvaa suuriksi. Voit tyhjentää vanhat profilointitiedostot kontin sisällä komennolla rm -f /tmp/cachegrind.out.*.

Xdebug Helper -selainlaajennuksen käyttö

Jos haluat käynnistää profiloinnin suoraan selaimen työkalupalkista ilman ?XDEBUG_PROFILE-parametrin kirjoittamista osoiteriville (esimerkiksi lomakkeiden lähetyksen tai AJAX-pyyntöjen yhteydessä), voit käyttää Xdebug Helper -selainlaajennusta (saatavilla Chromelle ja Firefoxille).

Määritä laajennuksen asetuksiin seuraavat arvot:

  • IDE key: vagrant (tai PHPSTORM)

  • Trace Trigger Value: XDEBUG_TRACE

  • Profile Trigger Value: XDEBUG_PROFILE

xdebug helper selainlaajennus

Xdebug Helper -selainlaajennuksen asetukset, joissa on määritetty IDE key sekä profiloinnin ja seurannan laukaisuarvot.

Etävianetsintä (Step Debugging) Xdebugilla

Profiloinnin lisäksi Xdebug tukee interaktiivista askeltavaa vianetsintää (Step Debugging), jonka avulla voit asettaa koodiin keskeytyspisteitä (breakpoints) ja tarkastella muuttujien arvoja suorituksen aikana suoraan omassa koodieditorissasi (esim. VS Code tai PhpStorm).

Kytke Xdebug päälle kontin sisällä (wp-xdebug-on) ja määritä editorisi kuuntelemaan Xdebug-yhteyksiä (oletusportti 9003, Xdebug 2:ssa 9000). Katso tarkemmat editorikohtaiset ohjeet käyttämäsi IDE:n dokumentaatiosta.

Yleisimmät virhetilanteet

  • Webgrindin tiedostolistassa ei näy yhtään profilointitiedostoa: Varmista, että olet aktivoinut Xdebugin kontin sisällä komennolla wp-xdebug-on ennen sivun lataamista ?XDEBUG_PROFILE-parametrilla.

  • Paikallinen kehityssivusto toimii huomattavan hitaasti: Xdebug on jäänyt päälle taustalle. Kytke se pois päältä kontin sisällä komennolla wp-xdebug-off.

  • http://webgrind.wordpress.local/ ei avaudu: Varmista, että paikallinen Docker-ympäristö on käynnissä (seravo-docker up) ja että projekti käyttää oletusosoitetta wordpress.local (jos olet muuttanut osoitetta config.yml-tiedostossa, käytä muotoa http://webgrind.<sivusto>.local/).

Katso myös

Xdebugin ja Webgrindin avulla paikannat raskaat teema- ja lisäosafunktiot luotettavasti jo paikallisessa kehitysympäristössä. Mikäli tarvitset apua sivuston suorituskyvyn optimoinnissa tai kehitystyökalujen käytössä, asiakaspalvelumme auttaa osoitteessa [email protected].

Vastasiko tämä kysymykseesi?