الماجنتو 2. مونولوج أو كيفية كتابة السجلات

جدول المحتويات

Monolog
ميزات التطبيق في Magento 2
تطبيق
تسجيل باستخدام المسجل القياسية
تسجيل باستخدام مسجل قياسي مع قناة مخصصة
الكتابة إلى ملف مخصص باستخدام معالج الخاصة بك
الكتابة إلى ملف مخصص باستخدام virtualType
تسجيل بيانات سريع
استنتاج

Monolog

use Monolog\Logger; use Monolog\Handler\StreamHandler; use Monolog\Formatter\HtmlFormatter; //     "name" $log = new Logger('name'); //  ,      "path/to/your1.log"       "WARNING"   (notice, info  debug   ). $log->pushHandler(new StreamHandler('path/to/your1.log', Logger::WARNING)); //  ,      "path/to/your2.log"       "ALERT"   (..        alert  emergency).    ,    .         html   HtmlFormatter. $log->pushHandler(new StreamHandler('path/to/your2.log', Logger::ALERT,false) ->setFormatter(new HtmlFormatter)); //  ,       . $log->pushProcessor(function ($record) { $record['extra']['dummy'] = 'Hello world!'; return $record; }); //   $log->warning('Foo'); $log->error('Bar',['test']); $log->info('Test'); //   ,    1     INFO //your1.log // [2019-08-12 02:57:52] name.WARNING: Foo [] ['extra'=>['dummy'=>'Hello world!']] // [2019-08-12 02:57:53] name.ERROR: BAR ['test'] ['extra'=>['dummy'=>'Hello world!']] //your2.log // , .    ALERT  EMERGENCY 

• المسجل هو كائن نستخدمه لتسجيل السجلات. المسجل نفسه لا يسجل ، ولكن يدير معالجات. يمكن إنشاء أي رقم.
• معالج - كائن يعالج البيانات مباشرة. يمكنك إضافة العديد من المعالجات إلى المسجل كما تريد. سيتم استدعاء كل منهم بدوره ، بغض النظر عما إذا كان المعالج المحدد قادرًا على معالجة الخطأ أم لا. تحدد طريقة isHandling ما إذا كان هذا المعالج سيكون قادرًا على معالجة الخطأ المستلم.
  
  

   public function isHandling(array $record) { return $record['level'] >= $this->level; } 

  
  أقرب تشابه إلى المعالج ، في رأيي ، هو مراقب الأحداث.
  
• المعالج - أي كيان يسمى (استدعاء). ربما القليل. يمكن تعيينهما عالميًا وتثبيتهما للمعالج. أولاً ، يتم إطلاق المعالجات العالمية. تتمثل المهمة الرئيسية للمعالج في إضافة بيانات إضافية إلى السجل (على سبيل المثال ، عنوان IP الذي كان الاتصال منه ، وقيمة المتغيرات العامة ، والمعلومات التي يتفرع عنها الرمز ، وما إلى ذلك).
• المنسق - يحول إخراج الرسالة قبل الكتابة. لا يمكن أن يكون هناك سوى 1 لكل معالج. من الضروري تغيير تنسيق نص الرسالة ، على سبيل المثال ، لتحويل النص إلى html أو json.
• قناة - اسم المسجل. سيتم كتابتها عند تسجيل السجل. نظرًا لأنه يمكن استخدام معالج واحد في قطعتي تسجيل مختلفتين (سوف يكتب السجلات إلى ملف واحد في نفس الملف) ، فسيحدد ذلك مصدر الخطأ.
• المستوى - مستوى الخطأ. تشير هذه المعلمة للمعالج إلى الحد الأدنى من مستوى الخطأ الذي سيتم التعامل معه.
• فقاعة - رسالة منبثقة. بعد قيام المعالج بمعالجة الرسالة ، يقوم المسجل بتمرير الرسالة إلى المعالج التالي. يمكن إيقاف هذه العملية باستخدام خاصية الفقاعة. إذا كان لدى المعالج قيمة هذه الخاصية false (الافتراضي صحيح دائمًا) ، فبعد قيام هذا المعالج بعمله (كان قادرًا على معالجة هذا الخطأ) ، لن يتم تشغيل معالجات أخرى.
• ترتيب فرز - ترتيب التنفيذ. يتم دائمًا تشغيل المعالج الأخير المضاف الأول. هذه هي الميزة التي تسمح لك بتنفيذ آلية لتعطيل المسجل بالكامل (عبر فقاعات كاذبة). انتقل معالجات المضافة خلال المنشئ بالترتيب المحدد في المنشئ.

