BIND 10 #1011: Document how to configure logging

[BIND 10 Development]

#1011: Document how to configure logging
-------------------------------------+-------------------------------------
                   Reporter:         |                 Owner:  jreed
  stephen                            |                Status:  reviewing
                       Type:  task   |             Milestone:
                   Priority:  major  |  Sprint-20110816
                  Component:         |            Resolution:
  documentation                      |             Sensitive:  0
                   Keywords:         |           Sub-Project:  DNS
            Defect Severity:  N/A    |  Estimated Difficulty:  4.0
Feature Depending on Ticket:         |           Total Hours:  0
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------
Changes (by jelte):

 * owner:  UnAssigned => jreed


Comment:

 Replying to [comment:11 jreed]:
 > I did some docbook formatting and very minor changes. See
 http://git.bind10.isc.org/~jreed/bind10-guide.html#id1168229447701
 >
 > I have some questions/comments:
 >
 > What is context of Logging module for readers of this guide?
 > Should it clearly say "configuration module" each time?
 >

 Umz, I'm not sure I understand the question exactly. It may depend on the
 point of view; we don't really have a term for it (perhaps we should), but
 Logging is in my view a 'virtual module', in that it does not have a
 process, and you cannot send it commands. The only thing that is left is
 that you can configure stuff for it. Another point of view is that is is a
 module that is evenly divided over all other modules. Or you could indeed
 call it a 'configuration module'. Perhaps this is clearest. Or we should
 have a definite specific term for these things.

 > How to know the module names for the logger configuration?
 >

 The module names for the logger configuration are the same as the names
 for the modules themselves. Right now you can only see what their names
 are if they are running (a simple 'help' without anything else in bindctl
 for instance). I still hope to have a good solution for this soonish :/

 > How to know the specific library names for the logger configuration?
 >

 That is more tricky. We will either have to document them or tell the
 administrator to specify module-wide logging and see what appears...
 (which of course isn't a very useful method, what if the logging of some
 lib doesn't happen to be triggered).

 > It says:
 > {{{
 >           When the severity of a logger is set to one of these
 >           values, it will only log messages of that severity, and
 >           the severities below it. The severity may also be set to
 >           NONE, in which case all messages from that logger are
 >           inhibited.
 > }}}
 >
 > Is this worded wrong? If I set to INFO, why would it show DEBUG which is
 literally below in that list?
 >

 hmm, yes, the age-old 'what is higher' :) It should indeed be 'above'.
 Perhaps we should make it 'and messages of a higher severity'.

 > This sentence is incomplete:
 >
 > {{{
 >  The general classification of debug message types is
 > }}}
 >

 unfinished. Literally... The end of this sentence is waiting on ticket
 1074, which was on Stephen's plate, but he wasn't able to get around to
 it. So for now we should either remove it or put in a placeholder text.


 > There is a note to check the output_options. I did not confirm this
 myself yet.
 >

 "TODO; there's a ticket to determine these levels, see #1074"?

 Ah. That is the current placeholder for the end of the sentence in the
 previous comment ("The general classification of debug message types").

 > Adding the empty loggers makes no sense. What can we do to fix this?
 >

 We can either warn (like we would for loggers with bad names), or actually
 error on it and don't accept the config. At this moment I have no strong
 preference for either option.

-- 
Ticket URL: <http://bind10.isc.org/ticket/1011#comment:12>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development