owncloud-archive / documentation

:blue_book: The ownCloud documentation and manual
https://doc.owncloud.com/
Other
186 stars 168 forks source link

Improve the conditional logging description #3769

Closed mmattel closed 6 years ago

mmattel commented 6 years ago

Identified via https://github.com/owncloud/core/issues/30388

admin_manual/configuration/server/logging_configuration.html

Section: Conditional Logging Level Increase

The current description tells abot how to set conditional logging in config.php

'log.condition' => [
       'shared_secret' => '57b58edb6637fe3059b3595cf9c41b9',
       'users' => ['sample-user'],
       'apps' => ['files'],
],

but not an example on how to use the log_secret request parameter.

The following (little bit edited) below, copied from http://morrisjobke.de/2015/07/22/Conditional-Logging-in-ownCloud/ would help explaining the use.

Example: following request will cause to write all log messages during the execution 
(given that the above config is applied):

curl -X PROPFIND -u sample-user:password \
  https://your_domain/remote.php/webdav/\?log_secret\=57b58edb6637fe3059b3595cf9c41b9

@PVince81 @settermjd

voroyam commented 6 years ago

So you want the text with the example in included in the docs, right?

mmattel commented 6 years ago

@voroyam I saw that the conditional logging part needs a small review anyway, here and in config.sample.php. I am working on that. In addition, I am working on a core PR with a small improvement which then will flow into the upcoming PR here too.

voroyam commented 6 years ago

Ah, good to know :)

mmattel commented 6 years ago

https://github.com/owncloud/documentation/pull/3779 (Conditional Logging description improvements)

mmattel commented 6 years ago

3779 has been merged - closing.