Magento 2:¿Reemplazo del método Mage::log?
-
13-12-2019 - |
Pregunta
En Magento 1, si quisiera enviar un mensaje a los registros, usaría un método estático en el global Mage
clase.
Mage::log($message, Zend_Log::DEBUG, "my-log-file.log");
¿Existe un equivalente en Magento 2?He busqué en Google el sitio de documentos de desarrollo y no he visto nada obvio que aparezca.hay este Inchoo artículo, pero es de hace casi un año y muchas cosas han cambiado desde entonces.
Como desarrollador del módulo Magento 2, si quiero reemplazar código como el siguiente en Magento 1
Mage::log($message, Zend_Log::DEBUG, "my-log-file.log");
¿Cuál es lo mínimo que debo hacer?
Solución
protected $logger;
public function __construct(\Psr\Log\LoggerInterface $logger)
{
$this->logger = $logger;
}
Utilice el sistema de depuración, excepción, para PSR Logger, por ejemplo:
$this->logger->info($message);
$this->logger->debug($message);
Otros consejos
En magento2, también puedes escribir en los registros usando el Zend
biblioteca como a continuación:
$writer = new \Zend\Log\Writer\Stream(BP . '/var/log/test.log');
$logger = new \Zend\Log\Logger();
$logger->addWriter($writer);
$logger->info('Your text message');
Editado
También puede imprimir objetos y matrices PHP como se muestra a continuación:
$logger->info(print_r($yourArray, true));
\Magento\Framework\App\ObjectManager::getInstance()
->get(\Psr\Log\LoggerInterface::class)->debug('message');
Lea mas en: blog.mageprince.com
Registro de impresión temporal con archivo nuevo
$writer = new \Zend\Log\Writer\Stream(BP . '/var/log/logfile.log');
$logger = new \Zend\Log\Logger();
$logger->addWriter($writer);
$logger->info('Simple Text Log'); // Simple Text Log
$logger->info('Array Log'.print_r($myArrayVar, true)); // Array Log
Método de fábrica
Necesitas inyectar \Psr\Log\LoggerInterfaz clase en el constructor para llamar al objeto registrador
protected $_logger;
public function __construct(
...
\Psr\Log\LoggerInterface $logger
...
) {
$this->_logger = $logger;
}
public function logExample() {
//To print string Output in debug.log
$this->_logger->addDebug('Your Text Or Variables');
// To print array Output in system.log
$this->_logger->log('600', print_r($yourArray, true));
}
O usa directamente este código en el archivo phtml:
Para imprimir la salida de la cadena en debug.log
\Magento\Framework\App\ObjectManager::getInstance()
->get('Psr\Log\LoggerInterface')->debug('Your Message');
Para imprimir la salida de la matriz en system.log
$myArray = array('test1'=>'123', 'test2'=>'123', 'test3'=>'123');
$level = '100'; // use one of: 100, 200, 250, 300, 400, 500, 550, 600
\Magento\Framework\App\ObjectManager::getInstance()
->get('Psr\Log\LoggerInterface')
->log($level, print_r($myArray, true));
Si desea utilizar el registrador predeterminado pero un archivo personalizado para el registro (u otra lógica personalizada), debe utilizar un controlador de registrador personalizado:
class Logger extends Magento\Framework\Logger\Handler\Base
{
/**
* @var string
*/
protected $fileName = '/var/log/my-log-file.log';
/**
* @var int
*/
protected $loggerType = MonologLogger::DEBUG;
}
Luego agréguelo como controlador en algún lugar dentro de su código:
protected function addCustomLogHandler()
{
$logger = Data::getCustomLogger();
if(isset($this->_logger)){
$this->_logger->pushHandler($logger);
}
}
Un paso atrás en la conveniencia en mi opinión
De una manera simple, si no desea crear una inyección de dependencia o cualquier otra cosa, use el siguiente código, almacenará el inicio de sesión. system.log
archivo
$logger = \Magento\Framework\App\ObjectManager::getInstance()->get(\Psr\Log\LoggerInterface::class);
$logger->info('message');
Eso es todo..
No, no existe un equivalente directo.Es un poco complicado ahora.
Ver: Iniciar sesión en un archivo personalizado en Magento 2
Incluya la clase psr logger en su archivo usando usar y luego llamar addDebug()
método.Esto imprimirá el mensaje de registro en var/log/debug.log
archivo
use Psr\Log\LoggerInterface;
class demo {
function demo()
{
//EDIT: Using debug instead of addDebug for PSR compatiblity
$this->_objectManager->get('Psr\Log\LoggerInterface')->debug("your message goes here");
}
}
ACTUALIZADO:19/08/2019
Si busca un controlador de registro personalizado elegante, le recomiendo que utilice tipos virtuales (que no necesitan agregar ningún código PHP)
Inspirado en la respuesta de Petar Dzhambazov y hablar, Damas y caballeros, les presenté una forma mejor y más corta en lugar de duplicar el código de registro personalizado todo el tiempo.
StackOverflow\Ejemplo\etc\di.xml
<!-- Custom log file for StackOverflow ; Duplicate it as much as you want separate log file -->
<virtualType name="StackOverflow\Example\Model\Logger\VirtualDebug" type="Magento\Framework\Logger\Handler\Base">
<arguments>
<argument name="fileName" xsi:type="string">/var/log/stackoverflow/donald_trump.log</argument>
</arguments>
</virtualType>
<virtualType name="StackOverflow\Example\Model\Logger\VirtualLogger" type="Magento\Framework\Logger\Monolog">
<arguments>
<argument name="name" xsi:type="string">DonaldTrump</argument>
<argument name="handlers" xsi:type="array">
<item name="debug" xsi:type="object"> StackOverflow\Example\Model\Logger\VirtualDebug</item>
</argument>
</arguments>
</virtualType>
USO
Proveedor\Algo\Modelo\DonaldTrump.php
<?php
/**
* Copyright © 2016 Toan Nguyen <https://nntoan.github.io>. All rights reserved.
* See COPYING.txt for license details.
*
* This is the file you want to inject your custom logger.
* Of course, your logger must be an instance of \Psr\Log\LoggerInterface.
*/
namespace Vendor\Something\Model;
/**
* DonaldTrump business logic file
*
* @package Vendor\Something\Model
* @author Toan Nguyen <https://github.com/nntoan>
*/
class DonaldTrump
{
/**
* @var \Psr\Log\LoggerInterface
*/
private $logger;
/**
* DonaldTrump constructor.
*
* @param \Psr\Log\LoggerInterface $logger
*/
public function __construct(
\Psr\Log\LoggerInterface $logger,
) {
$this->logger = $logger;
}
// 1 billion lines of code after this line
}
StackOverflow\Ejemplo\etc\frontend\di.xml
<type name="Vendor\Something\Model\DonaldTrump">
<arguments>
<argument name="logger" xsi:type="object">StackOverflow\Example\Model\Logger\VirtualLogger</argument>
</arguments>
</type>
Eso es todo, sin archivos ni líneas PHP adicionales: utilice las ventajas de Magento 2:Tipos virtuales!!!
Espero que esto ayude ;)
Hay una actualización para el registrador en 2.2.Puede habilitar el registrador para el modo de producción ejecutando SQL:
"INSERT INTO core_config_data (scope, scope_id, path, value) VALUES ('default', '0', 'dev/debug/debug_logging', '1');"
Entonces puedes usar \Psr\Log\LoggerInterface
para imprimir el registro como las respuestas anteriores:
protected $logger;
public function __construct(
\Psr\Log\LoggerInterface $logger
) {
$this->logger = $logger;
}
public function yourFunction() {
$data = ["test" => "testing"];
$this->logger->debug(var_export($data, true));
}
Inyectar
$logger
clase en constructor\Psr\Log\LoggerInterface $logger
Esto se logra pasando $logger como argumento.Inicializar
$logger
en constructor$this->logger = $logger
En función dentro de la clase que desea iniciar sesión, utilice la siguiente línea
$this->logger->debug($message); $this->logger->log($level, $message);
Si lo necesita dentro de su clase única con un archivo de registro personalizado:
public function __construct(\Psr\Log\LoggerInterface $logger, \Magento\Framework\App\Filesystem\DirectoryList $dir)
{
$this->logger = $logger;
$this->dir = $dir;
$this->logger->pushHandler(new \Monolog\Handler\StreamHandler($this->dir->getRoot().'/var/log/custom.log'));
}
Coloque el código del registrador PSR en su constructor:
protected $logger;
public function __construct(\Psr\Log\LoggerInterface $logger)
{
$this->logger = $logger;
}
entonces puedes usar en tu función como:
$this->logger->info($message);