Skip to content

Adding a description for the use_microseconds parameter introduced in MonologBundle v2.11 #6583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Adding a description for the use_microseconds parameter introduced in MonologBundle v2.11 #6583

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9611df
Adding a description for the use_microseconds parameter introduced in…
jorgelbg May 21, 2016
b8bfa9c
Fixing some issues and adding a better explanation of the use_microse…
jorgelbg May 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions cookbook/logging/monolog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,60 @@ The ``logger`` service has different methods for different logging levels.
See :class:`Symfony\\Component\\HttpKernel\\Log\\LoggerInterface` for details
on which methods are available.

Since version `2.11 of MonologBundle <https://github.com/symfony/monolog-bundle/releases/tag/2.11.0>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need a link here. Instead, I would use .. versionadded:::

.. versionadded:: 2.11
    The `use_microseconds` option was introduced in MonologBundle 2.11.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes more sense this way!

an extra parameter for disabling the microsecond precision is available. This is
kind of a micro optimization but could speed up log generation, specially if you log
a lot of debug messages.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we maybe add a little explanation about what it is disabling and in which cases it should be enabled?


.. configuration-block::

.. code-block:: yaml

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

.. code-block:: xml

<!-- app/config/config.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"
xmlns:monolog="http://symfony.com/schema/dic/monolog"
xsi:schemaLocation="http://symfony.com/schema/dic/services
http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/monolog
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
$container->loadFromExtension('monolog', array(
'use_microseconds' => false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing comma after false

'handlers' => array(
'applog' => array(
'type' => 'stream',
'path' => '/var/log/symfony.log',
'level' => 'error',
),
),
));

Handlers and Channels: Writing Logs to different Locations
----------------------------------------------------------

Expand Down