Refactor the logger to a PSR-3 compatible logger #6622

mnapoli · 2014-11-09T22:12:57Z

Current issues with the logger:

static methods + singleton
global config not overridable by environment (unless I missed how to do that): e.g. in CLI we might want to log to stdout but in HTTP API we don't want to log into the JSON response Change default logger level from WARNING to ERROR #6612
backends are hardcoded and can't be customized (e.g. logging to email, Slack, New Relic, Graylog…)
we can't specify different logging levels for each backend (e.g. log to email on errors only, log to file for anything above INFO)
we don't comply to standards which requires new contributors to learn Piwik logger's specificities, and which means the logger can't be changed because Piwik Core and plugins are coupled to it
we need to maintain our own logger when many other loggers exist, are maintained and have more features

Solutions:

refactor the logger to an object instance (instead of static methods), injectable with dependency injection
configure the logger with DI config, which should have a global config + specific config per environment
use Monolog for example, which comes with so many backend adapters
Monolog supports a huge list of backends
we should use a PSR-3 compatible logger so that we decouple from a specific implementation and its usage is more standard (i.e. simpler for contributors)
this point is covered above (i.e. reuse an existing library like Monolog)

The challenge would be to keep BC, so if we indeed switch to Monolog we would need to implement our own message formatters to support sprintf and also implement our own adapters for the DB logging probably.

I'm not saying we should do it today, but at least the discussion can be opened.

Linked discussions, for reference: #110, #6209, #6612

The text was updated successfully, but these errors were encountered:

tsteur · 2014-11-10T00:40:57Z

👍 for using monolog but still keep the API (as mentioned convert to an object instance etc) and not breaking anything

Replacing our logger with monolog is on the second place on my "most wanted" todo list and I am looking forward to seeing it in Piwik

mattab · 2014-11-10T06:37:45Z

i'm very excited by possibilities of logging Tracker events to various backends in #6209 which kinda requires this new logger first so big 👍

tsteur · 2014-11-10T20:20:52Z

I can't wait to use the FingersCrossedHandler ;)

mattab · 2014-11-11T00:25:40Z

I can't wait to use the FingersCrossedHandler ;)

👍 this looks so useful!

…screen, database) out of the logger and into the LoggerFactory

…clarity

…sor" objects (to prepare the transition to Monolog)

…matters instead of events

…ease future transition

…olog naming

… StreamHandler

…ment

…tainerFactory This class can be used in tests to create a specific environment (e.g. the prod environment, CLI environment, etc...)

…Handler This is so the FileHandler can be replaced by Monolog's StreamHandler

…eamHandler We can't remove FileHandler completely because it generates a custom exception message in case of error.

…s disabled in tests

…ables now that we have a container

…a processor + added tests Monolog handlers support 1 formatter. Using processors instead of nested formatters leads to much simpler code.

In the tests, logging is disabled. But not when testing the logger itself…

… logging - the error handler logs warnings and notices, and turns errors into exceptions (`ErrorException`) - the exception handler catches all uncatched exceptions and display them to the user (HTML or CLI) - the "screen" logging backend has been removed - I've normalized exceptions/errors shown to the user in HTML (wether they are catched by the FrontController or not)

…L notifications The "screen" backend (WebNotificationHandler) now logs to HTML notification boxes using the `Notification` api. I've re-set the default log level to WARN, and logged PHP notices/warnings to "warning" so that on a default install they are shown in the page in a yellow/warning notification box. For the record, the default log level had previously been changed from WARN to ERROR because screen logging was previously messing the HTML/JSON output (which was breaking archiving). With the logger refactoring this is no longer a problem.

Cannot add tests for the screen backend because I would need to mock the session, which is not possible right now because it's all static stuff.

…ggerInterface

- log_only_when_cli - log_only_when_debug_parameter

Refactored the logger to use PSR-3 and Monolog (#6622)

mnapoli · 2014-12-19T04:55:20Z

The pull request was merged, what is left for me to do:

add new config files (in config/environment/) to the debian package: done in 2.10: new config files matomo-package#17
merge Logger refactoring in Piwik 2.10 PiwikPRO/plugin-SiteMigration#7
merge Added a documentation article for logging developer-documentation#51

mnapoli · 2014-12-21T22:06:41Z

\o/

mattab · 2014-12-21T22:31:38Z

Beautiful! :-)

mnapoli added the Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. label Nov 9, 2014

mnapoli mentioned this issue Nov 9, 2014

Change default logger level from WARNING to ERROR #6612

Closed

mnapoli added the c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. label Nov 9, 2014

mattab closed this as completed Nov 11, 2014

mattab reopened this Nov 11, 2014

mnapoli mentioned this issue Nov 12, 2014

Import INI config in DI config #6648

Merged

mnapoli self-assigned this Nov 28, 2014

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: use the container to get the log level

08ec362

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: small logger config refactoring

8eb5a8c

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: moved the file writer to a dedicated class

42fd548

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: moved the screen writer to a dedicated class

eff26ce

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: moved the database writer to a dedicated class

f2b4a20

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: moved log message formatting into classes

9fa6499

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: moved the log backend configuration (file, …

c2d2f60

…screen, database) out of the logger and into the LoggerFactory

