GelfMessageFormatter.php 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. <?php
  2. /*
  3. * This file is part of the Monolog package.
  4. *
  5. * (c) Jordi Boggiano <j.boggiano@seld.be>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Monolog\Formatter;
  11. use Monolog\Logger;
  12. use Gelf\Message;
  13. /**
  14. * Serializes a log message to GELF
  15. * @see http://www.graylog2.org/about/gelf
  16. *
  17. * @author Matt Lehner <mlehner@gmail.com>
  18. */
  19. class GelfMessageFormatter extends NormalizerFormatter
  20. {
  21. const DEFAULT_MAX_LENGTH = 32766;
  22. /**
  23. * @var string the name of the system for the Gelf log message
  24. */
  25. protected $systemName;
  26. /**
  27. * @var string a prefix for 'extra' fields from the Monolog record (optional)
  28. */
  29. protected $extraPrefix;
  30. /**
  31. * @var string a prefix for 'context' fields from the Monolog record (optional)
  32. */
  33. protected $contextPrefix;
  34. /**
  35. * @var int max length per field
  36. */
  37. protected $maxLength;
  38. /**
  39. * Translates Monolog log levels to Graylog2 log priorities.
  40. */
  41. private $logLevels = array(
  42. Logger::DEBUG => 7,
  43. Logger::INFO => 6,
  44. Logger::NOTICE => 5,
  45. Logger::WARNING => 4,
  46. Logger::ERROR => 3,
  47. Logger::CRITICAL => 2,
  48. Logger::ALERT => 1,
  49. Logger::EMERGENCY => 0,
  50. );
  51. public function __construct($systemName = null, $extraPrefix = null, $contextPrefix = 'ctxt_', $maxLength = null)
  52. {
  53. parent::__construct('U.u');
  54. $this->systemName = $systemName ?: gethostname();
  55. $this->extraPrefix = $extraPrefix;
  56. $this->contextPrefix = $contextPrefix;
  57. $this->maxLength = is_null($maxLength) ? self::DEFAULT_MAX_LENGTH : $maxLength;
  58. }
  59. /**
  60. * {@inheritdoc}
  61. */
  62. public function format(array $record)
  63. {
  64. $record = parent::format($record);
  65. if (!isset($record['datetime'], $record['message'], $record['level'])) {
  66. throw new \InvalidArgumentException('The record should at least contain datetime, message and level keys, '.var_export($record, true).' given');
  67. }
  68. $message = new Message();
  69. $message
  70. ->setTimestamp($record['datetime'])
  71. ->setShortMessage((string) $record['message'])
  72. ->setHost($this->systemName)
  73. ->setLevel($this->logLevels[$record['level']]);
  74. // message length + system name length + 200 for padding / metadata
  75. $len = 200 + strlen((string) $record['message']) + strlen($this->systemName);
  76. if ($len > $this->maxLength) {
  77. $message->setShortMessage(substr($record['message'], 0, $this->maxLength));
  78. }
  79. if (isset($record['channel'])) {
  80. $message->setFacility($record['channel']);
  81. }
  82. if (isset($record['extra']['line'])) {
  83. $message->setLine($record['extra']['line']);
  84. unset($record['extra']['line']);
  85. }
  86. if (isset($record['extra']['file'])) {
  87. $message->setFile($record['extra']['file']);
  88. unset($record['extra']['file']);
  89. }
  90. foreach ($record['extra'] as $key => $val) {
  91. $val = is_scalar($val) || null === $val ? $val : $this->toJson($val);
  92. $len = strlen($this->extraPrefix . $key . $val);
  93. if ($len > $this->maxLength) {
  94. $message->setAdditional($this->extraPrefix . $key, substr($val, 0, $this->maxLength));
  95. break;
  96. }
  97. $message->setAdditional($this->extraPrefix . $key, $val);
  98. }
  99. foreach ($record['context'] as $key => $val) {
  100. $val = is_scalar($val) || null === $val ? $val : $this->toJson($val);
  101. $len = strlen($this->contextPrefix . $key . $val);
  102. if ($len > $this->maxLength) {
  103. $message->setAdditional($this->contextPrefix . $key, substr($val, 0, $this->maxLength));
  104. break;
  105. }
  106. $message->setAdditional($this->contextPrefix . $key, $val);
  107. }
  108. if (null === $message->getFile() && isset($record['context']['exception']['file'])) {
  109. if (preg_match("/^(.+):([0-9]+)$/", $record['context']['exception']['file'], $matches)) {
  110. $message->setFile($matches[1]);
  111. $message->setLine($matches[2]);
  112. }
  113. }
  114. return $message;
  115. }
  116. }