1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Monolog\Formatter;
use Monolog\Formatter\FormatterInterface;
use Monolog\LogRecord;
/**
* Formats a log message into a line of text using our custom Piwik log format.
*/
class LineMessageFormatter implements FormatterInterface
{
/**
* The log message format string that turns a tag name, date-time and message into
* one string to log.
*
* @var string
*/
private $logMessageFormat;
private $allowInlineLineBreaks;
/**
* @param string $logMessageFormat
* @param bool $allowInlineLineBreaks If disabled, a log message will be created for each line
*/
public function __construct($logMessageFormat, $allowInlineLineBreaks = true)
{
$this->logMessageFormat = $logMessageFormat;
$this->allowInlineLineBreaks = $allowInlineLineBreaks;
}
public function format(LogRecord $record)
{
$class = isset($record->extra['class']) ? $record->extra['class'] : '';
$date = $record->datetime->format('Y-m-d H:i:s T');
$message = trim($record->message);
if ($this->allowInlineLineBreaks) {
$message = str_replace("\n", "\n ", $message); // intend lines
$messages = array($message);
} else {
$messages = explode("\n", $message);
}
$total = '';
foreach ($messages as $message) {
// escape control characters
$message = addcslashes($message, "\x00..\x09\x0B..\x1F\x7F");
$message = $this->prefixMessageWithRequestId($record, $message);
$total .= $this->formatMessage($class, $message, $date, $record);
}
return $total;
}
private function formatMessage($class, $message, $date, LogRecord $record)
{
$trace = isset($record->context['trace']) ? self::formatTrace($record->context['trace']) : '';
$message = str_replace(
array('%tag%', '%message%', '%datetime%', '%level%', '%trace%'),
array($class, $message, $date, $record->level->getName(), $trace),
$this->logMessageFormat
);
$message = trim($message) . "\n";
return $message;
}
private static function formatTrace(array $trace, $numLevels = 10)
{
$strTrace = '';
for ($i = 0; $i < $numLevels; $i++) {
if (!isset($trace[$i])) {
continue;
}
$level = $trace[$i];
$levelTrace = '';
if (isset($level['file'], $level['line'])) {
$levelTrace = '#' . $i . (str_replace(PIWIK_DOCUMENT_ROOT, '', $level['file'])) . '(' . $level['line'] . ')';
} elseif (isset($level['class'], $level['type'], $level['function'])) {
$levelTrace = '[internal function]: ' . $level['class'] . $level['type'] . $level['function'] . '()';
}
if ($levelTrace) {
$strTrace .= $levelTrace . ",";
}
}
return trim($strTrace, ",");
}
public function formatBatch(array $records)
{
foreach ($records as $key => $record) {
$records[$key] = $this->format($record);
}
return $records;
}
private function prefixMessageWithRequestId(LogRecord $record, $message)
{
$requestId = isset($record->extra['request_id']) ? $record->extra['request_id'] : '';
$message = trim($message);
if ($requestId) {
$message = '[' . $requestId . '] ' . $message;
}
return $message;
}
}
|
