Ismerkedés a Tracy-vel

A PHP egy olyan nyelv, amely tökéletesen alkalmas a nehezen felfedezhető hibák elkövetésére, mivel jelentős szabadságot ad a fejlesztőknek. Annál értékesebb a Tracy debuggoló eszköz. A PHP diagnosztikai eszközei között abszolút csúcsot képvisel.

Ha ma találkozik először a Tracy-vel, higgye el, hogy az élete ketté fog válni: a Tracy előtti és a vele való életre. Üdvözöljük a jobbik részben!

Telepítés

A Tracy telepítésének legjobb módja a legújabb csomag letöltése, vagy a Composer használata:

composer require tracy/tracy

Letöltheti az egész csomagot tracy.phar fájlként is.

Használat

A Tracy-t a Tracy\Debugger::enable() metódus hívásával aktiváljuk a program legelején, még bármilyen kimenet küldése előtt:

use Tracy\Debugger;

require 'vendor/autoload.php'; // vagy tracy.phar

Debugger::enable();

Az első dolog, amit észrevesz az oldalon, a Tracy Bar a jobb alsó sarokban. Ha nem látja, az jelentheti, hogy a Tracy éles/produkciós módban fut. A Tracy ugyanis biztonsági okokból csak localhoston látható. Annak tesztelésére, hogy működik-e, ideiglenesen átkapcsolhatja fejlesztői módba a Debugger::enable(Debugger::Development) paraméterrel.

Tracy Bar

A Tracy Bar egy lebegő panel, amely az oldal jobb alsó sarkában jelenik meg. Egérrel mozgathatjuk, és az oldal újratöltése után emlékezni fog a pozíciójára.

A Tracy Barhoz további hasznos paneleket lehet hozzáadni. Sokat találhat a kiegészítőkben, vagy akár írhatsz sajátot is.

Ha nem szeretné megjeleníteni a Tracy Bart, állítsa be:

Debugger::$showBar = false;

Hibák és kivételek vizualizációja

Bizonyára jól tudja, hogyan jelzi a PHP a hibákat: az oldal forráskódjába valami ilyesmit ír ki:

Parse error:  syntax error, unexpected '}' in HomePresenter.php on line 15

vagy el nem kapott kivétel esetén:

Fatal error:  Uncaught Nette\MemberAccessException: Call to undefined method Nette\Application\UI\Form::addTest()? in /sandbox/vendor/nette/utils/src/Utils/ObjectMixin.php:100
Stack trace:
#0 /sandbox/vendor/nette/utils/src/Utils/Object.php(75): Nette\Utils\ObjectMixin::call(Object(Nette\Application\UI\Form), 'addTest', Array)
#1 /sandbox/app/Forms/SignFormFactory.php(32): Nette\Object->__call('addTest', Array)
#2 /sandbox/app/Presentation/Sign/SignPresenter.php(21): App\Forms\SignFormFactory->create()
#3 /sandbox/vendor/nette/component-model/src/ComponentModel/Container.php(181): App\Presentation\Sign\SignPresenter->createComponentSignInForm('signInForm')
#4 /sandbox/vendor/nette/component-model/src/ComponentModel/Container.php(139): Nette\ComponentModel\Container->createComponent('signInForm')
#5 /sandbox/temp/cache/latte/15206b353f351f6bfca2c36cc.php(17): Nette\ComponentModel\Co in /sandbox/vendor/nette/utils/src/Utils/ObjectMixin.php on line 100

Egy ilyen kimenetben eligazodni nem éppen könnyű. Ha bekapcsoljuk a Tracy-t, a hiba vagy kivétel teljesen más formában jelenik meg:

A hibaüzenet szó szerint kiabál. Látjuk a forráskód egy részletét a kiemelt sorral, ahol a hiba történt és a Call to undefined method Nette\Http\User::isLogedIn() információ érthetően magyarázza, milyen hibáról van szó. Az egész oldal ráadásul élő, átkattinthatunk további részletekre. Próbáld ki.

És tudja mit? Így kapja el és jeleníti meg a fatális hibákat is. Anélkül, hogy bármilyen kiterjesztést telepíteni kellene.

Az olyan hibák, mint egy elgépelés a változó nevében vagy egy nem létező fájl megnyitásának kísérlete, E_NOTICE vagy E_WARNING szintű jelentéseket generálnak. Ezeket az oldal grafikájában könnyű figyelmen kívül hagyni, sőt, lehet, hogy egyáltalán nem láthatók (legfeljebb az oldal kódjának megtekintésével).

Vagy megjeleníthetők ugyanúgy, mint a hibák:

Debugger::$strictMode = true; // jelenítsen meg minden hibát
Debugger::$strictMode = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED; // minden hiba, kivéve a deprecate értesítéseket

Megjegyzés: A Tracy aktiválás után az E_ALL szintre változtatja a hibajelentési szintet. Ha ezt az értéket módosítani szeretné, tegye meg az enable() hívása után.

Fejlesztői vs éles/produkciós mód

