mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-04 20:27:31 +02:00
Code Issues Releases Wiki Activity

Merge pull request #1057 from CarsonF/logstash-context-prefix

Browse Source 
Change LogstashFormatter prefix properties to keys
This commit is contained in:
Jordi Boggiano
2018-06-18 11:03:19 +02:00
committed by GitHub
parent ce0a2b954b a21b037a00
commit 90d343e6a6
2 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/Monolog/Formatter/LogstashFormatter.php
View File

@@ -32,30 +32,30 @@ class LogstashFormatter extends NormalizerFormatter
protected $applicationName; protected $applicationName;
/** /**
* @var string a prefix for 'extra' fields from the Monolog record (optional) * @var string the key for 'extra' fields from the Monolog record
*/ */
protected $extraPrefix; protected $extraKey;
/** /**
* @var string a prefix for 'context' fields from the Monolog record (optional) * @var string the key for 'context' fields from the Monolog record
*/ */
protected $contextPrefix; protected $contextKey;
/** /**
* @param string $applicationName the application that sends the data, used as the "type" field of logstash * @param string $applicationName the application that sends the data, used as the "type" field of logstash
* @param string $systemName the system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine * @param string $systemName the system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine
* @param string $extraPrefix prefix for extra keys inside logstash "fields" * @param string $extraKey the key for extra keys inside logstash "fields", defaults to extra
* @param string $contextPrefix prefix for context keys inside logstash "fields", defaults to ctxt_ * @param string $contextKey the key for context keys inside logstash "fields", defaults to context
*/ */
public function __construct(string $applicationName, string $systemName = null, string $extraPrefix = null, string $contextPrefix = 'ctxt_') public function __construct(string $applicationName, string $systemName = null, string $extraKey = 'extra', string $contextKey = 'context')
{ {
// logstash requires a ISO 8601 format date with optional millisecond precision. // logstash requires a ISO 8601 format date with optional millisecond precision.
parent::__construct('Y-m-d\TH:i:s.uP'); parent::__construct('Y-m-d\TH:i:s.uP');
$this->systemName = $systemName ?: gethostname(); $this->systemName = $systemName ?: gethostname();
$this->applicationName = $applicationName; $this->applicationName = $applicationName;
$this->extraPrefix = $extraPrefix; $this->extraKey = $extraKey;
$this->contextPrefix = $contextPrefix; $this->contextKey = $contextKey;
} }
/** /**
@@ -90,10 +90,10 @@ class LogstashFormatter extends NormalizerFormatter
$message['type'] = $this->applicationName; $message['type'] = $this->applicationName;
} }
if (!empty($record['extra'])) { if (!empty($record['extra'])) {
$message[$this->extraPrefix.'extra'] = $record['extra']; $message[$this->extraKey] = $record['extra'];
} }
if (!empty($record['context'])) { if (!empty($record['context'])) {
$message[$this->contextPrefix.'context'] = $record['context']; $message[$this->contextKey] = $record['context'];
} }
return $this->toJson($message) . "\n"; return $this->toJson($message) . "\n";

34
tests/Monolog/Formatter/LogstashFormatterTest.php
View File

@@ -27,7 +27,7 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
*/ */
public function testDefaultFormatterV1() public function testDefaultFormatterV1()
{ {
$formatter = new LogstashFormatter('test', 'hostname', null, 'ctxt_'); $formatter = new LogstashFormatter('test', 'hostname');
$record = [ $record = [
'level' => Logger::ERROR, 'level' => Logger::ERROR,
'level_name' => 'ERROR', 'level_name' => 'ERROR',
@@ -49,7 +49,7 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
$this->assertEquals('test', $message['type']); $this->assertEquals('test', $message['type']);
$this->assertEquals('hostname', $message['host']); $this->assertEquals('hostname', $message['host']);
$formatter = new LogstashFormatter('mysystem', null, null, 'ctxt_'); $formatter = new LogstashFormatter('mysystem');
$message = json_decode($formatter->format($record), true); $message = json_decode($formatter->format($record), true);
@@ -61,7 +61,7 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
*/ */
public function testFormatWithFileAndLineV1() public function testFormatWithFileAndLineV1()
{ {
$formatter = new LogstashFormatter('test', null, null, 'ctxt_'); $formatter = new LogstashFormatter('test');
$record = [ $record = [
'level' => Logger::ERROR, 'level' => Logger::ERROR,
'level_name' => 'ERROR', 'level_name' => 'ERROR',
@@ -83,7 +83,7 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
*/ */
public function testFormatWithContextV1() public function testFormatWithContextV1()
{ {
$formatter = new LogstashFormatter('test', null, null, 'ctxt_'); $formatter = new LogstashFormatter('test');
$record = [ $record = [
'level' => Logger::ERROR, 'level' => Logger::ERROR,
'level_name' => 'ERROR', 'level_name' => 'ERROR',
@@ -96,17 +96,17 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
$message = json_decode($formatter->format($record), true); $message = json_decode($formatter->format($record), true);
$this->assertArrayHasKey('ctxt_context', $message); $this->assertArrayHasKey('context', $message);
$this->assertArrayHasKey('from', $message['ctxt_context']); $this->assertArrayHasKey('from', $message['context']);
$this->assertEquals('logger', $message['ctxt_context']['from']); $this->assertEquals('logger', $message['context']['from']);
// Test with extraPrefix // Test with extraPrefix
$formatter = new LogstashFormatter('test', null, null, 'CTX'); $formatter = new LogstashFormatter('test', null, 'extra', 'CTX');
$message = json_decode($formatter->format($record), true); $message = json_decode($formatter->format($record), true);
$this->assertArrayHasKey('CTXcontext', $message); $this->assertArrayHasKey('CTX', $message);
$this->assertArrayHasKey('from', $message['CTXcontext']); $this->assertArrayHasKey('from', $message['CTX']);
$this->assertEquals('logger', $message['CTXcontext']['from']); $this->assertEquals('logger', $message['CTX']['from']);
} }
/** /**
@@ -114,7 +114,7 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
*/ */
public function testFormatWithExtraV1() public function testFormatWithExtraV1()
{ {
$formatter = new LogstashFormatter('test', null, null, 'ctxt_'); $formatter = new LogstashFormatter('test');
$record = [ $record = [
'level' => Logger::ERROR, 'level' => Logger::ERROR,
'level_name' => 'ERROR', 'level_name' => 'ERROR',
@@ -132,17 +132,17 @@ class LogstashFormatterTest extends \PHPUnit\Framework\TestCase
$this->assertEquals('pair', $message['extra']['key']); $this->assertEquals('pair', $message['extra']['key']);
// Test with extraPrefix // Test with extraPrefix
$formatter = new LogstashFormatter('test', null, 'EXT', 'ctxt_'); $formatter = new LogstashFormatter('test', null, 'EXTRA');
$message = json_decode($formatter->format($record), true); $message = json_decode($formatter->format($record), true);
$this->assertArrayHasKey('EXTextra', $message); $this->assertArrayHasKey('EXTRA', $message);
$this->assertArrayHasKey('key', $message['EXTextra']); $this->assertArrayHasKey('key', $message['EXTRA']);
$this->assertEquals('pair', $message['EXTextra']['key']); $this->assertEquals('pair', $message['EXTRA']['key']);
} }
public function testFormatWithApplicationNameV1() public function testFormatWithApplicationNameV1()
{ {
$formatter = new LogstashFormatter('app', 'test', null, 'ctxt_'); $formatter = new LogstashFormatter('app', 'test');
$record = [ $record = [
'level' => Logger::ERROR, 'level' => Logger::ERROR,
'level_name' => 'ERROR', 'level_name' => 'ERROR',