BIND 10 #763: Conversion of statistics code to use the new logging interface

[BIND 10 Development]

#763: Conversion of statistics code to use the new logging interface
-------------------------------------+-------------------------------------
                   Reporter:         |                 Owner:  jelte
  stephen                            |                Status:  reviewing
                       Type:         |             Milestone:
  enhancement                        |  Sprint-20110712
                   Priority:  major  |            Resolution:
                  Component:         |             Sensitive:  0
  logging                            |           Sub-Project:  DNS
                   Keywords:         |  Estimated Difficulty:  2.0
            Defect Severity:  N/A    |           Total Hours:  0
Feature Depending on Ticket:         |
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------
Changes (by stephen):

 * owner:  stephen => jelte


Comment:

 '''src/bin/stats/stats_httpd.py.in'''
 Nothing to do with this ticket, but I note that some files are stats_httpd
 and others are stats-httpd.  I would suggest that they be made consistent.

 '''src/bin/stats/stats_httpd_messages.mes'''
 With the convention that messages are <prefix>_<message>, I was reading a
 message such as STATS_HTTPD_CLOSING_CC_SESSION as prefix STATS_, message
 HTTPD_CLOSING_CC_SESSION.  I suggest we use a string (without underscros)
 for the prefix.  In this case, how about something like STHTTPD_ or
 HTTPDSTAT_?

 STATS_HTTPD_BAD_OPTION_VALUE
 Should be no comma before "and".

 STATS_HTTPD_CC_SESSION_ERROR
 I've seem traffic in the Jabber room on this.  Are we standardising on
 "message bus" or "message queue"?

 STATS_HTTPD_CLOSING_CC_SESSION
 "stats httpd" should be hyphenated to be consistent with other uses.

 STATS_HTTPD_CLOSING
 Typo "te".

 STATS_HTTPD_SERVER_ERROR
 "This is an error condition that should not occur". Would it be an error
 if it should? :-)

 STATS_HTTPD_SERVER_INIT_ERROR
 Receiving new configuration data".  This implies that it has old
 configuration data which is being updated, and so suggests that has been
 running some time and so is not initializing.

 Should be space in "data.The".

 STATS_HTTPD_SHUTDOWN
 "will now shut down" implies that the daemon is just about to start
 shutting down, while the message "shutting down" implies that it is in the
 process of shutting down.


 STATS_HTTPD_STOPPED_BY_KEYBOARD
 Perhaps add "(Obviously, this can only happen if the statistics daemon is
 being run from a terminal.)"

 STATS_HTTPD_UNKNOWN_CONFIG_ITEM
 Received a new configuration from where, and where was the response sent?


 '''src/bin/stats/stats_messages.mes'''
 In message descriptions, I think "stats" should be expanded to
 "statistics".

 STATS_BAD_OPTION_VALUE
 Should be no comma before "and".

 STATS_CC_SESSION_ERROR
 Same comments as STATS_HTTPD_CC_SESSION_ERROR

 STATS_RECEIVED_NEW_CONFIG
 In light of the name, the text might be better as "the statistics module
 has received a new configuration from the configuration manager" rather
 that "configuration manager has sent ...".  The latter seems to imply that
 this should be a message output by the configuration manager.

 STATS_RECEIVED_REMOVE_COMMAND
 Can we explain what a "remove" command is and what is the "given name"?
 Also, does this have a permanent effect (i.e. when I run it, I can never
 add given name back)?

 STATS_RECEIVED_RESET_COMMAND
 "reset all collected statistics": to what?  Would be better to say that
 the reset command clears the stored statistics?

 STATS_RECEIVED_SHUTDOWN_COMMAND
 Should be no comma before "and".

 STATS_RECEIVED_STATUS_COMMAND
 I feel that "I'm alive" is a bit flippant.  Assuming that the only status
 that can be returned is "I'm alive", perhaps something like "The
 statistics module has received a command asking it to report its status.
 It will return a response indicating that it is running normally."

 STATS_RECEIVED_UNKNOWN_COMMENT
 Should be no comma before "and".

 STATS_SEND_STATS_REQUEST_BOSS
 If this is the only request that can be sent to Boss, perhaps just
 "STATS_SEND_REQUEST_BOSS" would be enough?

 Being pedantic here, The word "statistics" refers to a quantity (such as
 the mean or median) calculated from a set of data.  Is the statistics
 module requesting Boss to send it this information, or is it requesting
 Boss to send it the raw counters from which it will calculate appropriate
 statistics?

 STATS_STOPPED_BY_KEYBOARD
 Perhaps add "(Obviously, this can only happen if the statistics daemon is
 being run from a terminal.)"

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