نظرًا لأن PSR-3 لا يلزم المطورين بتنفيذ قيم التصحيح التلقائي في النص ، فإن Monolog لا تقوم بذلك افتراضيًا. إذا كتبت -> الطوارئ ('test 1111 {placeholder}' ، ['placeholder' => 'foo']) ستحصل على ما يلي
[2019-08-12 02:57:52] main.EMERGENCY: اختبار 1111 {placeholder} {"placeholder": "foo"} []

لاستبدال العمل ، تحتاج إلى توصيل معالج إضافي - \ Monolog \ Processor \ PsrLogMessageProcessor.

ميزات التطبيق في Magento 2

 2019-08-12T01:00:27+00:00 DEBUG (7): ALARM! 

 [2019-08-12 02:56:43] main.INFO: ALARM! [] [] 

إذا لم يكن الكائن يحتوي على هذه الخاصية (_logger أو المسجل) ، فعلينا أولاً إضافة التبعية \ Psr \ Log \ LoggerInterface إلى صفك وكتابة الكائن الناتج إلى خاصية $ logger (وفقًا لبند PSR-2 4.2 والمثال المقدم على موقع Magento الإلكتروني ) .

 $this->_logger->{level}($message, $context = []); //$this->_logger->log('{level}', $message, $context = []); 

 public function commit() { $this->getConnection()->commit(); if ($this->getConnection()->getTransactionLevel() === 0) { $callbacks = CallbackPool::get(spl_object_hash($this->getConnection())); try { foreach ($callbacks as $callback) { call_user_func($callback); } } catch (\Exception $e) { $this->getLogger()->critical($e); } } return $this; } … private function getLogger() { if (null === $this->_logger) { $this->_logger = ObjectManager::getInstance()->get(\Psr\Log\LoggerInterface::class); } return $this->_logger; } 

 … <preference for="Psr\Log\LoggerInterface" type="Magento\Framework\Logger\Monolog" /> ... <type name="Magento\Framework\Logger\Monolog"> <arguments> <argument name="name" xsi:type="string">main</argument> <argument name="handlers" xsi:type="array"> <item name="system" xsi:type="object">Magento\Framework\Logger\Handler\System</item> <item name="debug" xsi:type="object">Magento\Framework\Logger\Handler\Debug</item> <item name="syslog" xsi:type="object">Magento\Framework\Logger\Handler\Syslog</item> </argument> </arguments> </type> ... 

 ... public function write(array $record) { if (isset($record['context']['exception'])) { $this->exceptionHandler->handle($record); return; } $record['formatted'] = $this->getFormatter()->format($record); parent::write($record); } ... 

واجه Magento 2 إلى 2.2 مشكلة في عدم قدرة المسجل على الانتقال إلى معالج آخر بعد العثور على أول واحد. سبب هذه المشكلة هو أن Monolog توقعت أن يأتي كل معالجاتها في صفيف به مفاتيح رقمية ، ويأتي مع مفاتيح أبجدية (['system' =>، 'debug' =>، ...]). قام مطورو Magento بتصحيح الموقف في وقت لاحق - قاموا بتحويل التجزئة إلى صفيف منتظم مع مفاتيح رقمية قبل تمريره إلى Monolog. لقد غير Monolog الآن أيضًا خوارزمية تعداد المعالج ويستخدم الأسلوب التالي ().

تطبيق

