feat(occ): Add a --debug option to output all log levels to the output

[come-nc]

Related to #30989

Summary

Adds a universal option to pass to occ commands so that all levels of logs are printed in the output, even if the loglevel on the instance is higher.
This allows to inspect all the logging related to a command without having it mixed up with logs from other stuff going on in the server. Also allows to have logs and command output in the same place to see in which order things happen.
This is especially useful with user_ldap as all LDAP calls are logged in debug level.

TODO

• Decide on the correct naming for the option, currently --debug bug maybe this will cause conflicts too easily. Changed to --debug-log
• Decide whether to document the option in the usage output for classes based on OC\Core\Command\Base.
• Determine whether the output format is the right one. (Do we want raw json instead?) Abandoned this idea, there is not much data to put in json anyway
• Do we need to be able to do the same with an arbitrary loglevel, like --debug=1 to only show info and above? Added support for --debug-log-level when --debug-log is used
• Should we activate the profiler when this option is used and output the profile? Not automatically
• How can we make it output DB requests to the output as well? The profiler idea above would work. Left as an exercise for later

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Screenshots before/after for front-end changes
• Documentation (manuals or wiki) has been updated or is not required
• Backports requested where applicable (ex: critical bugfixes)

[come-nc]

Hum, I think this is a duplicate of nextcloud/logreader#873 .
I’d prefer having this in core and as an option though, as setting an env var is not always the same syntax for customers, and logreader may be disabled. The point was to have a command we can pass to any user to get a detailed idea of what happens when they run a command.

[icewind1991]

I’d prefer having this in core

Makes sense.

Decide on the correct naming for the option, currently --debug bug maybe this will cause conflicts too easily.

Maybe --debug-log (--debug is already conflicting with some apps)

Determine whether the output format is the right one. (Do we want raw json instead?)

We can do both by allowing something like --debug-log-format=json

Do we need to be able to do the same with an arbitrary loglevel, like --debug=1 to only show info and above?

Allowing a log level and defaulting to debug makes most sense to me (--debug-log=info)

Should we activate the profiler when this option is used and output the profile?

Should be a separate options

How can we make it output DB requests to the output as well? The profiler idea above would work.

Also would have that as a separate option.

--

It might make sense to have this logic detect if the logreader is available and delegate the logging to the logreader when possible, since that app already has cli log formatting. Keeping a "basic" log output in core.

[nickvergessen]

Should we put them into OCP somewhere so app devs have a list/track of "reserved arguments"?

[nickvergessen]

@come-nc Please document in https://docs.nextcloud.com/server/latest/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_30.html#id1