Conditional logging #15965

MorrisJobke · 2015-04-30T10:51:35Z

Log condition for log level increase based on conditions. Once one of these conditions is met, the required log level is set to debug. This allows to debug specific requests, users or apps

Supported conditions (setting log_condition in config.php):
- secret: if a request parameter with the name log_secret is set to this value the condition is met
- users: if the current request is done by one of the specified users, this condition is met
- apps: if the log message is invoked by one of the specified apps, this condition is met

requires Use internally \OCP\ILogger instead of \OC\Log #15958 (which is included here to easiely test this)

This would be really helpful to debug bigger installations where enabling a higher log level isn't a option because of the huge amount of log messages. cc @felixboehm @butonic

cc @nickvergessen @PVince81 @rullzer @Xenopathic @Raydiation @DeepDiver1975

MorrisJobke · 2015-04-30T10:52:54Z

core commit here is 753c2db
cleanup and code deduplication is in here: 2dc650c?w=1

MorrisJobke · 2015-04-30T11:02:16Z

I used the internal \OC\SystemConfig here to not run into cyclic conditions here. As this is the logger I want to reduce the needed bootstrapped system to a minimum. Otherwise it could be possible to no able to log, because the injected object couldn't be build. The system config was also required previously. And as this is an internal class I think this is not a problem. Opinions?

felixboehm · 2015-04-30T11:02:21Z

Awesome stuff, logfiles often are so big and this really helps

karlitschek · 2015-04-30T12:12:17Z

nice idea 👍

DeepDiver1975 · 2015-05-04T07:16:14Z

rebased after merge of #15958

DeepDiver1975 · 2015-05-04T08:07:30Z

@MorrisJobke unit tests are broken

Test\Logger::testInterpolation
Failed asserting that two arrays are equal.
--- Expected
+++ Actual
@@ @@
 Array (
-    0 => '1 {Message {nothing} Bob Bar a}'
 )

/var/jenkins/workspace/pull-request-analyser-ng-simple@3/label/SLAVE/tests/lib/logger.php:32

MorrisJobke · 2015-05-04T09:56:55Z

I added a unit test for the app condition.

MorrisJobke · 2015-05-08T11:49:52Z

@LukasReschke @nickvergessen @rullzer @Xenopathic Do you want to review?

LukasReschke · 2015-05-08T11:55:25Z

"want"

LukasReschke · 2015-05-08T11:56:01Z

config/config.sample.php

+ * debug specific requests, users or apps
+ *
+ * Supported conditions:
+ *  - ``secret``: if a request parameter with the name `log_secret` is set to


shared_secret?

* remove duplicate code from child classes

MorrisJobke · 2015-05-08T13:15:41Z

Do we want to use a header or not?

MorrisJobke · 2015-05-08T13:16:12Z

BTW: all the other comments are addressed.

LukasReschke · 2015-05-08T13:28:02Z

config/config.sample.php

+ * Defaults to an empty array.
+ */
+'log.condition' => [
+	'secret' => '57b58edb6637fe3059b3595cf9c41b9',


Now doc and content is not the same anymore 🙈

Oh ... forgot that one

* Log condition for log level increase based on conditions. Once one of these conditions is met, the required log level is set to debug. This allows to debug specific requests, users or apps * Supported conditions (setting `log_condition` in `config.php`): - `shared_secret`: if a request parameter with the name `log_secret` is set to this value the condition is met - `users`: if the current request is done by one of the specified users, this condition is met - `apps`: if the log message is invoked by one of the specified apps, this condition is met * fix unit test and add app log condition test

scrutinizer-notifier · 2015-05-08T14:01:42Z

A new inspection was created.

ghost · 2015-05-18T09:33:33Z

Refer to this link for build results (access rights to CI server needed):
https://ci.owncloud.org//job/pull-request-analyser-ng-simple/12374/
🚀 Test PASSed.🚀

MorrisJobke · 2015-05-18T09:34:53Z

@LukasReschke @nickvergessen @rullzer @Xenopathic Ready for review :)

rullzer · 2015-05-19T07:42:56Z

Working very nice!
I would like to see a header as well (maybe different PR, if it is to much work since this should get in). So debugging the OCS API etc becomes a bit easier.

As mentioned on IRC the call_user_func stuff makes me cry. But also that should be addressed in another PR.

👍 !

DeepDiver1975 · 2015-05-19T09:59:05Z

lib/private/log/errorlog.php

