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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Logger;
use MediaWiki\Logger\Monolog\BufferHandler;
use Monolog\Logger;
use ObjectFactory;
/**
* LoggerFactory service provider that creates loggers implemented by
* Monolog.
*
* Configured using an array of configuration data with the keys 'loggers',
* 'processors', 'handlers' and 'formatters'.
*
* The ['loggers']['\@default'] configuration will be used to create loggers
* for any channel that isn't explicitly named in the 'loggers' configuration
* section.
*
* Configuration will most typically be provided in the $wgMWLoggerDefaultSpi
* global configuration variable used by LoggerFactory to construct its
* default SPI provider:
* @code
* $wgMWLoggerDefaultSpi = array(
* 'class' => '\\MediaWiki\\Logger\\MonologSpi',
* 'args' => array( array(
* 'loggers' => array(
* '@default' => array(
* 'processors' => array( 'wiki', 'psr', 'pid', 'uid', 'web' ),
* 'handlers' => array( 'stream' ),
* ),
* 'runJobs' => array(
* 'processors' => array( 'wiki', 'psr', 'pid' ),
* 'handlers' => array( 'stream' ),
* )
* ),
* 'processors' => array(
* 'wiki' => array(
* 'class' => '\\MediaWiki\\Logger\\Monolog\\WikiProcessor',
* ),
* 'psr' => array(
* 'class' => '\\Monolog\\Processor\\PsrLogMessageProcessor',
* ),
* 'pid' => array(
* 'class' => '\\Monolog\\Processor\\ProcessIdProcessor',
* ),
* 'uid' => array(
* 'class' => '\\Monolog\\Processor\\UidProcessor',
* ),
* 'web' => array(
* 'class' => '\\Monolog\\Processor\\WebProcessor',
* ),
* ),
* 'handlers' => array(
* 'stream' => array(
* 'class' => '\\Monolog\\Handler\\StreamHandler',
* 'args' => array( 'path/to/your.log' ),
* 'formatter' => 'line',
* ),
* 'redis' => array(
* 'class' => '\\Monolog\\Handler\\RedisHandler',
* 'args' => array( function() {
* $redis = new Redis();
* $redis->connect( '127.0.0.1', 6379 );
* return $redis;
* },
* 'logstash'
* ),
* 'formatter' => 'logstash',
* 'buffer' => true,
* ),
* 'udp2log' => array(
* 'class' => '\\MediaWiki\\Logger\\Monolog\\LegacyHandler',
* 'args' => array(
* 'udp://127.0.0.1:8420/mediawiki
* ),
* 'formatter' => 'line',
* ),
* ),
* 'formatters' => array(
* 'line' => array(
* 'class' => '\\Monolog\\Formatter\\LineFormatter',
* ),
* 'logstash' => array(
* 'class' => '\\Monolog\\Formatter\\LogstashFormatter',
* 'args' => array( 'mediawiki', php_uname( 'n' ), null, '', 1 ),
* ),
* ),
* ) ),
* );
* @endcode
*
* @see https://github.com/Seldaek/monolog
* @since 1.25
* @author Bryan Davis <bd808@wikimedia.org>
* @copyright © 2014 Bryan Davis and Wikimedia Foundation.
*/
class MonologSpi implements Spi {
/**
* @var array $singletons
*/
protected $singletons;
/**
* Configuration for creating new loggers.
* @var array $config
*/
protected $config;
/**
* @param array $config Configuration data.
*/
public function __construct( array $config ) {
$this->config = array();
$this->mergeConfig( $config );
}
/**
* Merge additional configuration data into the configuration.
*
* @since 1.26
* @param array $config Configuration data.
*/
public function mergeConfig( array $config ) {
foreach ( $config as $key => $value ) {
if ( isset( $this->config[$key] ) ) {
$this->config[$key] = array_merge( $this->config[$key], $value );
} else {
$this->config[$key] = $value;
}
}
$this->reset();
}
/**
* Reset internal caches.
*
* This is public for use in unit tests. Under normal operation there should
* be no need to flush the caches.
*/
public function reset() {
$this->singletons = array(
'loggers' => array(),
'handlers' => array(),
'formatters' => array(),
'processors' => array(),
);
}
/**
* Get a logger instance.
*
* Creates and caches a logger instance based on configuration found in the
* $wgMWLoggerMonologSpiConfig global. Subsequent request for the same channel
* name will return the cached instance.
*
* @param string $channel Logging channel
* @return \\Psr\\Log\\LoggerInterface Logger instance
*/
public function getLogger( $channel ) {
if ( !isset( $this->singletons['loggers'][$channel] ) ) {
// Fallback to using the '@default' configuration if an explict
// configuration for the requested channel isn't found.
$spec = isset( $this->config['loggers'][$channel] ) ?
$this->config['loggers'][$channel] :
$this->config['loggers']['@default'];
$monolog = $this->createLogger( $channel, $spec );
$this->singletons['loggers'][$channel] = $monolog;
}
return $this->singletons['loggers'][$channel];
}
/**
* Create a logger.
* @param string $channel Logger channel
* @param array $spec Configuration
* @return \\Monolog\\Logger
*/
protected function createLogger( $channel, $spec ) {
$obj = new Logger( $channel );
if ( isset( $spec['processors'] ) ) {
foreach ( $spec['processors'] as $processor ) {
$obj->pushProcessor( $this->getProcessor( $processor ) );
}
}
if ( isset( $spec['handlers'] ) ) {
foreach ( $spec['handlers'] as $handler ) {
$obj->pushHandler( $this->getHandler( $handler ) );
}
}
return $obj;
}
/**
* Create or return cached processor.
* @param string $name Processor name
* @return callable
*/
public function getProcessor( $name ) {
if ( !isset( $this->singletons['processors'][$name] ) ) {
$spec = $this->config['processors'][$name];
$processor = ObjectFactory::getObjectFromSpec( $spec );
$this->singletons['processors'][$name] = $processor;
}
return $this->singletons['processors'][$name];
}
/**
* Create or return cached handler.
* @param string $name Processor name
* @return \\Monolog\\Handler\\HandlerInterface
*/
public function getHandler( $name ) {
if ( !isset( $this->singletons['handlers'][$name] ) ) {
$spec = $this->config['handlers'][$name];
$handler = ObjectFactory::getObjectFromSpec( $spec );
if ( isset( $spec['formatter'] ) ) {
$handler->setFormatter(
$this->getFormatter( $spec['formatter'] )
);
}
if ( isset( $spec['buffer'] ) && $spec['buffer'] ) {
$handler = new BufferHandler( $handler );
}
$this->singletons['handlers'][$name] = $handler;
}
return $this->singletons['handlers'][$name];
}
/**
* Create or return cached formatter.
* @param string $name Formatter name
* @return \\Monolog\\Formatter\\FormatterInterface
*/
public function getFormatter( $name ) {
if ( !isset( $this->singletons['formatters'][$name] ) ) {
$spec = $this->config['formatters'][$name];
$formatter = ObjectFactory::getObjectFromSpec( $spec );
$this->singletons['formatters'][$name] = $formatter;
}
return $this->singletons['formatters'][$name];
}
}
|
