Hogyan készíts hibanaplót és mire ügyelj error log esetében

Mi az a debug, error log?

A korábbi cikkeimhez hasonlóan először kezdjük azzal is, miről is van szó, mi is az a debug és mi az a hibanapló, error log? A debug nem más mint hibakeresés. Amikor egy fejlesztő debuggol, akkor hibákat keres és azokról minél több információt gyűjt. A hibanapló (avagy angol nevén error log) egy olyan fájl, ami a honlapunk egyes látható és rejtett hibáit írja össze, időrendi sorrendben. Ennek a fájlnak lehet többféle kiterjesztése, például .log vagy szimplán .txt, a kiterjesztés igazából mindegy, általánosságban sima szöveget tartalmaz csak.

Sok problémától, gondtól megkímélhetjük magunkat a hibanaplóval.

Miért jó ez, kinek lehet szüksége rá?

A hibák javítása mindig elsődleges szempont kell legyen egy honlapkészítőnek. Mivel több hiba csak ritka feltételek együttes hatásánál jön elő, így nehezen deríthető fel. A hibanapló ezeket képes egy fájlba összegyűjteni és így megkönnyíti a hiba javítását.

Továbbá az error log segítségével több információt kaphatsz az egyes hibákról. Az egyik legfontosabb, hogy melyik fájl okozza a galibát és azon belül melyik sora.

Egy új honlap elkészítésekor szinte kötelező, de frissítéskor – karbantartáskor is elvárt lenne, hibakeresésnél pedig igazából nélkülözhetetlen.

Mikor íródik új sor a hibanaplóba, error log-ba?

A hibnapló, error log akkor bővül újabb sorral, bejegyzéssel, ha egy bővítmény, sablon hibát észlel. Ez nem feltétlenül látszik a külső felületen. Az új bejegyzés csak akkor kerül bele az error log-ba, ha a megfelelő esemény történik. Tehát ha egy képgaléria plugin okoz gondot, akkor abban az esetben fog hibanaplóba bekerülni, ha egy olyan oldalt nyitunk meg, ami a hibás képgalériát tartalmazza. Egy hiba többször belekerülhet az error log fájlba, ahányszor a hibás esemény bekövetkezik.

Hogyan készíts hibanaplót, írass error log fájlt

Erre több lehetőségünk is van. Az első, könnyebb megoldás, ami az átlagfelhasználóknak számára ajánlott, az egy ilyen jellegű bővítmény telepítése a WordPress honlapjára. A második megoldás az szolgáltató, tárhely admin kérdése, de például Cpanel-ben is meg tudjuk nézni a hibanaplót, noha több oldal esetében nem volt teljesen alapos, szóval a Cpanel error log fájlát azért ne vegyük 100%-nak. A harmadik lehetőség ami inkább fejlesztőknek ajánlott, az egy saját hibanapló hozzáadása a wordpress-hez. Nézzük is ezeket részletesebben!

Hibanapló WordPress bővítménnyel

A legegyszerűbb, főleg ha ideiglenesen van csak szükségünk error log készítésére WordPress alatt. Jelenleg két ilyen WordPress bővítmény van ringben, ami hibanaplót készít. Az egyik az Error Log Monitor, a másik a WP Log Viewer. Mindkettő az adatbázisba menti a hibabejegyzéseket. A WP Log Viewer kicsit kényelmesebb, könnyebb benne keresni egy – egy hibára. Az Error Log Monitor viszont képes az új bejegyzésekről email értesítést küldeni.

WordPress gyári error log író használata

Jómagam és más fejlesztők is, a plugin mellőzés hívei vagyunk. Nézzük a lépéseket, miként is lehet ezt bekapcsolni, engedélyezni:

1. Nyissuk meg a wp-config.php fájlt és keressük meg az alábbi sort:

   define('WP_DEBUG', false);

2. Utána szúrjuk be az alábbi sorokat. Az első sor az error log bekapcsolása. A második sor a log engedélyezése, a harmadik sor pedig megtiltja, hogy a külső felületen meglegyenek jelenítve a hibák.

   define('WP_DEBUG', true);
   define('WP_DEBUG_LOG', true);
   define('WP_DEBUG_DISPLAY', false);

