[tahoe-lafs-trac-stream] [tahoe-lafs] #1936: the tahoe-lafs logging system is hard to discover

[tahoe-lafs]

#1936: the tahoe-lafs logging system is hard to discover
--------------------------------------------+---------------------------
 Reporter:  zooko                           |          Owner:
     Type:  defect                          |         Status:  new
 Priority:  normal                          |      Milestone:  undecided
Component:  code-nodeadmin                  |        Version:  1.9.2
 Keywords:  usability transparency logging  |  Launchpad Bug:
--------------------------------------------+---------------------------
 [source:git/docs/logging.rst?rev=861892983369c0e96dc1e73420c1d9609724d752
 docs/logging.rst] explains how to get logging info out of your Tahoe-LAFS
 node. (Mostly for developers editing the source code, but also potentially
 useful for operators.) Nobody discovers this! Many people have reported a
 similar problem, frustration, and waste of time as Itamar did just now on
 IRC:

 {{{
 <itamar1> can someone help me with tahoe's logging code?
 <zooko> itamar1: I can!  [10:14]
 <zooko> Actually, there's a doc.
 <itamar1> oh
 <zooko> So, let's see if that doc answers your questions
 <itamar1> I guess I should've looked for docs first :)
 <zooko> find docs -iname '*log*'
 * itamar1 goes looking
 <zooko> Well, secondly I wonder if the existence of that doc could be
                 better-documented!  [10:15]
 <zooko> Maybe linked from some "devel" page about tahoe-lafs...
 * zooko looks at https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Dev
 <itamar1> I sort've expected everything to be logged by default  [10:16]
 <zooko> Hm, well I'm not sure how to make the logging doc more
 discoverable.
 <zooko> Many people have had that exact same problem, including me many
 times.
 <zooko> I more or less approve of Brian's decision to make logging terse
 by
                 default.
 <zooko> But
 <itamar1> and then spent sometime trying to find log level settings in
 command
                   line help
 <zooko> I'd really like to help people figure it out more easily.
 <zooko> Yeah, I'm sure a lot of people have lost time like that. Many have
                 reported it on the IRC channel.
 }}}

-- 
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1936>
tahoe-lafs <https://tahoe-lafs.org>
secure decentralized storage