مدیریت و گزارش خطاها در فریم ورک لاراول

Errors

پروژه ای که در حال انجام است ممکن است در حین اجرا به خطاهایی برخورد کند.در لاراول، وقتی شما یک پروژه جدید را راه اندازی می کنید، بطور پیش فرض مدیریت خطاها(Errors) و استثناها (exception)  برای شما پیکربندی شده است.

بطور معمول ما باید بتوانیم  erorrها در محیط local ببینیم تا آنها را رفع و اشکال زدایی کنیم. البته ما باید در محیط تولید (در زمان استفاده از برنامه در محیط تجاری) ، این خطاها را از دید کاربران مخفی نگاه داریم.

برای رسیدن به این هدف باید سراغ فایل .env موجود در روت اصلی پروژه برویم و متغیر APP_DEBUG را برابر true یا false قرار دهیم. برای محیط local باید متغیر APP_DEBUG را برابر true قرار دهیم تا خطاهای برنامه برای ما نمایش داده شود.

و برای محیط  تولید ، برای پنهان شدن خطا ها از دید کاربر ، متغیر APP_DEBUG را برابر false قرار می دهیم.

نکته : بعد از Set کردن متغیر APP_DEBUG شما باید سرورِ لاراول تان را restart کنید.

Logging

ثبت وقایع  یا Logging یک مکانیزمی است که، خطاهای تولید شده سیستم را ثبت می کند. این روش برای بهبود اطمینان سیستم بسیار مفید است.

لاراول ازحالت های مختلف ثبت گزارش (log)  پشتیبانی می‌کند، نظیرdaily ، single ، syslog و errorlog.

شما می توانید این حالت ها را در فایل config/app.php تنظیم کنید.

بعنوان مثال، اگر مایل به استفاده از فایل‌های log روزانه هستید، مقدار log  را به daily تنظیم کنید:

'log' => 'daily'

شما میتوانید log هایی که روزانه تولید می شوند را در این فایل storage/logs/laravel.log ببینید.

ساخت فایل log سفارشی

برای ایجاد یک فایل log سفارشی، باید مراحل زیر را دنبال کنید.

مرحله 1 – در این مرحله باید به وسیله facade ی به نام  log،  اطلاعات و گزارشات برنامه ی خود را، در فایل  log درج نمایید. این facade را می توانید به آسانی با تعریف کلمه use در یک controller اعلان نمایید.   این مطلب در کد زیر نمایش داده شده است .

<?php

use Log;
class LoginController extends Controller{
   public function FuncName(Request $request){
   
      // log something to storage/logs/laravel.log
      Log::info(['Request'=>$request]);}
   }
?>

در اینجا تابع FuncName با ارسال پارامتر $request به Log::info  به ساخت log کمک میکند.

مرحله 2 – اگر نیاز دارید تا این فایل را بطور جداگانه ذخیره نمایید، باید این کار را در این مرحله انجام دهید. برای این کار شما باید قبل از نوشتن Log::info از تابع useDailyFiles() استفاده کنید.همانطور که در تصویر نشان داده شده است.

<?php

use Log;
class LoginController extends Controller{
   public function FuncName(Request $request){
      
      // log something to storage/logs/debug.log
      Log::useDailyFiles(storage_path().'/logs/debug.log');
      Log::info(['Request'=>$request]);
   }
}
?>

همه logها داخل فایل debug.log قابل ردیابی هستند. خطاهای ذکر شده در log ها برای توسعه برنامه بسیار مفید هستند.

مرحله 3 – در این مرحله شما با ثبت کننده ی گزارشات (logger) در لاراول سرو کار دارید. که شامل سطوح مختلفی هستند که در مثال زیر آورده شده است.

Log::emergency($error);
Log::alert($error);
Log::critical($error);
Log::error($error);
Log::warning($error);
Log::notice($error);
Log::info($error);
Log::debug($error);

انواع سطوحی که می تواند در فایل log وجود داشته باشد عبارت است از emergency, alert, critical, error, warning, notice, info  و  debug.