1347955 - Move the logging sub-page of about:networking to about:logging

Status: RESOLVED FIXED

(Core :: XPCOM, enhancement, P3)

Description

[Randell Jesup [:jesup] (needinfo me)]

Setting environment variables or even prefs to turn on logging is a bit cumbersome for non-technical users.

about:networking's logging sub-page has a field for setting the log file, and for setting the list of modules/severities to capture (and enable/disable buttons).  This amounts to a generic logging interface for the entire system, simpler in many ways than about:config logging.foo use.

We should move this sub-page to a generic logging page: about:logging

Note that about:networking sets a list of networking modules as the default.  if we move this, we should add a wey to get useful defaults for different subsystems/logging needs, via a dropdown, radio boxes or checkboxes.  I suggest checkboxes, since then it's easy to log multiple sets.

You might have Networking, DOM (multiple?), Webrtc, Layout, Media Playback, Extensions, GC, Threads, UI/Widgets, GFX etc.

We could also move timestamp, sync, etc to checkboxes if we care.

Comment 1

[Randell Jesup [:jesup] (needinfo me)]

ccing a few people who may be interested

Comment 2

[Valentin Gosu [:valentin] (he/him)]

I think this is a good idea. This is a very user friendly logging procedure, and should be easily accessible to more teams.

As a note on the checkboxes, my initial prototype used that, but with the number of logging modules in the code, it's simply not scalable. And adding a new log module to the tree shouldn't involve changing any UI code.

I would suggest keeping the text input boxes, as they are a close approximation of setting ENV variables, and maybe add a dropdown with the most common defaults for each team/class of issues. For example, select between proxy issues, audio issues, video issues, etc.

Comment 3

[Honza Bambas (:mayhemer)]

(In reply to Valentin Gosu [:valentin] from comment #2)
> I think this is a good idea. This is a very user friendly logging procedure,
> and should be easily accessible to more teams.
> 
> As a note on the checkboxes, my initial prototype used that, but with the
> number of logging modules in the code, it's simply not scalable. And adding
> a new log module to the tree shouldn't involve changing any UI code.
> 
> I would suggest keeping the text input boxes, as they are a close
> approximation of setting ENV variables, and maybe add a dropdown 

Drop down with checkboxes, so that we can get network logs when there are video issues and pin point which module is faulty?

> with the
> most common defaults for each team/class of issues. For example, select
> between proxy issues, audio issues, video issues, etc.

Comment 4

[Patrick McManus [:mcmanus]]

it'd be cool if you left a link to about:logging in the hole where the function used to be :) and +1 to profiles

Comment 5

[Kent James (:rkent)]

+1 for making logging more accessible to non-technical users.

Would this logging activate without a restart?

Comment 6

[Nils Ohlmeier [:drno]]

(In reply to Kent James (:rkent) from comment #5)
> Would this logging activate without a restart?

That is what the logging on about:networking does right now. The user clicks "start" and "stop".

And +1 for adding about:logging

Comment 7

[Randell Jesup [:jesup] (needinfo me)]

(In reply to Valentin Gosu [:valentin] from comment #2)
> I think this is a good idea. This is a very user friendly logging procedure,
> and should be easily accessible to more teams.
> 
> As a note on the checkboxes, my initial prototype used that, but with the
> number of logging modules in the code, it's simply not scalable. And adding
> a new log module to the tree shouldn't involve changing any UI code.

I was trying to suggest defaults/'profiles' -- i.e. we'd still have the text box, but something (checkboxes I suggest) would insert into the box a string for a meta-module (e.g. DOM, WebRTC, Networking, Media Playback, Threads, GC, etc.)  check multiple, and each one you check adds to the string.  Or have it replace whats there with a new string, in which case go with drop-down or radio-buttons.  

> I would suggest keeping the text input boxes, as they are a close
> approximation of setting ENV variables, and maybe add a dropdown with the
> most common defaults for each team/class of issues. For example, select
> between proxy issues, audio issues, video issues, etc.

Definitely keep the text boxes.

Comment 8

[Blake Wu [:bwu][:blakewu]]

+1 for adding about:logging.
Anyone is working on this or plans to do this?

Comment 9

[Eric Rahm [:erahm]]

(In reply to Blake Wu [:bwu][:blakewu] from comment #8)
> +1 for adding about:logging.
> Anyone is working on this or plans to do this?

Not that I know of, might be a good intro to Firefox project.

Comment 10

[Paul Adenot (:padenot)]

Attachment: Bug 1347955 - Move the logging facilities from about:networking to a new page, about:logging. r?valentin

Comment 11

[Paul Adenot (:padenot)]

Attachment: Bug 1347955 - Move all logging related functionality from about:networking to about:logging. r?valentin

There's no change in functionality, I've more or less copied everything
verbatim. I have lots of changes planned, those will happen in other bugs.

Depends on D159606

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c6b2602a6283
Move the logging facilities from about:networking to a new page, about:logging. r=valentin,fluent-reviewers,flod

Comment 13

[Iulian Moraru]

https://hg.mozilla.org/mozilla-central/rev/c6b2602a6283