[Beitragt von Atwix]{class="badge informative" title="Atwix"}

Schreiben in eine benutzerdefinierte Protokolldatei

Die Magento\Framework\Logger -Modul enthält die folgenden Handler-Klassen:

Sie können sie im lib/internal/Magento/Framework/Logger/Handler Verzeichnis.

Sie können einen der folgenden Ansätze zum Anmelden bei einer benutzerdefinierten Datei verwenden:

  • Richten Sie eine benutzerdefinierte Protokolldatei im di.xml
  • Einrichten einer benutzerdefinierten Datei in der benutzerdefinierten Logger-Handler-Klasse

Richten Sie eine benutzerdefinierte Protokolldatei im di.xml

In diesem Beispiel wird gezeigt, wie virtuelle Typen zum Protokoll debug Nachrichten in eine benutzerdefinierte Protokolldatei anstelle einer standardmäßigen /var/log/debug.log.

  1. Im di.xml -Datei Ihres Moduls eine benutzerdefinierte Protokolldatei als virtueller Typ.

    code language-xml
    <virtualType name="Magento\Payment\Model\Method\MyCustomDebug" type="Magento\Framework\Logger\Handler\Base">
        <arguments>
            <argument name="fileName" xsi:type="string">/var/log/payment.log</argument>
         </arguments>
    </virtualType>
    

    Die name Wert von Magento\Payment\Model\Method\MyCustomDebug muss eindeutig sein.

  2. Definieren des Handlers in einem anderen virtueller Typ mit einer eindeutigen name:

    code language-xml
    <virtualType name="Magento\Payment\Model\Method\MyCustomLogger" type="Magento\Framework\Logger\Monolog">
        <arguments>
            <argument name="handlers" xsi:type="array">
                <item name="debug" xsi:type="object">Magento\Payment\Model\Method\MyCustomDebug</item>
            </argument>
        </arguments>
    </virtualType>
    
  3. Injizieren Sie die MyCustomLogger virtueller Typ im Magento\Payment\Model\Method\Logger -Objekt:

    code language-xml
    <type name="Magento\Payment\Model\Method\Logger">
        <arguments>
            <argument name="logger" xsi:type="object">Magento\Payment\Model\Method\MyCustomLogger</argument>
        </arguments>
    </type>
    
  4. Die virtuelle Klasse Magento\Payment\Model\Method\MyCustomDebug wird in die debug Handler der $logger -Eigenschaft in der Magento\Payment\Model\Method\Logger -Klasse.

    code language-xml
    ...
    <argument name="handlers" xsi:type="array">
        <item name="debug" xsi:type="object">Magento\Payment\Model\Method\MyCustomDebug</item>
    </argument>
    

Ausnahmemeldungen werden bei der /var/log/payment.log -Datei.

Einrichten einer benutzerdefinierten Protokolldatei in der Logger-Handler-Klasse

In diesem Beispiel wird gezeigt, wie eine benutzerdefinierte Logger-Handler-Klasse zur Protokollierung verwendet wird error Meldungen in eine bestimmte Protokolldatei eintragen.

  1. Erstellen Sie eine Klasse, die Daten protokolliert. In diesem Beispiel wird die Klasse definiert in app/code/Vendor/ModuleName/Logger/Handler/ErrorHandler.php.

    code language-php
    <?php
    /**
     * @author Vendor
     * @copyright Copyright (c) 2019 Vendor (https://www.vendor.com/)
     */
    namespace Vendor\ModuleName\Logger\Handler;
    
    use Magento\Framework\Logger\Handler\Base as BaseHandler;
    use Monolog\Logger as MonologLogger;
    
    /**
     * Class ErrorHandler
     */
    class ErrorHandler extends BaseHandler
    {
        /**
         * Logging level
         *
         * @var int
         */
        protected $loggerType = MonologLogger::ERROR;
    
        /**
         * File name
         *
         * @var string
         */
        protected $fileName = '/var/log/my_custom_logger/error.log';
    }
    
  2. Definieren Sie den Handler für diese Klasse als virtueller Typ im Modul di.xml -Datei.

    code language-xml
    <virtualType name="MyCustomLogger" type="Magento\Framework\Logger\Monolog">
        <arguments>
            <argument name="handlers" xsi:type="array">
                <item name="error" xsi:type="object">Vendor\ModuleName\Logger\Handler\ErrorHandler</item>
            </argument>
        </arguments>
    </virtualType>
    

    MyCustomLogger ist eine eindeutige Kennung.

  3. Im type -Definition geben Sie den Klassennamen an, in den der benutzerdefinierte Logger-Handler eingefügt wird. Verwenden Sie den Namen des virtuellen Typs aus dem vorherigen Schritt als Argument für diesen Typ.

    code language-xml
    <type name="Vendor\ModuleName\Observer\MyObserver">
        <arguments>
            <argument name="logger" xsi:type="object">MyCustomLogger</argument>
        </arguments>
    </type>
    

    Quellcode von Vendor\ModuleName\Observer\MyObserver -Klasse:

    code language-php
    <?php
    /**
     * @author Vendor
     * @copyright Copyright (c) 2019 Vendor (https://www.vendor.com/)
     */
    declare(strict_types=1);
    
    namespace Vendor\ModuleName\Observer;
    
    use Psr\Log\LoggerInterface as PsrLoggerInterface;
    use Exception;
    use Magento\Framework\Event\ObserverInterface;
    use Magento\Framework\Event\Observer;
    
    /**
     * Class MyObserver
     */
    class MyObserver implements ObserverInterface
    {
        /**
         * @var PsrLoggerInterface
         */
        private $logger;
    
        /**
         * MyObserver constructor.
         *
         * @param PsrLoggerInterface $logger
         */
        public function __construct(
            PsrLoggerInterface $logger
        ) {
            $this->logger = $logger;
        }
    
        /**
         * @param Observer $observer
         */
        public function execute(Observer $observer)
        {
            try {
                // some code goes here
            } catch (Exception $e) {
                $this->logger->error($e->getMessage());
            }
        }
    }
    
  4. Die Klasse Vendor\ModuleName\Logger\Handler\ErrorHandler wird in die error Handler der $logger -Eigenschaft in der Vendor\ModuleName\Observer\MyObserver.

    code language-xml
    ...
    <argument name="handlers" xsi:type="array">
        <item name="error" xsi:type="object">Vendor\ModuleName\Logger\Handler\ErrorHandler</item>
    </argument>
    ...
    

Ausnahmemeldungen werden im /var/log/my_custom_logger/error.log -Datei.

recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c