460075 - Consolidate logging, support fine-grained logging

Status: RESOLVED FIXED

(Calendar :: General, enhancement)

Description

[Daniel Boelzle [:dbo]]

We currently have at least two logging mechanisms in the code:
- calUtils.js' function LOG()
- calWcapUtils.js' function log()

Moreover we've more and more code logging, bloating the console if calendar.debug.log or calendar.debug.log.verbose is set. This makes it increasingly harder to read the log.

I think we need to
- consolidate and find a new API
- have a look at what stock mozilla platform offers
- add support for scoped/fine-grained logging, i.e. that users can switch on logging for specific code areas only, like e.g. "itip, wcap".
- add support for file logging (wcap's logging code may be recycled)

Comment 1

[Daniel Boelzle [:dbo]]

- add support for different log levels, e.g. from 1 (basic) to 5 (verbose) like "itip:5"

Comment 2

[David Ascher (:davida)]

See bug 451283 and bug 450631.  We're planning on having log4moz available as part of Thunderbird, either as part of log4moz in toolkit or in mailnews.

Comment 3

[David Ascher (:davida)]

adding dmose, because i know he cares.

Comment 4

[David :Bienvenu]

I don't think this is a 1.0 blocker.

Comment 5

[Philipp Kewisch [:Fallen][☁️📆]]

Agreed, not that important!

Comment 6

[Stefan Fleiter (:sfleiter)]

If this should be of use for calendar and its providers this should depend on bug 451283, shouldn't it?
Calendar is not only used in Thunderbird/Lightning but also in Seamonkey and probably others.

Comment 7

[Magnus Melin [:mkmelin]]

Overall, calendar logging should also move over to using console.createInstance, and not be the strange global it is atm. See 944367.
https://searchfox.org/comm-central/rev/a3f0581ca2fcd95e6c32828f583ebfae5487c2ec/calendar/base/modules/calUtils.jsm#47
For getting familiar with the codebase, going through and fixing the logging let's one see a lot.

Comment 8

[Magnus Melin [:mkmelin]]

Attachment: Bug 460075 - part1: remove usage of cal.LOG and cal.LOGVerbose. r=#thunderbird-reviewers

grep --exclude-dir={.hg,rust,suite} -rlE 'cal\.LOGverbose' calendar/  | xargs sed -i -E 's#cal.LOGverbose#lazy.log.debug#g'
grep --exclude-dir={.hg,rust,suite} -rlE 'cal\.LOG' calendar/  | xargs sed -i -E 's#cal.LOG#lazy.log.debug#g'

For modules, add their own loggers.
For pure .js files, remove logging.

Comment 9

[Magnus Melin [:mkmelin]]

Attachment: Bug 460075 - part2: remove usage of cal.WARN. r=tobyp

Comment 10

[Magnus Melin [:mkmelin]]

Attachment: Bug 460075 - part3: remove usage of cal.ERROR. r=#thunderbird-reviewers

Comment 11

[Magnus Melin [:mkmelin]]

Attachment: Bug 460075 - part4: remove usage of cal.STACK. r=aleca

Comment 12

[Magnus Melin [:mkmelin]]

Attachment: Bug 460075 - part5: remove usage of cal.ASSERT. r=aleca

Comment 13

[Magnus Melin [:mkmelin]]

Attachment: Bug 460075 - part6: remove definitions of the old logging releated functions, update prefs. r=#thunderbird-reviewers

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/5e158fbf782d
part1: remove usage of cal.LOG and cal.LOGVerbose. r=tobyp
https://hg.mozilla.org/comm-central/rev/6893fc1b9cfc
part2: remove usage of cal.WARN. r=tobyp
https://hg.mozilla.org/comm-central/rev/fd35f2f9f508
part3: remove usage of cal.ERROR. r=tobyp
https://hg.mozilla.org/comm-central/rev/c3e313ded227
part4: remove usage of cal.STACK. r=aleca
https://hg.mozilla.org/comm-central/rev/42233837fadd
part5: remove usage of cal.ASSERT. r=aleca
https://hg.mozilla.org/comm-central/rev/b108c9be4122
part6: remove definitions of the old logging releated functions, update prefs. r=aleca