[tor-bugs] #13362 [Onionoo]: Make Onionoo's logs more useful

[Tor Bug Tracker & Wiki]

#13362: Make Onionoo's logs more useful
-----------------------------+----------------------------
     Reporter:  karsten      |      Owner:
         Type:  enhancement  |     Status:  needs_revision
     Priority:  normal       |  Milestone:
    Component:  Onionoo      |    Version:
   Resolution:               |   Keywords:
Actual Points:               |  Parent ID:
       Points:               |
-----------------------------+----------------------------

Comment (by iwakeh):

 task-13362 branch is ok to be merged.

 I think we mostly agree on the logging.
 Starting from your suggestions I also added what the logging document
 should mention for whom.
 (ops=operators, devs=developers)

 - The detailed log including everything (debug and up) is important for
 development.
  * Logging instructions: How to turn the detailed log off (ops) and how to
 change the threshold level (ops, devs).
 - The warn-error-log for ops (warning and up).
  * Logging instructions: How to turn it off (devs,ops).

 I wouldn't impose nagios on operators, as there are many other monitoring
 solutions. Just provide a link to the available nagios scripts. And, also
 mention the possibility of configuring appenders (without detailing it),
 so whoever has experience with logback (or want to learn) can use whatever
 they prefer.
 The logging document should point out that warnings and errors are to be
 taken seriously (ops).
 In addition, log messages themselves should contain possible solutions, or
 hints about what to do. (This is actually a topic for the contributor
 document.)
 For example, the missing Geoip error could refer to the install file.

 The 'statistics' log statements can be treated as you suggested, no need
 for a separate log.

 Separate logfiles for backend and frontend can be set using the command
 line options introduced with the one-jar/one-war task.
 Basically, how to do this needs to be explained in the logging document.

 As for the (future) production environment, you mentioned that the two
 ought to run under different users anyway. So, they should already have
 separate logs?

 >  ... What we might want to do instead is define thresholds for certain
 operations, like reading descriptors of a certain time, and emit a warning
 if that operation takes longer than that.
 Maybe, that is only relevant for development and performance tuning?  Can
 an operator do something about these warnings? Or, do you want these to be
 reported as a track issue?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/13362#comment:6>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online