-
Notifications
You must be signed in to change notification settings - Fork 85
/
Logger.php
256 lines (226 loc) · 6.53 KB
/
Logger.php
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<?php
/*
* This file is part of the php-gelf package.
*
* (c) Benjamin Zikarsky <http://benjamin-zikarsky.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Gelf;
use Gelf\Transport\UdpTransport;
use Psr\Log\LoggerInterface;
use Psr\Log\AbstractLogger;
use Exception;
/**
* A basic PSR-3 compliant logger
*
* @author Benjamin Zikarsky <benjamin@zikarsky.de>
*/
class Logger extends AbstractLogger implements LoggerInterface
{
/**
* @var string|null
*/
protected $facility;
/**
* @var array
*/
protected $defaultContext;
/**
* @var PublisherInterface
*/
protected $publisher;
/**
* Creates a PSR-3 Logger for GELF/Graylog2
*
* @param PublisherInterface|null $publisher
* @param string|null $facility
* @param array $defaultContext
*/
public function __construct(
PublisherInterface $publisher = null,
$facility = null,
array $defaultContext = array()
) {
// if no publisher is provided build a "default" publisher
// which is logging via Gelf over UDP to localhost on the default port
$this->publisher = $publisher ?: new Publisher(new UdpTransport());
$this->setFacility($facility);
$this->setDefaultContext($defaultContext);
}
/**
* Publishes a given message and context with given level
*
* @param mixed $level
* @param mixed $rawMessage
* @param array $context
*/
public function log($level, $rawMessage, array $context = array())
{
$message = $this->initMessage($level, $rawMessage, $context);
// add exception data if present
if (isset($context['exception'])
&& $context['exception'] instanceof Exception
) {
$this->initExceptionData($message, $context['exception']);
}
$this->publisher->publish($message);
}
/**
* Returns the currently used publisher
*
* @return PublisherInterface
*/
public function getPublisher()
{
return $this->publisher;
}
/**
* Sets a new publisher
*
* @param PublisherInterface $publisher
*/
public function setPublisher(PublisherInterface $publisher)
{
$this->publisher = $publisher;
}
/**
* Returns the faciilty-name used in GELF
*
* @return string|null
*/
public function getFacility()
{
return $this->facility;
}
/**
* Sets the facility for GELF messages
*
* @param string|null $facility
*/
public function setFacility($facility = null)
{
$this->facility = $facility;
}
/**
* @return array
*/
public function getDefaultContext()
{
return $this->defaultContext;
}
/**
* @param array $defaultContext
*/
public function setDefaultContext($defaultContext)
{
$this->defaultContext = $defaultContext;
}
/**
* Initializes message-object
*
* @param mixed $level
* @param mixed $message
* @param array $context
* @return Message
*/
protected function initMessage($level, $message, array $context)
{
// assert that message is a string, and interpolate placeholders
$message = (string) $message;
$context = $this->initContext($context);
$message = self::interpolate($message, $context);
// create message object
$messageObj = new Message();
$messageObj->setLevel($level);
$messageObj->setShortMessage($message);
$messageObj->setFacility($this->facility);
foreach ($this->getDefaultContext() as $key => $value) {
$messageObj->setAdditional($key, $value);
}
foreach ($context as $key => $value) {
$messageObj->setAdditional($key, $value);
}
return $messageObj;
}
/**
* Initializes context array, ensuring all values are string-safe
*
* @param array $context
* @return array
*/
protected function initContext($context)
{
foreach ($context as $key => &$value) {
switch (gettype($value)) {
case 'string':
case 'integer':
case 'double':
// These types require no conversion
break;
case 'array':
case 'boolean':
$value = json_encode($value);
break;
case 'object':
if (method_exists($value, '__toString')) {
$value = (string)$value;
} else {
$value = '[object (' . get_class($value) . ')]';
}
break;
case 'NULL':
$value = 'NULL';
break;
default:
$value = '[' . gettype($value) . ']';
break;
}
}
return $context;
}
/**
* Initializes Exceptiondata with given message
*
* @param Message $message
* @param Exception $exception
*/
protected function initExceptionData(Message $message, Exception $exception)
{
$message->setLine($exception->getLine());
$message->setFile($exception->getFile());
$longText = "";
do {
$longText .= sprintf(
"%s: %s (%d)\n\n%s\n",
get_class($exception),
$exception->getMessage(),
$exception->getCode(),
$exception->getTraceAsString()
);
$exception = $exception->getPrevious();
} while ($exception && $longText .= "\n--\n\n");
$message->setFullMessage($longText);
}
/**
* Interpolates context values into the message placeholders.
*
* Reference implementation
* @link https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#12-message
*
* @param mixed $message
* @param array $context
* @return string
*/
private static function interpolate($message, array $context)
{
// build a replacement array with braces around the context keys
$replace = array();
foreach ($context as $key => $val) {
$replace['{' . $key . '}'] = $val;
}
// interpolate replacement values into the message and return
return strtr($message, $replace);
}
}