mnapoli added a commit that referenced this issue Nov 28, 2014

#6622 Logger refactoring: moved log backends into a subnamespace for …

3563fe0

…clarity

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: moved "log message processing" into "Proces…

528d5dc

…sor" objects (to prepare the transition to Monolog)

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: quick code simplification

1d5aedc

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: formatting messages is now done through For…

65c96bb

…matters instead of events

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: simplified log formatters

a726a1f

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: removed now useless constants + updated phpdoc

598d56e

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: moved some configuration into the container

20e84e7

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: lazily create log writers

0f435ee

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: use a "record" array similar to Monolog to …

0794be0

…ease future transition

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: implement Monolog's FormatterInterface

e7474e6

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: use Monolog constants

8f82754

mnapoli added a commit that referenced this issue Dec 1, 2014

#6622 Logger refactoring: added Log\Processor\ClassNameProcessor

d263af9

mnapoli added a commit that referenced this issue Dec 5, 2014

#6622 Logger refactoring: config simplification

e0871a1

mnapoli mentioned this issue Dec 5, 2014

Refactored the logger to use PSR-3 and Monolog (#6622) #6813

Merged

11 tasks

mnapoli added a commit that referenced this issue Dec 8, 2014

#6622 Logger refactoring: added unit test

4edf7de

mnapoli added a commit that referenced this issue Dec 9, 2014

#6622 Logger refactoring: log as in CLI with PHP-CGI for the archiving

aad92e9

mnapoli added a commit that referenced this issue Dec 9, 2014

#6622 Logger refactoring: renamed "Backend" to "Handler" to match Mon…

3fd7de5

…olog naming

mnapoli added a commit that referenced this issue Dec 9, 2014

#6622 Logger refactoring: replaced Piwik StdOutHandler with Monolog's…

6bf0530

… StreamHandler

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: introduced a DI config for the test environ…

76a5fe0

…ment

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: moved the container creation into a new Con…

f6fd643

…tainerFactory This class can be used in tests to create a specific environment (e.g. the prod environment, CLI environment, etc...)

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: cleared up formatting that was left in File…

b78e44a

…Handler This is so the FileHandler can be replaced by Monolog's StreamHandler

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: Piwik FileHandler now extends Monolog's Str…

4e8164b

…eamHandler We can't remove FileHandler completely because it generates a custom exception message in case of error.

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: Simplified StdErrHandler now that logging i…

fe79f2b

…s disabled in tests

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: RequestIdProcessor doesn't need static vari…

43d8873

…ables now that we have a container

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: added tests

11adde7

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: Turned the Exception (text) formatter into …

598ce5b

…a processor + added tests Monolog handlers support 1 formatter. Using processors instead of nested formatters leads to much simpler code.

mnapoli added a commit that referenced this issue Dec 10, 2014

#6622 Logger refactoring: StdErrHandler: had to revert a previous change

af921f7

In the tests, logging is disabled. But not when testing the logger itself…

mnapoli mentioned this issue Dec 11, 2014

Environment and configs #6843

Closed

mnapoli added a commit that referenced this issue Dec 14, 2014

#6622 Logger refactoring: simplified LogTest

facc6af

Cannot add tests for the screen backend because I would need to mock the session, which is not possible right now because it's all static stuff.

mnapoli added a commit that referenced this issue Dec 15, 2014

#6622 Logger refactoring: deprecated Piwik\Log in favor of Psr\Log\Lo…

74b85e3

…ggerInterface

mnapoli added a commit that referenced this issue Dec 17, 2014

#6622 Logger refactoring: remove INI options:

bf5b7e6

- log_only_when_cli - log_only_when_debug_parameter

mnapoli added a commit that referenced this issue Dec 17, 2014

#6622 Logger refactoring: added a deprecation

6590128

mnapoli added a commit that referenced this issue Dec 18, 2014

#6622 Logger refactoring: updated the geoipUpdateRows.php script

bebef28

mattab pushed a commit that referenced this issue Dec 19, 2014

Merge pull request #6813 from piwik/log-refactoring-1

2a54b6d

Refactored the logger to use PSR-3 and Monolog (#6622)

mnapoli modified the milestones: Piwik 2.10.0 , Piwik 2.11.0 Dec 19, 2014

mnapoli closed this as completed Dec 21, 2014

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor the logger to a PSR-3 compatible logger #6622

Refactor the logger to a PSR-3 compatible logger #6622

mnapoli commented Nov 9, 2014

tsteur commented Nov 10, 2014

mattab commented Nov 10, 2014

tsteur commented Nov 10, 2014

mattab commented Nov 11, 2014

mnapoli commented Dec 19, 2014

mnapoli commented Dec 21, 2014

mattab commented Dec 21, 2014

Refactor the logger to a PSR-3 compatible logger #6622

Refactor the logger to a PSR-3 compatible logger #6622

Comments

mnapoli commented Nov 9, 2014

tsteur commented Nov 10, 2014

mattab commented Nov 10, 2014

tsteur commented Nov 10, 2014

mattab commented Nov 11, 2014

mnapoli commented Dec 19, 2014

mnapoli commented Dec 21, 2014

mattab commented Dec 21, 2014