mirror of
https://github.com/Seldaek/monolog.git
synced 2025-02-24 15:02:28 +01:00
Allow for both mlehner/gelf-php and graylog2/gelf-php usage
This commit is contained in:
parent
c8289fd654
commit
f0ed3d8054
@ -11,7 +11,9 @@
|
|||||||
|
|
||||||
namespace Monolog\Handler;
|
namespace Monolog\Handler;
|
||||||
|
|
||||||
use Gelf\Publisher;
|
use Gelf\IMessagePublisher;
|
||||||
|
use Gelf\PublisherInterface;
|
||||||
|
use InvalidArgumentException;
|
||||||
use Monolog\Logger;
|
use Monolog\Logger;
|
||||||
use Monolog\Formatter\GelfMessageFormatter;
|
use Monolog\Formatter\GelfMessageFormatter;
|
||||||
|
|
||||||
@ -29,14 +31,25 @@ class GelfHandler extends AbstractProcessingHandler
|
|||||||
protected $publisher;
|
protected $publisher;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param Publisher $publisher a publisher object
|
* @param PublisherInterface|IMessagePublisher $publisher a publisher object
|
||||||
* @param integer $level The minimum logging level at which this handler will be triggered
|
* @param integer $level The minimum logging level at which this handler will be triggered
|
||||||
* @param boolean $bubble Whether the messages that are handled can bubble up the stack or not
|
* @param boolean $bubble Whether the messages that are handled can bubble up the stack or not
|
||||||
*/
|
*/
|
||||||
public function __construct(Publisher $publisher, $level = Logger::DEBUG, $bubble = true)
|
public function __construct($publisher, $level = Logger::DEBUG, $bubble = true)
|
||||||
{
|
{
|
||||||
parent::__construct($level, $bubble);
|
parent::__construct($level, $bubble);
|
||||||
|
|
||||||
|
$validPublisher = false;
|
||||||
|
if (interface_exists('\Gelf\IMessagePublisher') && $publisher instanceof IMessagePublisher) {
|
||||||
|
$validPublisher = true;
|
||||||
|
} elseif (interface_exists('\Gelf\PublisherInterface') && $publisher instanceof PublisherInterface) {
|
||||||
|
$validPublisher = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$validPublisher) {
|
||||||
|
throw new InvalidArgumentException("Invalid publisher");
|
||||||
|
}
|
||||||
|
|
||||||
$this->publisher = $publisher;
|
$this->publisher = $publisher;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ class GelfMessageFormatterTest extends \PHPUnit_Framework_TestCase
|
|||||||
public function setUp()
|
public function setUp()
|
||||||
{
|
{
|
||||||
if (!class_exists('\Gelf\Message')) {
|
if (!class_exists('\Gelf\Message')) {
|
||||||
$this->markTestSkipped("graylog2/gelf-php not installed");
|
$this->markTestSkipped("graylog2/gelf-php or mlehner/gelf-php is not installed");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -47,7 +47,7 @@ class GelfMessageFormatterTest extends \PHPUnit_Framework_TestCase
|
|||||||
$this->assertEquals('meh', $message->getFacility());
|
$this->assertEquals('meh', $message->getFacility());
|
||||||
$this->assertEquals(null, $message->getLine());
|
$this->assertEquals(null, $message->getLine());
|
||||||
$this->assertEquals(null, $message->getFile());
|
$this->assertEquals(null, $message->getFile());
|
||||||
$this->assertEquals(3, $message->getSyslogLevel());
|
$this->assertEquals($this->isLegacy() ? 3 : 'error', $message->getLevel());
|
||||||
$this->assertNotEmpty($message->getHost());
|
$this->assertNotEmpty($message->getHost());
|
||||||
|
|
||||||
$formatter = new GelfMessageFormatter('mysystem');
|
$formatter = new GelfMessageFormatter('mysystem');
|
||||||
@ -184,4 +184,9 @@ class GelfMessageFormatterTest extends \PHPUnit_Framework_TestCase
|
|||||||
$this->assertArrayHasKey('_EXTkey', $message_array);
|
$this->assertArrayHasKey('_EXTkey', $message_array);
|
||||||
$this->assertEquals('pair', $message_array['_EXTkey']);
|
$this->assertEquals('pair', $message_array['_EXTkey']);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function isLegacy()
|
||||||
|
{
|
||||||
|
return interface_exists('\Gelf\IMessagePublisher');
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
95
tests/Monolog/Handler/GelfHandlerLegacyTest.php
Normal file
95
tests/Monolog/Handler/GelfHandlerLegacyTest.php
Normal file
@ -0,0 +1,95 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Monolog package.
|
||||||
|
*
|
||||||
|
* (c) Jordi Boggiano <j.boggiano@seld.be>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Monolog\Handler;
|
||||||
|
|
||||||
|
use Gelf\Message;
|
||||||
|
use Monolog\TestCase;
|
||||||
|
use Monolog\Logger;
|
||||||
|
use Monolog\Formatter\GelfMessageFormatter;
|
||||||
|
|
||||||
|
class GelfHandlerLegacyTest extends TestCase
|
||||||
|
{
|
||||||
|
public function setUp()
|
||||||
|
{
|
||||||
|
if (!class_exists('\Gelf\MessagePublisher') || !class_exists('\Gelf\Message')) {
|
||||||
|
$this->markTestSkipped("mlehner/gelf-php not installed");
|
||||||
|
}
|
||||||
|
|
||||||
|
require_once __DIR__ . '/GelfMocks.php';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers Monolog\Handler\GelfHandler::__construct
|
||||||
|
*/
|
||||||
|
public function testConstruct()
|
||||||
|
{
|
||||||
|
$handler = new GelfHandler($this->getMessagePublisher());
|
||||||
|
$this->assertInstanceOf('Monolog\Handler\GelfHandler', $handler);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getHandler($messagePublisher)
|
||||||
|
{
|
||||||
|
$handler = new GelfHandler($messagePublisher);
|
||||||
|
|
||||||
|
return $handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getMessagePublisher()
|
||||||
|
{
|
||||||
|
return new MockMessagePublisher('localhost');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDebug()
|
||||||
|
{
|
||||||
|
$messagePublisher = $this->getMessagePublisher();
|
||||||
|
$handler = $this->getHandler($messagePublisher);
|
||||||
|
|
||||||
|
$record = $this->getRecord(Logger::DEBUG, "A test debug message");
|
||||||
|
$handler->handle($record);
|
||||||
|
|
||||||
|
$this->assertEquals(7, $messagePublisher->lastMessage->getLevel());
|
||||||
|
$this->assertEquals('test', $messagePublisher->lastMessage->getFacility());
|
||||||
|
$this->assertEquals($record['message'], $messagePublisher->lastMessage->getShortMessage());
|
||||||
|
$this->assertEquals(null, $messagePublisher->lastMessage->getFullMessage());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testWarning()
|
||||||
|
{
|
||||||
|
$messagePublisher = $this->getMessagePublisher();
|
||||||
|
$handler = $this->getHandler($messagePublisher);
|
||||||
|
|
||||||
|
$record = $this->getRecord(Logger::WARNING, "A test warning message");
|
||||||
|
$handler->handle($record);
|
||||||
|
|
||||||
|
$this->assertEquals(4, $messagePublisher->lastMessage->getLevel());
|
||||||
|
$this->assertEquals('test', $messagePublisher->lastMessage->getFacility());
|
||||||
|
$this->assertEquals($record['message'], $messagePublisher->lastMessage->getShortMessage());
|
||||||
|
$this->assertEquals(null, $messagePublisher->lastMessage->getFullMessage());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInjectedGelfMessageFormatter()
|
||||||
|
{
|
||||||
|
$messagePublisher = $this->getMessagePublisher();
|
||||||
|
$handler = $this->getHandler($messagePublisher);
|
||||||
|
|
||||||
|
$handler->setFormatter(new GelfMessageFormatter('mysystem', 'EXT', 'CTX'));
|
||||||
|
|
||||||
|
$record = $this->getRecord(Logger::WARNING, "A test warning message");
|
||||||
|
$record['extra']['blarg'] = 'yep';
|
||||||
|
$record['context']['from'] = 'logger';
|
||||||
|
$handler->handle($record);
|
||||||
|
|
||||||
|
$this->assertEquals('mysystem', $messagePublisher->lastMessage->getHost());
|
||||||
|
$this->assertArrayHasKey('_EXTblarg', $messagePublisher->lastMessage->toArray());
|
||||||
|
$this->assertArrayHasKey('_CTXfrom', $messagePublisher->lastMessage->toArray());
|
||||||
|
}
|
||||||
|
}
|
25
tests/Monolog/Handler/GelfMocks.php
Normal file
25
tests/Monolog/Handler/GelfMocks.php
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Monolog package.
|
||||||
|
*
|
||||||
|
* (c) Jordi Boggiano <j.boggiano@seld.be>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Monolog\Handler;
|
||||||
|
|
||||||
|
use Gelf\MessagePublisher;
|
||||||
|
use Gelf\Message;
|
||||||
|
|
||||||
|
class MockMessagePublisher extends MessagePublisher
|
||||||
|
{
|
||||||
|
public function publish(Message $message)
|
||||||
|
{
|
||||||
|
$this->lastMessage = $message;
|
||||||
|
}
|
||||||
|
|
||||||
|
public $lastMessage = null;
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user