Opened 9 years ago

Closed 9 years ago

#1011 closed task (complete)

Document how to configure logging

Reported by: stephen Owned by: jreed
Priority: medium Milestone: Sprint-20110816
Component: documentation Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: Core Feature Depending on Ticket:
Estimated Difficulty: 4.0 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description


Subtickets

Change History (13)

comment:1 Changed 9 years ago by stephen

  • Component changed from Unclassified to documentation

comment:2 Changed 9 years ago by stephen

  • Estimated Difficulty changed from 0.0 to 4

comment:3 Changed 9 years ago by jelte

  • Owner set to jelte
  • Status changed from new to assigned

comment:4 Changed 9 years ago by jelte

I guess it will need to go into docbook/admin guide in the end, but as it might need some editing, i've put it into the wiki for now;

http://bind10.isc.org/wiki/LoggingConfigurationGuide

comment:5 Changed 9 years ago by jelte

  • Owner changed from jelte to UnAssigned
  • Status changed from assigned to reviewing

comment:6 Changed 9 years ago by stephen

  • Owner changed from UnAssigned to stephen

comment:7 Changed 9 years ago by stephen

  • Owner changed from stephen to jelte

Rather than list changes here, I've updated the document. I've corrected a few typos and expanded sections I thought needed more explanation. Differences can be seen by doing a diff between the two versions of the wiki page.

comment:8 Changed 9 years ago by jelte

Thanks!

Not entirely sure what the next step is though, should I convert this text to docbook format?

comment:9 Changed 9 years ago by jelte

  • Owner changed from jelte to jreed

passing the merging-into-docs on to jeremy

comment:10 Changed 9 years ago by jreed

I am doing this in trac1011 branch. I put into the bind10-guide.xml. This is not complete yet.

comment:11 follow-up: Changed 9 years ago by jreed

  • Owner changed from jreed to UnAssigned

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?

How to know the module names for the logger configuration?

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

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?

This sentence is incomplete:

 The general classification of debug message types is

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

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

comment:12 in reply to: ↑ 11 Changed 9 years ago by jelte

  • Owner changed from UnAssigned to jreed

Replying to 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.

comment:13 Changed 9 years ago by jreed

  • Resolution set to complete
  • Status changed from reviewing to closed
  • Sub-Project changed from DNS to Core

I merged in what we have for this a few days ago. The changelog entry was shown on jabber. I am closing this ticket, but we have a few minor documentation improvements related to this, but will be handled later (like #1074).

Note: See TracTickets for help on using tickets.