1. تسجيل باستخدام المسجل القياسية

 class RandomClass { private $logger; public function __construct(\Psr\Log\LoggerInterface $logger) { $this->logger = $logger; } public function foo() { $this->logger->info('Something went wrong'); //[...some date...] main.INFO: Something went wrong [] [] } } 

 … $this->_logger->info('Something went wrong'); //    ->debug,   ,      debug.log ... 

2. تسجيل باستخدام مسجل قياسي مع قناة مخصصة

 class RandomClass { private $logger; public function __construct(\Psr\Log\LoggerInterface $logger) { $this->logger = $logger->withName('api'); //    } public function foo() { $this->logger->info('Something went wrong'); //[...some date...] api.INFO: Something went wrong [] [] } } 

 grep -rn 'api' var/log/system.log 

3. الكتابة إلى ملف مخصص باستخدام معالج الخاصة بك

 <?php namespace Oxis\Log\Logger\Handler; use Magento\Framework\Filesystem\DriverInterface; use Magento\Framework\Logger\Handler\Base; use Monolog\Logger; class Test extends Base { protected $fileName = 'var/log/critical.log'; protected $loggerType = Logger::CRITICAL; public function __construct(DriverInterface $filesystem) { parent::__construct($filesystem,null,null); $this->bubble = false; //      setBubble() } } 

في Magento 2 2.2+ في المُنشئ \ Magento \ Framework \ Logger \ Handler \ Base تغيرت طريقة معالجة المسار إلى ملف السجل

 // BP . $this->fileName // BP. DIRECTORY_SEPARATOR . $this->fileName 

لذلك ، في معالجات الأقدم لا يزال بإمكانك العثور على / في بداية $ fileName.

 use Oxis\Log\Logger\Handler\Test; use Psr\Log\LoggerInterface; class RandomClass { private $logger; public function __construct( LoggerInterface $logger, Test $handler ) { $logger->pushHandler($handler); //  setHandlers([$handler]),        . $this->logger = $logger; } public function foo() { $this->logger->critical('Something went wrong'); //      critical.log //[...some date...] main.CRITICAL: Something went wrong [] [] } } 

4. الكتابة إلى ملف مخصص باستخدام virtualType

في Magento 2 2.2+ ، تمت إضافة معلمة جديدة إلى المُنشئ \ Magento \ Framework \ Logger \ Handler \ Base ، والذي يسمح لك بإنشاء معالج افتراضي وتحديد المسار النسبي للملف من خلال di.xml لكتابة السجل. في السابق ، كان مطلوبًا إما تحديد المسار الكامل من خلال $ filePath ، أو لإنشاء معالج جديد وكتابة المسار النسبي إلى خاصية الملف fileName المحمية.

  <!--      ,     --> <virtualType name="ApiHandler" type="Magento\Framework\Logger\Handler\Base"> <arguments> <argument name="fileName" xsi:type="string">var/log/api.log</argument> </arguments> </virtualType> <!--  ,     --> <virtualType name="ApiLogger" type="Magento\Framework\Logger\Monolog"> <arguments> <argument name="name" xsi:type="string">api</argument> <argument name="handlers" xsi:type="array"> <item name="default" xsi:type="object">ApiHandler</item> </argument> </arguments> </virtualType> <!--       --> <type name="Oxis\Log\Model\A"> <arguments> <argument name="logger" xsi:type="object">ApiLogger</argument> </arguments> </type> 

 namespace Oxis\Log\Model; class A { private $logger; public function __construct(\Psr\Log\LoggerInterface $logger) { $this->logger = $logger; } public function foo() { $this->logger->info('Something went wrong'); } } 

 <virtualType name="ApiHandler" type="Magento\Framework\Logger\Handler\Base"> <arguments> <argument name="fileName" xsi:type="string">var/log/api.log</argument> </arguments> </virtualType> <virtualType name="ApiLogger" type="Magento\Framework\Logger\Monolog"> <arguments> <argument name="name" xsi:type="string">api</argument> <argument name="handlers" xsi:type="array"> <item name="default" xsi:type="object">ApiHandler</item> </argument> </arguments> </virtualType> <!--       logger--> <virtualType name="ApiLogContainingContext" type="Magento\Framework\Model\Context"> <arguments> <argument name="logger" xsi:type="object">ApiLogger</argument> </arguments> </virtualType> <!--    --> <type name="Oxis\Log\Model\A"> <arguments> <argument name="context" xsi:type="object">ApiLogContainingContext</argument> </arguments> </type> 

5. تسجيل البيانات بسرعة

 ... $log = new \Monolog\Logger('custom', [new \Monolog\Handler\StreamHandler(BP.'/var/log/custom.log')]); $log->error('test'); ... 

 ... file_put_contents(BP.'/var/log/custom.log', 'test',FILE_APPEND); ... 

استنتاج