Skip to content

Commit df1b10d

Browse files
authored
[MonologBridge] Add documentation on new processors
1 parent 4eefc0b commit df1b10d

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

logging/processors.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,14 @@ handler level or at the channel level instead of registering it globally
168168
processors implementing :class:`Symfony\\Bridge\\Monolog\\Processor\\ProcessorInterface`
169169
are automatically registered as services and tagged with ``monolog.processor``,
170170
so you can use them without adding any configuration. The same applies to the
171-
built-in :class:`Symfony\\Bridge\\Monolog\\Processor\\TokenProcessor` and
172-
:class:`Symfony\\Bridge\\Monolog\\Processor\\WebProcessor` processors, which
173-
can be enabled as follows:
171+
built-in processors:
172+
173+
* :class:`Symfony\\Bridge\\Monolog\\Processor\\TokenProcessor`
174+
* :class:`Symfony\\Bridge\\Monolog\\Processor\\WebProcessor`
175+
* :class:`Symfony\\Bridge\\Monolog\\Processor\\RouteProcessor`
176+
* :class:`Symfony\\Bridge\\Monolog\\Processor\\ConsoleCommandProcessor`
177+
178+
They can be enabled as follows:
174179

175180
.. configuration-block::
176181

@@ -182,6 +187,10 @@ handler level or at the channel level instead of registering it globally
182187
Symfony\Bridge\Monolog\Processor\TokenProcessor: ~
183188
# Adds the real client IP to log entries
184189
Symfony\Bridge\Monolog\Processor\WebProcessor: ~
190+
# Adds controller::action, route name and parameters
191+
Symfony\Bridge\Monolog\Processor\RouteProcessor: ~
192+
# Adds command name and arguments
193+
Symfony\Bridge\Monolog\Processor\ConsoleCommandProcessor: ~
185194
186195
.. code-block:: xml
187196
@@ -197,6 +206,10 @@ handler level or at the channel level instead of registering it globally
197206
<service id="Symfony\Bridge\Monolog\Processor\TokenProcessor" />
198207
<!-- Adds the real client IP to log entries -->
199208
<service id="Symfony\Bridge\Monolog\Processor\WebProcessor" />
209+
<!-- Adds controller::action, route name and parameters -->
210+
<service id="Symfony\Bridge\Monolog\Processor\RouteProcessor" />
211+
<!-- Adds command name and arguments -->
212+
<service id="Symfony\Bridge\Monolog\Processor\ConsoleCommandProcessor" />
200213
</services>
201214
</container>
202215
@@ -205,11 +218,17 @@ handler level or at the channel level instead of registering it globally
205218
// config/services.php
206219
use Symfony\Bridge\Monolog\Processor\TokenProcessor;
207220
use Symfony\Bridge\Monolog\Processor\WebProcessor;
221+
use Symfony\Bridge\Monolog\Processor\RouteProcessor;
222+
use Symfony\Bridge\Monolog\Processor\ConsoleCommandProcessor;
208223
209224
// Adds the current security token to log entries
210225
$container->register(TokenProcessor::class);
211226
// Adds the real client IP to log entries
212227
$container->register(WebProcessor::class);
228+
// Adds controller::action, route name and parameters
229+
$container->register(RouteProcessor::class);
230+
// Adds command name and arguments
231+
$container->register(ConsoleCommandProcessor::class);
213232
214233
Registering Processors per Handler
215234
----------------------------------

0 commit comments

Comments
 (0)