Magento 2: Custom Log

In magento 2, custom log file is important to verify the log for specific critical function implementation and debug the issues in the server level

Custom log file can be created by simply creating two virtual classes.

Virtual class definition in di.xml file

<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
 * di
 *
 * @copyright Copyright © 2021 Vasan. All rights reserved.
 * @author    survasp@gmail.com
 */
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <virtualType name="Vasan\CustomLog\Model\Service\LogHandler" type="Magento\Framework\Logger\Handler\Base">
        <arguments>
            <argument name="fileName" xsi:type="string">/var/log/cust.log</argument>
        </arguments>
    </virtualType>

    <virtualType name="Vasan\CustomLog\Model\Service\Logger" type="Magento\Framework\Logger\Monolog">
        <arguments>
            <argument name="handlers" xsi:type="array">
                <item name="debug" xsi:type="object">Vasan\CustomLog\Model\Service\LogHandler</item>
            </argument>
        </arguments>
    </virtualType>

    <type name="Vasan\CustomLog\Model\Service">
        <arguments>
            <argument name="logger" xsi:type="object">Vasan\CustomLog\Model\Service\Logger</argument>
        </arguments>
    </type>

</config>

Service class to give the debug message

<?php
/**
 * Service
 *
 * @copyright Copyright © 2021 Vasan. All rights reserved.
 * @author    survasp@gmail.com
 */

namespace Vasan\CustomLog\Model;


use Magento\Framework\App\Config\ScopeConfigInterface;
use Psr\Log\LoggerInterface;

class Service
{
    const XML_PATH_DEBUG = 'customlog/service/debug_enabled';
    
    /**
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * @var ScopeConfigInterface
     */
    protected $scopeConfig;

    /**
     * @param LoggerInterface $logger
     * @param ScopeConfigInterface $scopeConfig
     */
    public function __construct(
        LoggerInterface $logger,
        ScopeConfigInterface $scopeConfig
    ) {
        $this->logger = $logger;
        $this->scopeConfig = $scopeConfig;
    }


    /**
     * @param $message
     */
    public function log($message)
    {
        $isDebugEnabled = $this->scopeConfig->getValue(static::XML_PATH_DEBUG);
        if ($isDebugEnabled) {
            $this->logger->debug($message);
        }
    }

}

vasan

Say thanks

Last edit

Over 2 years ago

vasan

Keywords

Log

Magento 2 : Data cleaning and import

Following example shows how to clean customer and order records and import customer data from another database

## Following query to identify the name of the attribute and attribute id
select * from  live.eav_attribute where entity_type_i...

Magento 2 : Custom Email Sending

Email can be sent in magento customization with following implementation

First, The email template should be created in view section and registered in etc using email_template.xml

email_template.xml

<?xml version="1.0"?>

<config xmlns:xsi...

Magento 2 : Customer attribute creation

CustomerSetupFactory and Attribute SetFactory classes should be used to create the customer attribute using setup script

<?php


namespace ExamNotes\Chapter10\Setup;

use Magento\Customer\Setup\CustomerSetupFactory;
use Magento\Eav\Setup\Eav...

Magento 2: API Functional Testing

The API funcational testing can be implemented using following steps

First Step : Develop your API

Second Step : Write the API Test class

Eg:

<?php
/**
 * OrganisationRepositoryTest
 *
 * @copyright Copyright © 2023 Vasan. All rights reser...

Magento 2 Tips: main.WARNING: Session size of 257209 exceeded allowed session max size of 256000.

This can be fixed by excuting folloing configuration.

./bin/magento config:set system/security/max_session_size_admin 512000
./bin/magento config:set system/security/max_session_size_storefront 512000

Magento 2 : Create cron with config schedule

Step 1:

Create system.xml file with configuration field.

<group id="cron" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1"
                   showInStore="1">
                <label>MSD Cron</label>
      ...

Magento 2 : Admin Module Part 2

5.Create Model and Resource model

Address model class extends the AddressInterface and it contains the data object getters setter methods.

<?php
/**
 * Address
 *
 * @copyright Copyright © 2021 Va...

Posted by vasan to vasan's deck (2021-09-24 07:20)

Magento 2: Custom Log

Related cards:

5.Create Model and Resource model