3. Nézzünk vissza pár nappal később és látni fogjuk a wp-content mappában egy debug.log fájlt, amit sima szövegszerkesztővel meg tudunk nyitni és már láthatjuk is a hibákat.

A szerveren lévő PHP error log író használata

Jómagam és más fejlesztők is, a plugin mellőzés hívei vagyunk. Nézzük a lépéseket, miként is lehet ezt bekapcsolni, engedélyezni:

1. Nyissuk meg a wp-config.php fájlt és keressük meg az alábbi sort:

   define('WP_DEBUG', false);

2. Helyette szúrjuk be az alábbi sorokat. Az első sor az error log bekapcsolása. A második sor a hibajegyek típusainak kiválasztása, az ALL minden jellegű hibát rögzít. A harmadik az error log fájl neve és kiterjesztése.

   ini_set('log_errors',TRUE);
   ini_set('error_reporting', E_ALL);
   ini_set('error_log', dirname(__FILE__) . '/hibanaploneve.txt');

3. Hozzunk létre a wp-config.php fájlal egy szinten (azonos mappában, tehát a WordPress fő könyvtárában) egy hibanaploneve.txt fájlt, amit üresen töltsünk fel és adjunk neki CHMOD 777-es jogosultságot, hogx írható legyen a fájl.
4. Nézzünk vissza pár nappal később és látni fogjuk a hibákat.

Tanácsaim a hibanaplózáshoz

Hogyan osszunk meg hibanapló részleteket, bejegyzéseket

Amennyiben csak pár sornyi, azt simán bemásolhatjuk email-be vagy akár Facebook bejegyzésbe. Azonban ha nagyobb, akkor érdemes már csak belinkelni. Itt vagy közvetlenül a hibanapló linkjét küldheted el vagy kimásolhatod a tartalmát és szöveg / kód megosztó oldalakra másolhatod fel. Ilyen például a Pastebin.com vagy a Justpaste.it például.

Mire ügyeljünk a hibanaplónál?

• Az első és legfontosabb, hogy arra törekedjünk, hogy üres legyen a hibanapló. Ezt persze nem minden esetben lehet elérni. Azt vegyük figyelembe, hogy a hiba ismétlődése során az többször bekerül az error log-ba. Így ha a weboldalunk kezdőlapja generál egy hibát és naponta van 1000 látogatónk, akkor ez már is 1000 sornyi bejegyzést fog eredményezni. Tehát hibanaplót fejlesztés és debug, hibakeresés alatt érdemes készíteni, illetve ha gyanús a honlapunk működése és nem vagyunk biztosak a funkciók rendes működésében. Ugyan is, ha egy hibáktól hemzsegő weboldalon bekapcsolva van felejtve, akkor könnyen lehet egy kezelhetetlen több száz megabyte méretű óriási error log fájlunk, amit ha egy honlapkészítő szakember meglát, sírva rohan el egy kávéért, majd menekül ki a világból. Arról nem is beszélve, hogy sokan igyekeznek a tárhelyük méretét minimalizálni.
• Plugin esetén pedig ha azt rosszul állítjuk be, akkor az nagyon megnövelheti az adatbázisunk méretét és lassíthatja is akár a honlapunkat.
• Használjunk saját hibanaplózásnál egyedi fájlnevet használjunk. Egyes bővítmények, sablonok hibás működését ugyan is akár ki is használhatják rossz indulatú támadók.
• Amikor bizonyos sorokat kimásolunk a hibanaplóból, ellenőrizzük azokat, hogy esetleges privát információkat ne tartalmazzon.

Összegezve

A hibanapló ahogy a neve is mondja, a hibák összeírására van. Fejlesztés során kötelező, de igazából egy minőségi honlapkészítő esetében elvárás lenne egy üres error log, egy alapos tesztelést követően. Azonban nagyon sokan nem használják, még ha csak egy rövid időre is. Sok kérdéshez adhat a hibanapló olyan háttér információt, amivel a válasz sokkal pontosabb és hatékonyabb lehet. Már pedig egy jól feltett és szükséges információkat tartalmazó kérdésre hamarabb és nagyobb eséllyel érkezik segítő válasz. Használjuk tehát az error log-ot, amikor szükséges.