Allow easier access to debugging logs for bug reporting

[msxfm]

Issue by jsamuel Thursday Dec 22, 2011 at 18:45 GMT Originally opened as https://github.com/RequestPolicy/requestpolicy/issues/5

---

imported trac ticket
created: 2009-06-21 16:31:08
reporter: justin

The only existing way for a user to copy a debugging log snippet (details of blocked/allowed requests) is through a process intended for developers that involves changing values through about:config. At a minimum it should be possible to enable console logging through preferences > advanced. Even better would be a way for users to access this debugging info without having to start firefox from a console.

[stewie]

upvote ! I would hope to have an RP log window (ff xul window), plus preference for setting configurable max size (in terms of memory overhead, or # lines of scrollback) and a "clear/reset" button. Separately, a preference would determine whether the log is also output to a file on disk (doesn't depend on whether or not the log window is kept open). Different from the existing requests logger/window, this would serve as a log/reminder of which rule(s) was added most recently ~~ so that when something breaks, I can look back and find which rule needs to be revoked.

For reference (code involved in writing to file on disk), here's an addon I'ved used which outputs its log data to file on disk: https://addons.mozilla.org/en-US/firefox/addon/http-request-logger Lesson learned: this puppy churns the hard drive (not really churns, but accesses the drive, vs buffering then dumping every xx min or xx Kb of accumulated lofile data) and the logfile grows in size remarkably quickly. SSD users might cringe at the prospect of this logger's incessant write operations.

[nodiscc]

RP currently has a "Request log" entry in the dropdown menu. I foresee having it write to disk will cause performance issues, so I'd better like the ability to copy all/multiple lines from the request log to the clipboard (currently you can only copy one line at a time).

[nodiscc]

Current debugging process is to enable logging via about:config, and run Firefox from a terminal, and copy-paste this to the appropriate bug report (https://github.com/RequestPolicyContinued/requestpolicy/wiki/Setting-up-a-development-environment#enable-logging). To make this easier

• There could be a checkbox in the request log top bar (next to the Clear button) labeled Show debug information, clicking this checkbox would enable logging and redirect RP's debug messages to the request log (possible?)
• As mentioned before, there should be a way to copy the full/a portion of the log, being either: 1) A Save log... button (save the log to a file); 2) ability to select and copy multiple lines; 3) a Copy log to clipboard button (copies the full request/debug log to clipboard)

[myrdd]

redirect RP's debug messages to the request log (possible?)

Log messages are strings, sometimes multiline if it contains bug tracing (though it would be very easy to make the trace optional). As log messages are arbitrary strings it would be maybe better to have a textarea field, maybe more comfortable (e.g. with filtering). That logging textarea would be in addition to the request log. I like the idea, as filtering etc. is much easier and straightforward!

there should be a way to copy the full/a portion of the log

all of the options you mentioned are possible. About selection of multiple lines: seltype="multiple" must be set – see https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/tree

[myrdd]

copied from #892: TODO:

• [ ] store errors (log messages) and notify the user (in the menu), asking him to report the errors
  • for each RP runtime, only store a maximum number of errors, e.g. 100 (to avoid large files)
  • keep only the log of the last 10 runs (if no errors in the last 10 runs, there will be no log messages)