Skip to content

Commit 0eb334d

Browse files
committed
Merge branch '4.4'
* 4.4: [Logger] [Processor] additional info on processor
2 parents d08f681 + 6a2d5cd commit 0eb334d

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

logging/processors.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
How to Add extra Data to Log Messages via a Processor
22
=====================================================
33

4-
Monolog allows you to process the record before logging it to add some
5-
extra data. A processor can be applied for the whole handler stack or
6-
only for a specific handler.
4+
`Monolog`_ allows you to process every record before logging it by adding some
5+
extra data. This is the role of a processor, which can be applied for the whole
6+
handler stack or only for a specific handler or channel.
77

88
A processor is a callable receiving the record as its first argument.
99
Processors are configured using the ``monolog.processor`` DIC tag. See the
@@ -30,6 +30,7 @@ using a processor::
3030
$this->session = $session;
3131
}
3232

33+
// this method is called for each log record; optimize it to not hurt performance
3334
public function __invoke(array $record)
3435
{
3536
if (!$this->session->isStarted()) {
@@ -179,6 +180,11 @@ Symfony's MonologBridge provides processors that can be registered inside your a
179180
:class:`Symfony\\Bridge\\Monolog\\Processor\\ConsoleCommandProcessor`
180181
Adds information about current console command.
181182

183+
.. seealso::
184+
185+
Check out the `built-in Monolog processors`_ to learn more about how to
186+
create these processors.
187+
182188
Registering Processors per Handler
183189
----------------------------------
184190

@@ -266,3 +272,6 @@ the ``monolog.processor`` tag:
266272
$container
267273
->register(SessionRequestProcessor::class)
268274
->addTag('monolog.processor', ['channel' => 'main']);
275+
276+
.. _`Monolog`: https://github.com/Seldaek/monolog
277+
.. _`built-in Monolog processors`: https://github.com/Seldaek/monolog/tree/master/src/Monolog/Processor

0 commit comments

Comments
 (0)