Magento2:Substituição do método Mage::log?
-
13-12-2019 - |
Pergunta
No Magento 1, se você quisesse enviar uma mensagem para os logs, você usaria um método estático no global Mage
aula.
Mage::log($message, Zend_Log::DEBUG, "my-log-file.log");
Existe um equivalente no Magento 2?Eu tenho pesquisei no Google o site dev docs e não vi nada óbvio que apareceu.Há este Inchoo artigo, mas é de quase um ano atrás e muita coisa mudou desde então.
Como desenvolvedor de módulo Magento 2, se eu quiser substituir código como o seguinte no Magento 1
Mage::log($message, Zend_Log::DEBUG, "my-log-file.log");
Qual é o mínimo que preciso fazer?
Solução
protected $logger;
public function __construct(\Psr\Log\LoggerInterface $logger)
{
$this->logger = $logger;
}
Você usa depuração, exceção, sistema para PSR Logger, por exemplo:
$this->logger->info($message);
$this->logger->debug($message);
Outras dicas
No magento2, você também pode gravar nos logs usando o Zend
biblioteca como abaixo:
$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
Você também pode imprimir objetos e arrays PHP como abaixo:
$logger->info(print_r($yourArray, true));
\Magento\Framework\App\ObjectManager::getInstance()
->get(\Psr\Log\LoggerInterface::class)->debug('message');
Leia mais em: blog.mageprince.com
Log de impressão temporário com novo arquivo
$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
Você precisa injetar \Psr\Log\LoggerInterface classe no construtor para chamar o objeto logger
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));
}
Ou você usa este código diretamente no arquivo phtml:
Para imprimir a saída da string em debug.log
\Magento\Framework\App\ObjectManager::getInstance()
->get('Psr\Log\LoggerInterface')->debug('Your Message');
Para imprimir a saída do array em 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));
Se você quiser usar o registrador padrão, mas um arquivo personalizado para registro (ou outra lógica personalizada), você precisará usar o manipulador do 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;
}
Em seguida, adicione-o como manipulador em algum lugar do seu código:
protected function addCustomLogHandler()
{
$logger = Data::getCustomLogger();
if(isset($this->_logger)){
$this->_logger->pushHandler($logger);
}
}
Um passo atrás na conveniência IMO
De uma forma simples se você não quiser criar injeção de dependência ou qualquer outra coisa use o código abaixo ele armazenará o login system.log
arquivo
$logger = \Magento\Framework\App\ObjectManager::getInstance()->get(\Psr\Log\LoggerInterface::class);
$logger->info('message');
Isso é tudo..
Não, não há equivalente direto.É um pouco complicado agora.
Inclua a classe psr logger em seu arquivo usando usar e depois ligue addDebug()
método.Isso imprimirá a mensagem de log em var/log/debug.log
arquivo
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");
}
}
ATUALIZADA:19/08/2019
Se você está procurando um manipulador de log personalizado e elegante, recomendo que você use Virtual Types (que não precisa adicionar nenhum código PHP)
Inspirado na resposta de Petar Djambazov e andar, senhoras e senhores, apresentei a vocês uma maneira melhor e mais curta, em vez de código de log personalizado duplicado o tempo todo.
StackOverflow\Exemplo\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
Fornecedor\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\Exemplo\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>
Isso é tudo, sem arquivos ou linhas PHP extras - aproveite as vantagens do Magento 2:Tipos Virtuais!!!
Espero que isto ajude ;)
Há uma atualização para o logger no 2.2.Você pode habilitar o criador de logs para o modo de produção executando SQL:
"INSERT INTO core_config_data (scope, scope_id, path, value) VALUES ('default', '0', 'dev/debug/debug_logging', '1');"
Então você pode usar \Psr\Log\LoggerInterface
para imprimir log, assim como as respostas acima:
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));
}
Injetar
$logger
classe no construtor\Psr\Log\LoggerInterface $logger
Isto é conseguido passando $logger como argumento.Inicializar
$logger
no construtor$this->logger = $logger
Na função dentro da classe que você deseja registrar, use a linha abaixo
$this->logger->debug($message); $this->logger->log($level, $message);
Se você precisar em sua única classe com arquivo de log 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 o código do registrador PSR em seu construtor:
protected $logger;
public function __construct(\Psr\Log\LoggerInterface $logger)
{
$this->logger = $logger;
}
então você pode usar em sua função como:
$this->logger->info($message);