Nov 27, 2017 · Nov 16, 2017 · Nov 17, 2017 · Nov 26, 2017
diff --git a/logging.rst b/logging.rst
 Logging a Message
 -----------------

 To log a message, fetchthe``logger`` service from thecontainer in
 your controller::
 If the application usesthe:ref:`default services.yaml configuration <service-container-services-load-example>`,
 you can get the logger service injecting the ``LoggerInterface`` class::

    use Psr\Log\LoggerInterface;

    public functionindexAction(LoggerInterface $logger)
    public functionindex(LoggerInterface $logger)
    {
        // alternative way of getting the logger
        // $logger = $this->get('logger');

        $logger->info('I just got the logger');
        $logger->error('An error occurred');


        $logger->critical('I left the oven on!', array(
            // include extra "context" info in your logs
            'cause' => 'in_hurry',
        // ...
    }

 The``logger`` service has different methods for different logging levels/priorities.
 The logger service has different methods for different logging levels/priorities.
 You can configure the logger to do different things based on the *level* of a message
 (e.g. :doc:`send an email when an error occurs </logging/monolog_email>`).

 Where Logs are Stored
 ---------------------

 The configuration for *where* logs are stored lives in the specific
 :doc:`environment </configuration/environments>` configuration files: ``config_dev.yml``
 and ``config_prod.yml``.

 By default, log entries are written to the ``var/log/dev.log`` file when you're in
 the ``dev`` environment. In the ``prod`` environment, logs are written to ``var/log/prod.log``,
 but *only* during a request where an error or high-priority log entry was made
    channel can have its *own* handlers, which means you can store different log
    messages in different places. See :doc:`/logging/channels_handlers`.

 Symfony pre-configures some basic handlers in the``config_dev.yml`` and ``config_prod.yml``
 files. Check these out for some real-world examples.
 Symfony pre-configures some basic handlers in thedefault ``monolog.yaml``
 configfiles. Check these out for some real-world examples.

 This example uses *two* handlers: ``stream`` (to write to a file) and ``syslog``
 to write logs using the :phpfunction:`syslog` function:

    .. code-block:: yaml

        #app/config/config.yml
        # config/packages/monolog.yaml
        monolog:
            handlers:
                # this "file_log" key could be anything

    .. code-block:: xml

        <!--app/config/config.xml -->
        <!-- config/packages/monolog.xml -->
        <?xml version="1.0" encoding="UTF-8" ?>
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    .. code-block:: php

        //app/config/config.php
        // config/packages/monolog.php
        $container->loadFromExtension('monolog', array(
            'handlers' => array(
                'file_log' => array(

    .. code-block:: yaml

        #app/config/config.yml
        # config/packages/monolog.yaml
        monolog:
            handlers:
                filter_for_errors:

    .. code-block:: xml

        <!--app/config/config.xml -->
        <!-- config/packages/monolog.xml -->
        <?xml version="1.0" encoding="UTF-8" ?>
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    .. code-block:: php

        //app/config/config.php
        // config/packages/monolog.php
        $container->loadFromExtension('monolog', array(
            'handlers' => array(
                'filter_for_errors' => array(

    .. code-block:: yaml

        #app/config/config_dev.yml
        # config/packages/dev/monolog.yaml
        monolog:
            handlers:
                main:

    .. code-block:: xml

        <!--app/config/config_dev.xml -->
        <!-- config/packages/dev/monolog.xml -->
        <?xml version="1.0" encoding="UTF-8" ?>
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    .. code-block:: php

        //app/config/config_dev.php
        // config/packages/dev/monolog.php
        $container->loadFromExtension('monolog', array(
            'handlers' => array(
                'main' => array(
 Using a Logger inside a Service
 -------------------------------

 To use a logger in your own services, add the ``@logger`` service as an argument
 of those services. If you want to use a pre-configured logger which uses a
 If you want to use in your own services a pre-configured logger which uses a
 specific channel (``app`` by default), use the ``monolog.logger`` tag  with the
 ``channel`` property as explained in the
 :ref:`Dependency Injection reference <dic_tags-monolog>`.

 .. toctree::
    :maxdepth: 1
    :glob:

    logging/*
    logging/monolog_regex_based_excludes
    logging/monolog_email
    logging/channels_handlers
    logging/monolog_console
    logging/disable_microsecond_precision
    logging/formatter
    logging/processors

 .. _Monolog: https://github.com/Seldaek/monolog
 .. _LoggerInterface: https://github.com/php-fig/log/blob/master/Psr/Log/LoggerInterface.php
diff --git a/logging/channels_handlers.rst b/logging/channels_handlers.rst

 Now, suppose you want to log the ``security`` channel to a different file.
 To do this, just create a new handler and configure it to log only messages
 from the ``security`` channel. You might add this in ``config.yml`` to log
 in all environments, or just ``config_prod.yml`` to happen only in ``prod``:
 from the ``security`` channel:

 .. configuration-block::

    .. code-block:: yaml

        #app/config/config.yml
        # config/packages/monolog.yaml
        monolog:
            handlers:
                security:

    .. code-block:: xml

        <!--app/config/config.xml-->
        <!-- config/packages/monolog.xml-->
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns:monolog="http://symfony.com/schema/dic/monolog"

    .. code-block:: php

        //app/config/config.php
        // config/packages/monolog.php
        $container->loadFromExtension('monolog', array(
            'handlers' => array(
                'security' => array(

    .. code-block:: yaml

        #app/config/config.yml
        # config/packages/monolog.yaml
        monolog:
            channels: ['foo', 'bar']

    .. code-block:: xml

        <!--app/config/config.xml -->
        <!-- config/packages/monolog.xml -->
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns:monolog="http://symfony.com/schema/dic/monolog"

    .. code-block:: php

        //app/config/config.php
        // config/packages/monolog.php
        $container->loadFromExtension('monolog', array(
            'channels' => array(
                'foo',
diff --git a/logging/disable_microsecond_precision.rst b/logging/disable_microsecond_precision.rst

    .. code-block:: yaml

        #app/config/config.yml
        # config/packages/monolog.yaml
        monolog:
            use_microseconds: false
            handlers:
                applog:
                    type: stream
                    path: /var/log/symfony.log
                    level: error
            # ...

    .. code-block:: xml

        <!--app/config/config.xml -->
        <!-- config/packages/monolog.xml -->
        <?xml version="1.0" encoding="UTF-8" ?>
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

            <monolog:config use-microseconds="false">
                <monolog:handler
                    name="applog"
                    type="stream"
                    path="/var/log/symfony.log"
                    level="error"
                />
                <!-- ... -->
            </monolog:config>
        </container>

    .. code-block:: php

        //app/config/config.php
        // config/packages/monolog.php
        $container->loadFromExtension('monolog', array(
            'use_microseconds' => false,
            'handlers' => array(
                'applog' => array(
                    'type'  => 'stream',
                    'path'  => '/var/log/symfony.log',
                    'level' => 'error',
                ),
            ),
            // ...
        ));
diff --git a/logging/formatter.rst b/logging/formatter.rst

            Monolog\Formatter\JsonFormatter: ~

        #app/config/config_prod.yml (and/orconfig_dev.yml)
        # config/packages/prod/monolog.yaml (and/orconfig/packages/dev/monolog.yaml)
        monolog:
            handlers:
                file:
                <service id="Monolog\Formatter\JsonFormatter" />
            </services>

            <!--app/config/config_prod.xml (and/orconfig_dev.xml) -->
            <!-- config/packages/prod/monolog.xml (and/orconfig/packages/dev/monolog.xml) -->
            <monolog:config>
                <monolog:handler
                    name="file"

    .. code-block:: php

        //app/config/config.php
        // config/services.php
        use Monolog\Formatter\JsonFormatter;

        // config/services.php
        $container->register(JsonFormatter::class);

        //app/config/config_prod.php (orconfig_dev.php)
        // config/packages/prod/monolog.php (and/orconfig/packages/dev/monolog.php)
        $container->loadFromExtension('monolog', array(
            'handlers' => array(
                'file' => array(
diff --git a/logging/monolog_console.rst b/logging/monolog_console.rst

 The example above could then be rewritten as::

    use Psr\Log\LoggerInterface;
    use Symfony\Component\Console\Input\InputInterface;
    use Symfony\Component\Console\Output\OutputInterface;

    protected function execute(InputInterface $input, OutputInterface $output)
    private $logger;

    public function __constructor(LoggerInterface $logger)
    {
        // assuming the Command extends ContainerAwareCommand...
        $logger = $this->getContainer()->get('logger');
        $logger->debug('Some info');
        $this->logger = $logger;
    }

        $logger->notice('Some more info');
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->logger->debug('Some info');
        // ...
        $this->logger->notice('Some more info');
    }

 Depending on the verbosity level that the command is run in and the user's
 Additionally, error logs are written to the error output (php://stderr).
 There is no need to conditionally handle the verbosity settings anymore.

 The Monolog console handler is enabled by default in the Symfony Framework. For
 example, in ``config_dev.yml``:
 The Monolog console handler is enabled by default:

 .. configuration-block::

    .. code-block:: yaml

        #app/config/config_dev.yml
        # config/packages/dev/monolog.yaml
        monolog:
            handlers:
                # ...

    .. code-block:: xml

        <!--app/config/config.xml -->
        <!-- config/packages/dev/monolog.xml -->
        <?xml version="1.0" encoding="UTF-8" ?>
        <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    .. code-block:: php

        //app/config/config.php
        // config/packages/dev/monolog.php
        $container->loadFromExtension('monolog', array(
            'handlers' => array(
                'console' => array(
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,19 +7,16 @@ logs that can be stored in a variety of different places.
		Logging a Message
		-----------------

		To log a message, fetchthe``logger`` service from thecontainer in
		your controller::
		If the application usesthe:ref:`default services.yaml configuration <service-container-services-load-example>`,
		you can get the logger service injecting the ``LoggerInterface`` class::

		use Psr\Log\LoggerInterface;

		public functionindexAction(LoggerInterface $logger)
		public functionindex(LoggerInterface $logger)
		{
		// alternative way of getting the logger
		// $logger = $this->get('logger');

		$logger->info('I just got the logger');
		$logger->error('An error occurred');


		$logger->critical('I left the oven on!', array(
		// include extra "context" info in your logs
		'cause' => 'in_hurry',
Expand All		@@ -28,7 +25,7 @@ your controller::
		// ...
		}

		The``logger`` service has different methods for different logging levels/priorities.
		The logger service has different methods for different logging levels/priorities.
		You can configure the logger to do different things based on the level of a message
		(e.g. :doc:`send an email when an error occurs </logging/monolog_email>`).

Expand All		@@ -37,10 +34,6 @@ See LoggerInterface_ for a list of all of the methods on the logger.
		Where Logs are Stored
		---------------------

		The configuration for where logs are stored lives in the specific
		:doc:`environment </configuration/environments>` configuration files: ``config_dev.yml``
		and ``config_prod.yml``.

		By default, log entries are written to the ``var/log/dev.log`` file when you're in
		the ``dev`` environment. In the ``prod`` environment, logs are written to ``var/log/prod.log``,
		but only during a request where an error or high-priority log entry was made
Expand All		@@ -61,8 +54,8 @@ to different locations (e.g. files, database, Slack, etc).
		channel can have its own handlers, which means you can store different log
		messages in different places. See :doc:`/logging/channels_handlers`.

		Symfony pre-configures some basic handlers in the``config_dev.yml`` and ``config_prod.yml``
		files. Check these out for some real-world examples.
		Symfony pre-configures some basic handlers in thedefault ``monolog.yaml``
		configfiles. Check these out for some real-world examples.

		This example uses two handlers: ``stream`` (to write to a file) and ``syslog``
		to write logs using the :phpfunction:`syslog` function:
Expand All		@@ -71,7 +64,7 @@ to write logs using the :phpfunction:`syslog` function:

		.. code-block:: yaml

		#app/config/config.yml
		# config/packages/monolog.yaml
		monolog:
		handlers:
		# this "file_log" key could be anything
Expand All		@@ -89,7 +82,7 @@ to write logs using the :phpfunction:`syslog` function:

		.. code-block:: xml

		<!--app/config/config.xml -->
		<!-- config/packages/monolog.xml -->
		<?xml version="1.0" encoding="UTF-8" ?>
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Expand All		@@ -116,7 +109,7 @@ to write logs using the :phpfunction:`syslog` function:

		.. code-block:: php

		//app/config/config.php
		// config/packages/monolog.php
		$container->loadFromExtension('monolog', array(
		'handlers' => array(
		'file_log' => array(
Expand DownExpand Up		@@ -147,7 +140,7 @@ one of the messages reaches an ``action_level``. Take this example:

		.. code-block:: yaml

		#app/config/config.yml
		# config/packages/monolog.yaml
		monolog:
		handlers:
		filter_for_errors:
Expand All		@@ -168,7 +161,7 @@ one of the messages reaches an ``action_level``. Take this example:

		.. code-block:: xml

		<!--app/config/config.xml -->
		<!-- config/packages/monolog.xml -->
		<?xml version="1.0" encoding="UTF-8" ?>
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Expand DownExpand Up		@@ -201,7 +194,7 @@ one of the messages reaches an ``action_level``. Take this example:

		.. code-block:: php

		//app/config/config.php
		// config/packages/monolog.php
		$container->loadFromExtension('monolog', array(
		'handlers' => array(
		'filter_for_errors' => array(
Expand DownExpand Up		@@ -261,7 +254,7 @@ option of your handler to ``rotating_file``:

		.. code-block:: yaml

		#app/config/config_dev.yml
		# config/packages/dev/monolog.yaml
		monolog:
		handlers:
		main:
Expand All		@@ -274,7 +267,7 @@ option of your handler to ``rotating_file``:

		.. code-block:: xml

		<!--app/config/config_dev.xml -->
		<!-- config/packages/dev/monolog.xml -->
		<?xml version="1.0" encoding="UTF-8" ?>
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Expand All		@@ -298,7 +291,7 @@ option of your handler to ``rotating_file``:

		.. code-block:: php

		//app/config/config_dev.php
		// config/packages/dev/monolog.php
		$container->loadFromExtension('monolog', array(
		'handlers' => array(
		'main' => array(
Expand All		@@ -315,8 +308,7 @@ option of your handler to ``rotating_file``:
		Using a Logger inside a Service
		-------------------------------

		To use a logger in your own services, add the ``@logger`` service as an argument
		of those services. If you want to use a pre-configured logger which uses a
		If you want to use in your own services a pre-configured logger which uses a
		specific channel (``app`` by default), use the ``monolog.logger`` tag with the
		``channel`` property as explained in the
		:ref:`Dependency Injection reference <dic_tags-monolog>`.
Expand All		@@ -334,9 +326,14 @@ Learn more

		.. toctree::
		:maxdepth: 1
		:glob:

		logging/*
		logging/monolog_regex_based_excludes
		logging/monolog_email
		logging/channels_handlers
		logging/monolog_console
		logging/disable_microsecond_precision
		logging/formatter
		logging/processors

		.. _Monolog: https://github.com/Seldaek/monolog
		.. _LoggerInterface: https://github.com/php-fig/log/blob/master/Psr/Log/LoggerInterface.php
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,14 +25,13 @@ Switching a Channel to a different Handler

		Now, suppose you want to log the ``security`` channel to a different file.
		To do this, just create a new handler and configure it to log only messages
		from the ``security`` channel. You might add this in ``config.yml`` to log
		in all environments, or just ``config_prod.yml`` to happen only in ``prod``:
		from the ``security`` channel:

		.. configuration-block::

		.. code-block:: yaml

		#app/config/config.yml
		# config/packages/monolog.yaml
		monolog:
		handlers:
		security:
Expand All		@@ -49,7 +48,7 @@ in all environments, or just ``config_prod.yml`` to happen only in ``prod``:

		.. code-block:: xml

		<!--app/config/config.xml-->
		<!-- config/packages/monolog.xml-->
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xmlns:monolog="http://symfony.com/schema/dic/monolog"
Expand All		@@ -76,7 +75,7 @@ in all environments, or just ``config_prod.yml`` to happen only in ``prod``:

		.. code-block:: php

		//app/config/config.php
		// config/packages/monolog.php
		$container->loadFromExtension('monolog', array(
		'handlers' => array(
		'security' => array(
Expand DownExpand Up		@@ -138,13 +137,13 @@ You can also configure additional channels without the need to tag your services

		.. code-block:: yaml

		#app/config/config.yml
		# config/packages/monolog.yaml
		monolog:
		channels: ['foo', 'bar']

		.. code-block:: xml

		<!--app/config/config.xml -->
		<!-- config/packages/monolog.xml -->
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xmlns:monolog="http://symfony.com/schema/dic/monolog"
Expand All		@@ -161,7 +160,7 @@ You can also configure additional channels without the need to tag your services

		.. code-block:: php

		//app/config/config.php
		// config/packages/monolog.php
		$container->loadFromExtension('monolog', array(
		'channels' => array(
		'foo',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,18 +11,14 @@ log generation. This is recommended for systems that generate a large number of

		.. code-block:: yaml

		#app/config/config.yml
		# config/packages/monolog.yaml
		monolog:
		use_microseconds: false
		handlers:
		applog:
		type: stream
		path: /var/log/symfony.log
		level: error
		# ...

		.. code-block:: xml

		<!--app/config/config.xml -->
		<!-- config/packages/monolog.xml -->
		<?xml version="1.0" encoding="UTF-8" ?>
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Expand All		@@ -33,25 +29,14 @@ log generation. This is recommended for systems that generate a large number of
		http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

		<monolog:config use-microseconds="false">
		<monolog:handler
		name="applog"
		type="stream"
		path="/var/log/symfony.log"
		level="error"
		/>
		<!-- ... -->
		</monolog:config>
		</container>

		.. code-block:: php

		//app/config/config.php
		// config/packages/monolog.php
		$container->loadFromExtension('monolog', array(
		'use_microseconds' => false,
		'handlers' => array(
		'applog' => array(
		'type' => 'stream',
		'path' => '/var/log/symfony.log',
		'level' => 'error',
		),
		),
		// ...
		));
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,7 +20,7 @@ configure your handler to use it:

		Monolog\Formatter\JsonFormatter: ~

		#app/config/config_prod.yml (and/orconfig_dev.yml)
		# config/packages/prod/monolog.yaml (and/orconfig/packages/dev/monolog.yaml)
		monolog:
		handlers:
		file:
Expand All		@@ -44,7 +44,7 @@ configure your handler to use it:
		<service id="Monolog\Formatter\JsonFormatter" />
		</services>

		<!--app/config/config_prod.xml (and/orconfig_dev.xml) -->
		<!-- config/packages/prod/monolog.xml (and/orconfig/packages/dev/monolog.xml) -->
		<monolog:config>
		<monolog:handler
		name="file"
Expand All		@@ -57,13 +57,12 @@ configure your handler to use it:

		.. code-block:: php

		//app/config/config.php
		// config/services.php
		use Monolog\Formatter\JsonFormatter;

		// config/services.php
		$container->register(JsonFormatter::class);

		//app/config/config_prod.php (orconfig_dev.php)
		// config/packages/prod/monolog.php (and/orconfig/packages/dev/monolog.php)
		$container->loadFromExtension('monolog', array(
		'handlers' => array(
		'file' => array(
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,16 +35,22 @@ current log level and the console verbosity.

		The example above could then be rewritten as::

		use Psr\Log\LoggerInterface;
		use Symfony\Component\Console\Input\InputInterface;
		use Symfony\Component\Console\Output\OutputInterface;

		protected function execute(InputInterface $input, OutputInterface $output)
		private $logger;
Copy link Member wouterjNov 26, 2017 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. This is becoming quite unreadable. Can we please at the class definition (`class .... { }`) lines?

		public function __constructor(LoggerInterface $logger)
		{
		// assuming the Command extends ContainerAwareCommand...
		$logger = $this->getContainer()->get('logger');
		$logger->debug('Some info');
		$this->logger = $logger;
		}

		$logger->notice('Some more info');
		protected function execute(InputInterface $input, OutputInterface $output)
		{
		$this->logger->debug('Some info');
		// ...
		$this->logger->notice('Some more info');
		}

		Depending on the verbosity level that the command is run in and the user's
Expand All		@@ -53,14 +59,13 @@ the console. If they are displayed, they are timestamped and colored appropriate
		Additionally, error logs are written to the error output (php://stderr).
		There is no need to conditionally handle the verbosity settings anymore.

		The Monolog console handler is enabled by default in the Symfony Framework. For
		example, in ``config_dev.yml``:
		The Monolog console handler is enabled by default:

		.. configuration-block::

		.. code-block:: yaml

		#app/config/config_dev.yml
		# config/packages/dev/monolog.yaml
		monolog:
		handlers:
		# ...
Expand All		@@ -75,7 +80,7 @@ example, in ``config_dev.yml``:

		.. code-block:: xml

		<!--app/config/config.xml -->
		<!-- config/packages/dev/monolog.xml -->
		<?xml version="1.0" encoding="UTF-8" ?>
		<container xmlns="http://symfony.com/schema/dic/services"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Expand All		@@ -98,7 +103,7 @@ example, in ``config_dev.yml``:

		.. code-block:: php

		//app/config/config.php
		// config/packages/dev/monolog.php
		$container->loadFromExtension('monolog', array(
		'handlers' => array(
		'console' => array(
Expand Down