Ahogy látja, a Tracy meglehetősen bőbeszédű, ami fejlesztői környezetben értékelhető, míg egy éles/produkciós szerveren kész katasztrófát okozna. Ott ugyanis semmilyen debuggolási információ nem íródhat ki. A Tracy ezért környezet automatikus észlelésével rendelkezik, és ha a példát éles szerveren futtatjuk, a hiba megjelenítés helyett naplózásra kerül, és a látogató csak egy felhasználóbarát üzenetet lát:

Az éles/produkciós mód elnyomja az összes debuggolási információ megjelenítését, amelyet a dump() segítségével küldünk ki, és természetesen az összes hibaüzenetet is, amelyet a PHP generál. Tehát ha a kódban elfelejtett néhány dump($obj)-ot, nem kell aggódnia, az éles/produkciós szerveren semmi sem fog kiíródni.

Hogyan működik a mód automatikus észlelése? A mód akkor fejlesztői, ha az alkalmazás localhoston fut (azaz 127.0.0.1 vagy ::1 IP-címen), és nincs jelen proxy (azaz annak HTTP fejléce). Egyébként éles/produkciós módban fut.

Ha engedélyezni szeretnénk a fejlesztői módot más esetekben is, például egy konkrét IP-címről hozzáférő programozóknak, adjuk meg azt az enable() metódus paramétereként:

Debugger::enable('23.75.345.200'); // IP-címek tömbje is megadható

Határozottan javasoljuk az IP-cím és egy süti kombinálását. A tracy-debug sütibe mentsünk el egy titkos tokent, pl. secret1234, és így aktiváljuk a fejlesztői módot csak azoknak a programozóknak, akik egy konkrét IP-címről férnek hozzá, és a sütijükben szerepel az említett token:

Debugger::enable('secret1234@23.75.345.200');

A fejlesztői/éles/produkciós módot közvetlenül is beállíthatjuk a Debugger::Development vagy Debugger::Production konstans használatával az enable() metódus paramétereként.

Ha a Nette Frameworköt használja, nézze meg, hogyan állítsa be a módot számára, és ez utána a Tracy számára is használva lesz.

Hibanaplózás

Éles/produkciós módban a Tracy automatikusan minden hibát és elkapott kivételt egy szöveges naplóba rögzít. Ahhoz, hogy a naplózás működjön, be kell állítanunk a naplózási könyvtár abszolút elérési útját a $logDirectory változóba, vagy át kell adnunk az enable() metódus második paramétereként:

Debugger::$logDirectory = __DIR__ . '/log';

A hibanaplózás rendkívül hasznos. Képzelje el, hogy az alkalmazásának minden felhasználója valójában bétatesztelő, akik ingyen végeznek csúcsmunkát a hibakeresésben, és butaságot követne el, ha értékes jelentéseiket figyelmen kívül hagyva a szemeteskosárba dobná.

Ha saját üzenetet vagy egy Ön által elkapott kivételt kell naplóznunk, használjuk erre a log() metódust:

Debugger::log('Váratlan hiba történt'); // szöveges üzenet

try {
	kritikusMuvelet();
} catch (Exception $e) {
	Debugger::log($e); // kivételt is lehet naplózni
	// vagy
	Debugger::log($e, Debugger::ERROR); // e-mail értesítést is küld
}

Ha azt szeretné, hogy a Tracy a PHP hibákat, mint az E_NOTICE vagy E_WARNING, részletes információkkal (HTML jelentés) naplózza, állítsa be a Debugger::$logSeverity-t:

Debugger::$logSeverity = E_NOTICE | E_WARNING;

Egy igazi profi számára a hibanapló kulcsfontosságú információforrás, és azonnal tájékoztatást szeretne kapni minden új hibáról. A Tracy ebben segítséget nyújt, ugyanis képes e-mailben tájékoztatni a napló új bejegyzéséről. Azt, hogy hova küldje az e-maileket, a $email változóval határozzuk meg:

Debugger::$email = 'admin@example.com';

Ha a teljes Nette Frameworköt használja, ezt és más beállításokat a konfigurációs fájlban állíthatja be.

Azonban, hogy ne árassza el az e-mail postafiókját, mindig csak egy üzenetet küld, és létrehoz egy email-sent fájlt. A fejlesztő az e-mail értesítés fogadása után ellenőrzi a naplót, javítja az alkalmazást, és törli a figyelő fájlt, amivel újra aktiválódik az e-mail küldés.

Megnyitás a szerkesztőben

A hibaoldal megjelenítésekor rá lehet kattintani a fájlnevekre, és azok megnyílnak a szerkesztőben a kurzorral a megfelelő soron. Lehetőség van fájlok létrehozására (create file akció) vagy hibák javítására (fix it akció) is. Ahhoz, hogy ez működjön, konfigurálni kell a böngészőt és a rendszert.

Támogatott PHP verziók

Az utolsó patch verzióra érvényes.

Portok

Ez a nem hivatalos portok listája más keretrendszerekhez és CMS-ekhez:

• Drupal 7
• Laravel framework: recca0120/laravel-tracy, whipsterCZ/laravel-tracy
• OpenCart
• ProcessWire CMS/CMF
• Slim Framework
• Symfony framework: kutny/tracy-bundle, VasekPurchart/Tracy-Blue-Screen-Bundle
• Wordpress