@@ -39,10 +39,7 @@ public static function init() {
 	 * @param int $level
 	 */
 	public static function write($app, $message, $level) {
-		$minLevel = min(OC_Config::getValue("loglevel", OC_Log::WARN), OC_Log::ERROR);
-		if ($level >= $minLevel) {


~~why was this removed? @MorrisJobke THX~~

DeepDiver1975 · 2015-05-19T10:00:16Z

👍

Conditional logging

MorrisJobke added the 3 - To Review label Apr 30, 2015

DeepDiver1975 added this to the 8.1-current milestone May 4, 2015

DeepDiver1975 mentioned this pull request May 4, 2015

Use internally \OCP\ILogger instead of \OC\Log #15958

Merged

DeepDiver1975 force-pushed the conditional-logging branch from 753c2db to 023734c Compare May 4, 2015 07:15

MorrisJobke added 2 - Developing and removed 3 - To Review labels May 4, 2015

MorrisJobke force-pushed the conditional-logging branch from 023734c to 0ad6ba7 Compare May 4, 2015 09:56

MorrisJobke added 3 - To Review and removed 2 - Developing labels May 4, 2015

LukasReschke reviewed May 8, 2015
View reviewed changes

Move log level check to logger parent class

892b5ce

* remove duplicate code from child classes

MorrisJobke force-pushed the conditional-logging branch from 0ad6ba7 to 0d3fea2 Compare May 8, 2015 13:14

LukasReschke reviewed May 8, 2015
View reviewed changes

MorrisJobke force-pushed the conditional-logging branch from 0d3fea2 to e79c255 Compare May 8, 2015 14:01

DeepDiver1975 reviewed May 19, 2015
View reviewed changes

DeepDiver1975 added a commit that referenced this pull request May 19, 2015

Merge pull request #15965 from owncloud/conditional-logging

a52afb0

Conditional logging

DeepDiver1975 merged commit a52afb0 into master May 19, 2015

DeepDiver1975 deleted the conditional-logging branch May 19, 2015 10:00

mmattel pushed a commit to mmattel/core that referenced this pull request May 22, 2015

Merge pull request owncloud#15965 from owncloud/conditional-logging

8e51877

Conditional logging

butonic mentioned this pull request Sep 6, 2016

[admin] document conditional logging owncloud-archive/documentation#2608

Closed

lock bot locked as resolved and limited conversation to collaborators Aug 12, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Conditional logging #15965

Conditional logging #15965

MorrisJobke commented Apr 30, 2015

MorrisJobke commented Apr 30, 2015

MorrisJobke commented Apr 30, 2015

felixboehm commented Apr 30, 2015

karlitschek commented Apr 30, 2015

DeepDiver1975 commented May 4, 2015

DeepDiver1975 commented May 4, 2015

MorrisJobke commented May 4, 2015

MorrisJobke commented May 8, 2015

LukasReschke commented May 8, 2015

LukasReschke May 8, 2015

MorrisJobke commented May 8, 2015

MorrisJobke commented May 8, 2015

LukasReschke May 8, 2015

LukasReschke May 8, 2015

MorrisJobke May 8, 2015

scrutinizer-notifier commented May 8, 2015

ghost commented May 18, 2015

MorrisJobke commented May 18, 2015

rullzer commented May 19, 2015

DeepDiver1975 May 19, 2015

DeepDiver1975 commented May 19, 2015

Conditional logging #15965

Conditional logging #15965

Conversation

MorrisJobke commented Apr 30, 2015

MorrisJobke commented Apr 30, 2015

MorrisJobke commented Apr 30, 2015

felixboehm commented Apr 30, 2015

karlitschek commented Apr 30, 2015

DeepDiver1975 commented May 4, 2015

DeepDiver1975 commented May 4, 2015

MorrisJobke commented May 4, 2015

MorrisJobke commented May 8, 2015

LukasReschke commented May 8, 2015

LukasReschke May 8, 2015

Choose a reason for hiding this comment

MorrisJobke commented May 8, 2015

MorrisJobke commented May 8, 2015

LukasReschke May 8, 2015

Choose a reason for hiding this comment

LukasReschke May 8, 2015

Choose a reason for hiding this comment

MorrisJobke May 8, 2015

Choose a reason for hiding this comment

scrutinizer-notifier commented May 8, 2015

ghost commented May 18, 2015

MorrisJobke commented May 18, 2015

rullzer commented May 19, 2015

DeepDiver1975 May 19, 2015

Choose a reason for hiding this comment

DeepDiver1975 commented May 19, 2015