Magento 2. Monolog oder wie man Protokolle schreibt

Inhaltsverzeichnis

Monolog
Anwendungsfunktionen in Magento 2
Implementierung
Protokollierung mit dem Standardlogger
Protokollierung mit einem Standardlogger mit einem benutzerdefinierten Kanal
Schreiben in eine benutzerdefinierte Datei mit Ihrem eigenen Handler
Schreiben in eine benutzerdefinierte Datei mit virtualType
Schnelle Datenerfassung
Fazit

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 

• Logger ist ein Objekt, mit dem wir Protokolle aufzeichnen. Der Logger selbst zeichnet nicht auf, sondern verwaltet Handler. Es kann eine beliebige Nummer erstellt werden.
• Handler - ein Objekt, das Daten direkt verarbeitet. Sie können dem Logger so viele Handler hinzufügen, wie Sie möchten. Alle werden nacheinander aufgerufen, unabhängig davon, ob der angegebene Handler den Fehler verarbeiten konnte oder nicht. Die isHandling-Methode bestimmt, ob dieser Handler den empfangenen Fehler verarbeiten kann.
  
  

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

  
  Die größte Ähnlichkeit mit dem Handler ist meiner Meinung nach der Event Observer.
  
• Prozessor - jede aufgerufene Entität (aufrufbar). Vielleicht ein paar. Sie können sowohl global zugewiesen als auch für den Handler installiert werden. Zunächst werden globale Prozessoren gestartet. Die Hauptaufgabe des Prozessors besteht darin, dem Protokoll zusätzliche Daten hinzuzufügen (z. B. die IP, von der aus die Verbindung hergestellt wurde, den Wert globaler Variablen, Informationen darüber, auf welchem ​​Git-Zweig sich der Code befindet usw.).
• Formatierer - Konvertiert die Nachrichtenausgabe vor dem Schreiben. Es kann nur 1 pro Handler geben. Es ist notwendig, die Formatierung des Nachrichtentexts zu ändern, um beispielsweise Text in HTML oder JSON zu konvertieren.
• Kanal - der Name des Loggers. Es wird beim Aufzeichnen des Protokolls geschrieben. Da 1 Handler in 2 verschiedenen Loggern verwendet werden kann (er schreibt Protokolle in 1 dieselbe Datei), wird dadurch bestimmt, woher der Fehler stammt.
• Level - Fehlerlevel. Dieser Parameter für den Handler gibt die minimale Fehlerstufe an, die er behandeln wird.
• Bubble - Nachrichten-Popup. Nachdem der Handler die Nachricht verarbeitet hat, leitet der Logger die Nachricht an den nächsten Handler weiter. Dieser Prozess kann mithilfe der Eigenschaft bubble gestoppt werden. Wenn der Handler den Wert dieser Eigenschaft false hat (der Standardwert ist immer true), werden andere Handler nicht gestartet, nachdem dieser Handler seine Arbeit erledigt hat (dieser Fehler konnte verarbeitet werden).
• Sortierreihenfolge - Ausführungsreihenfolge. Der zuletzt hinzugefügte Handler wird immer als allererster gestartet. Mit dieser Funktion können Sie einen Mechanismus implementieren, um den Logger vollständig zu deaktivieren (über Bubbling False). Über den Konstruktor hinzugefügte Handler werden in der im Konstruktor angegebenen Reihenfolge ausgeführt.

Da PSR-3 Entwickler nicht verpflichtet, AutoCorrect-Werte im Text zu implementieren, führt Monolog dies standardmäßig nicht aus. Wenn Sie schreiben -> emerg ('test 1111 {placeholder}', ['placeholder' => 'foo']), erhalten Sie Folgendes
[2019-08-12 02:57:52] main.EMERGENCY: test 1111 {placeholder} {"placeholder": "foo"} []

Damit der Austausch funktioniert, müssen Sie einen zusätzlichen Prozessor anschließen - \ Monolog \ Processor \ PsrLogMessageProcessor.

Anwendungsfunktionen in Magento 2

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

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

Wenn das Objekt keine solche Eigenschaft hat (_logger oder logger), müssen wir zuerst die Abhängigkeit \ Psr \ Log \ LoggerInterface zu Ihrer Klasse hinzufügen und das resultierende Objekt in die Eigenschaft $ logger schreiben (gemäß PSR-2 Punkt 4.2 und dem auf der Magento-Website dargestellten Beispiel ). .

 $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 bis 2.2 hatten ein Problem damit, dass der Logger nach dem ersten gefundenen nicht mehr zu einem anderen Handler springen konnte. Dieses Problem wurde durch die Tatsache verursacht, dass Monolog berechnete, dass alle Handler in einem Array mit digitalen Schlüsseln und mit alphabetischen Schlüsseln (['system' =>, 'debug' =>, ...]) darauf kamen. Magento-Entwickler haben die Situation später korrigiert - sie konvertieren den Hash in ein reguläres Array mit digitalen Schlüsseln, bevor sie ihn an Monolog übergeben. Monolog hat jetzt auch den Handler-Aufzählungsalgorithmus geändert und verwendet die next () -Methode.

Implementierung

1. Protokollierung mit dem Standardlogger

 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. Protokollierung mit einem Standardlogger mit einem benutzerdefinierten Kanal

 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. Schreiben Sie mit Ihrem eigenen Handler in eine benutzerdefinierte Datei

 <?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() } } 

In Magento 2 2.2+ im Konstruktor \ Magento \ Framework \ Logger \ Handler \ Base hat sich die Art und Weise der Verarbeitung des Pfads zur Protokolldatei geändert

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

Daher finden Sie in älteren Handlern / am Anfang von $ 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. Schreiben in eine benutzerdefinierte Datei mit virtualType

In Magento 2 2.2+ wurde dem Konstruktor \ Magento \ Framework \ Logger \ Handler \ Base ein neuer Parameter hinzugefügt, mit dem Sie einen virtuellen Handler erstellen und über di.xml den relativen Pfad zur Datei zum Schreiben des Protokolls angeben können. Bisher war es erforderlich, entweder den vollständigen Pfad durch $ filePath anzugeben oder einen neuen Handler zu erstellen und den relativen Pfad in die geschützte Datei $ fileName-Eigenschaft zu schreiben.

  <!--      ,     --> <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. Schnelle Datenprotokollierung

 ... $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); ... 

Fazit