-
Notifications
You must be signed in to change notification settings - Fork 5
/
Logger.php
284 lines (220 loc) · 6.88 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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<?php
/**
* Lumber main logger class
*
* This class takes care of handling incoming log requests and properly dispatching them to
* registered Monolog channels. It is pretty much an adapter over multiple instances of Monolog
*
* @copyright Copyright (c) 2010-2013 MV Labs (http://www.mvlabs.it)
* @link https://github.com/mvlabs/MvlabsLumber
* @license MIT - Please view the LICENSE file that was distributed with this source code
* @author Steve Maraspin <steve@mvlabs.it>
* @package MvlabsLumber
*/
namespace MvlabsLumber\Service;
use Monolog\Logger as Monolog;
use Psr\Log\LoggerInterface;
class Logger implements LoggerInterface {
const EMERGENCY = 'emergency';
const ALERT = 'alert';
const CRITICAL = 'critical';
const ERROR = 'error';
const WARNING = 'warning';
const NOTICE = 'notice';
const INFO = 'info';
const DEBUG = 'debug';
/**
* Messages are sent to these channels
*
* @var array $aI_channels logger channels
*/
private $aI_channels = array();
/**
* Maps between Lumber and Monolog levels
*
* @var array Monolog logging levels
*/
public static $as_monologLevels = array(
self::DEBUG => \Monolog\Logger::DEBUG,
self::INFO => \Monolog\Logger::INFO,
self::NOTICE => \Monolog\Logger::NOTICE,
self::WARNING => \Monolog\Logger::WARNING,
self::ERROR => \Monolog\Logger::ERROR,
self::CRITICAL => \Monolog\Logger::CRITICAL,
self::ALERT => \Monolog\Logger::ALERT,
self::EMERGENCY => \Monolog\Logger::EMERGENCY,
);
/**
* Lists available logging severity levels
*
* @return array
*/
public static function getSeverityLevels() {
// @TODO: needs to be replaced if new constants are introduced within the class
$I_ref = new \ReflectionClass(__CLASS__);
$am_levels = $I_ref->getConstants();
return $am_levels;
}
/**
* Tells whether level param is valid
*
* @param mixed $m_level Level to be evaluated
* @return boolean Is level valid?
*/
public static function isValidSeverityLevel($m_level) {
// If an invalid operator is specified, an Exception is thrown
if (in_array($m_level,self::getSeverityLevels())) {
return true;
}
return false;
}
/**
* Adds a channel to current list of registered channels
*
* @param string $s_channelName Channel name
* @param Monolog\Logger $I_channel Monolog Logger instance
*/
public function addChannel($s_channelName, Monolog $I_channel) {
$this->aI_channels[$s_channelName] = $I_channel;
}
/**
* Lists currently registered channels
*
* @return array currently registered channels (Monolog instances)
*/
public function getChannels() {
return $this->aI_channels;
}
/**
* Gets a spcific channel
*
* @param string $s_channelName Channel name
*/
public function getChannel($s_channelName) {
if (!array_key_exists($s_channelName, $this->aI_channels)) {
throw new \UnexpectedValueException('Channel ' . $s_channelName . ' does not exist');
}
return $this->aI_channels[$s_channelName];
}
/**
* Removes a channel from list of registered ones
*
* @param string $s_channelName Channel name
*/
public function removeChannel($s_channelName) {
if (!array_key_exists($s_channelName, $this->aI_channels)) {
throw new \UnexpectedValueException('Channel ' . $s_channelName . ' does not exist. Cannot remove it');
}
unset($this->aI_channels[$s_channelName]);
}
/**
* Logs with severity level to all registered channels
*
* @param string $s_message Main message content
* @param mixed $s_level Message severity level. Default is null, which will result in info, as commonly found in logger implementations
* @param array $am_context Message context - IE Additional information
* @return null
*/
public function log($s_message, $s_level = 'notice', array $am_context = array()) {
if (!$this->isValidSeverityLevel($s_level)) {
throw new \OutOfRangeException('Severity level ' . $s_level . ' is invalid and can not be used');
}
foreach ($this->aI_channels as $s_channelName => $I_channel) {
$I_channel->addRecord(self::$as_monologLevels[$s_level], $s_message, $am_context);
}
}
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $s_message Main message content
* @param array $am_context Message context - IE Additional info
* @return null
*/
public function emergency($s_message, array $am_context = array()) {
$this->log($s_message, self::EMERGENCY, $am_context);
}
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
* @param array $context
* @return null
*/
public function alert($s_message, array $am_context = array()) {
$this->log($s_message, self::ALERT, $am_context);
}
/**
* Critical conditions.
*
* Example: Application component unavailable, unexpected exception.
*
* @param string $message
* @param array $context
* @return null
*/
public function critical($s_message, array $am_context = array()) {
$this->log($s_message, self::CRITICAL, $am_context);
}
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param array $context
* @return null
*/
public function error($s_message, array $am_context = array()) {
$this->log($s_message, self::ERROR, $am_context);
}
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
* @param array $context
* @return null
*/
public function warning($s_message, array $am_context = array()) {
$this->log($s_message, self::WARNING, $am_context);
}
/**
* Normal but significant events.
*
* @param string $message
* @param array $context
* @return null
*/
public function notice($s_message, array $am_context = array()) {
$this->log($s_message, self::NOTICE, $am_context);
}
/**
* Interesting events.
*
* Example: User logs in, SQL logs.
*
* @param string $message
* @param array $context
* @return null
*/
public function info($s_message, array $am_context = array()) {
$this->log($s_message, self::INFO, $am_context);
}
/**
* Detailed debug information.
*
* @param string $message
* @param array $context
* @return null
*/
public function debug($s_message, array $am_context = array()) {
$this->log($s_message, self::DEBUG, $am_context);
}
}