[Medverkad av Atwix]{class="badge informative" title="Atwix"} [Endast PaaS]{class="badge informative" title="Gäller endast Adobe Commerce i molnprojekt (Adobe-hanterad PaaS-infrastruktur) och lokala projekt."}

Skriva till en anpassad loggfil

Modulen Magento\Framework\Logger innehåller följande hanterarklasser:

Du kan hitta dem i katalogen lib/internal/Magento/Framework/Logger/Handler.

Du kan använda någon av följande metoder för att logga in i en anpassad fil:

  • Konfigurera en anpassad loggfil i di.xml
  • Ställa in en anpassad fil i den anpassade logghanterarklassen

Konfigurera en anpassad loggfil i di.xml

I det här exemplet visas hur du använder virtuella typer för att logga debug-meddelanden i en anpassad loggfil i stället för en standard /var/log/debug.log.

  1. I filen di.xml i modulen definierar du en anpassad loggfil som en virtuell 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>
    

    Värdet name för Magento\Payment\Model\Method\MyCustomDebug måste vara unikt.

  2. Definiera hanteraren i en annan virtuell typ med en unik 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. Mata in MyCustomLogger virtuell typ i Magento\Payment\Model\Method\Logger-objektet:

    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. Den virtuella klassen Magento\Payment\Model\Method\MyCustomDebug injiceras i debug-hanteraren för egenskapen $logger i klassen Magento\Payment\Model\Method\Logger.

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

Undantagsmeddelanden loggas in i filen /var/log/payment.log.

Konfigurera en anpassad loggfil i klassen för logghanterare

I det här exemplet visas hur du använder en anpassad logghanterarklass för att logga error-meddelanden i en specifik loggfil.

  1. Skapa en klass som loggar data. I det här exemplet definieras klassen i 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. Definiera hanteraren för den här klassen som en virtuell typ i modulens di.xml-fil.

    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 är en unik identifierare.

  3. I definitionen type anger du klassnamnet där den anpassade logghanteraren matas in. Använd det virtuella typnamnet från föregående steg som argument för den här typen.

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

    Source-kod för klassen Vendor\ModuleName\Observer\MyObserver:

    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. Klassen Vendor\ModuleName\Logger\Handler\ErrorHandler injiceras i error-hanteraren för egenskapen $logger i 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>
    ...
    

Undantagsmeddelanden loggas i filen /var/log/my_custom_logger/error.log.

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