[trac738] Adjusted name and description of some messages

src/bin/auth/auth_messages.mes

@@ -15,36 +15,43 @@
 $NAMESPACE isc::auth
 
 % AUTH_AXFR_ERROR error handling AXFR request: %1
-A debug message produced by the authoritative server when it has encountered
+This is a debug message produced by the authoritative server when it
-an error processing an AXFR request. The message gives the reason for the
+has encountered an error processing an AXFR request. The message gives
-error and the server will return a SERVFAIL code to the sender.
+the reason for the error, and the server will return a SERVFAIL code to
+the sender.
 
 % AUTH_AXFR_UDP AXFR query received over UDP
-A debug message, output when the authoritative server has received an AXFR
+This is a debug message output when the authoritative server has received
-query over UDP. This is not permitted by the protocol, and the server will
+an AXFR query over UDP. Use of UDP for AXFRs is not permitted by the
-return a FORMERR error to the sender.
+protocol, so the server will return a FORMERR error to the sender.
 
 % AUTH_COMMAND_FAILED execution of command '%1' failed: %2
 Execution of the specified command by the authoritative server failed. The
 message contains the reason for the failure.
 
 % AUTH_CONFIG_CHANNEL_CREATED configuration session channel created
-A debug message indicating that authoritative server has created the channel to
+This is a debug message indicating that authoritative server has created
-the configuration manager.
+the channel to the configuration manager.
+It is issued during server
+startup is an indication that the initialization is proceeding normally.
 
 % AUTH_CONFIG_CHANNEL_ESTABLISHED configuration session channel established
-A debug message indicating that authoritative server has established
+This is a debug message indicating that authoritative server
-communication over the previously-created channel to the configuration manager.
+has established communication the configuration manager over the
+previously-created channel. It is issued during server startup is an
+indication that the initialization is proceeding normally.
 
 % AUTH_CONFIG_CHANNEL_STARTED configuration session channel started
-A debug message, issued when the authoritative server has posted a request to
+This is a debug message, issued when the authoritative server has
-be notified when new configuration information is available.
+posted a request to be notified when new configuration information is
+available. It is issued during server startup is an indication that
+the initialization is proceeding normally.
 
 % AUTH_CONFIG_LOAD_FAIL load of configuration failed: %1
-At attempt to configure the server with information from the configuration
+An attempt to configure the server with information from the configuration
-database has failed, the reason being given in the message. The server will
+database during the startup sequence has failed. (The reason for
-continue its initialization although it may not be configured in the desired
+the failure is given in the message.) The server will continue its
-way.
+initialization although it may not be configured in the desired way.
 
 % AUTH_CONFIG_UPDATE_FAIL update of configuration failed: %1
 At attempt to update the configuration the server with information
@@ -52,54 +59,39 @@ from the configuration database has failed, the reason being given in
 the message.
 
 % AUTH_DATA_SOURCE data source database file: %1
-A debug message produced by the authoritative server when it accesses a
+This is a debug message produced by the authoritative server when it accesses a
 datebase data source, listing the file that is being accessed.
 
-% AUTH_DNSSERVICES_CREATED DNS services created
+% AUTH_DNS_SERVICES_CREATED DNS services created
-A debug message indicating that the component that will handling incoming
+This is a debug message indicating that the component that will handling
-queries for the authoritiative server (DNSServices) has been successfully
+incoming queries for the authoritiative server (DNSServices) has been
-created.
+successfully created. It is issued during server startup is an indication
+that the initialization is proceeding normally.
 
 % AUTH_HEADER_PARSE_FAIL unable to parse header in received DNS packet: %1
-A debug message, generated by the authoritative server when an attempt to parse
+This is a debug message, generated by the authoritative server when an
-the header of a received DNS packet has failed. The reason for the failure is
+attempt to parse the header of a received DNS packet has failed. (The
-given in the message.
+reason for the failure is given in the message.) The server will drop the
+packet.
 
 % AUTH_LOAD_TSIG loading TSIG keys
-A debug message indicating that the authoritiative server has successfully
+This is a debug message indicating that the authoritiative server has
-accessed the keyring holding TSIG keys.
+successfully accessed the keyring holding TSIG keys. It is issued during
+server startup is an indication that the initialization is proceeding
+normally.
 
 % AUTH_LOAD_ZONE loaded zone %1/%2
-The authoritative server has loaded the named zone of the named class.
+This debug message is issued during the processing of the 'loadzone' command
+when the authoritative server has successfully loaded the names zone of the
+named class.
 
 % AUTH_MEM_DATASRC_DISABLED memory data source is disabled for class %1
-A debug message reporting that the authoritative server has discovered that
+This is a debug message reporting that the authoritative server has
-tge memory data source is disabled for the given class.
+discovered that the memory data source is disabled for the given class.
 
 % AUTH_MEM_DATASRC_ENABLED memory data source is enabled for class %1
-A debug message reporting that the authoritative server has discovered that
+This is a debug message reporting that the authoritative server has
-the memory data source is disabled for the given class.
+discovered that the memory data source is enabled for the given class.
-
-% AUTH_MESSAGE_PARSE_ERROR unable to parse received DNS packet: %1. Returning SERVFAIL
-A debug message, generated by the authoritative server when an attempt
-to parse a received DNS packet has failed due to something other than
-a protocol error. The reason for the failure is given in the message;
-the server will return a SERVFAIL error code to the sender.
-
-% AUTH_MESSAGE_PROTOCOL_ERROR protocol error in received DNS packet: %1. Returning %2
-A debug message, generated by the authoritative server when an attempt
-to parse a received DNS packet has failed due to a protocol error.
-The reason for the failure is given in the message, as is the error code
-that will be returned to the sender.
-
-% AUTH_MESSAGE_RECEIVED message received:\n%1
-A debug message output by the authoritative server when it receives a valid
-DNS message.
-
-Note: This message includes the packet received, rendered in the form of
-multiple lines of text. For this reason, it is suggested that this log message
-not be routed to the syslog file, where the multiple lines could confuse
-programs that expect a format of one message per line.
 
 % AUTH_NO_STATS_SESSION session interface for statistics is not available
 For some reason, the authoritative server has no session with the statistics
@@ -107,7 +99,7 @@ module is available. This could be an error in configuration.
 
 % AUTH_NO_XFRIN received NOTIFY but XFRIN session is not running
 This is a debug message produced by the authoritative server when it receives
-a NOTIFY packet but the XFRIN process is not running.  The packet will be
+a NOTIFY packet but the XFRIN process is not running. The packet will be
 dropped and nothing returned to the sender.
 
 % AUTH_NOTIFY_RRTYPE invalid question RR type (%1) in incoming NOTIFY
@@ -122,29 +114,50 @@ a NOTIFY packet that contains zero or more than one question. (A valid
 NOTIFY packet contains one question.) The server will return a FORMERR
 error to the sender.
 
+% AUTH_PACKET_PARSE_ERROR unable to parse received DNS packet: %1
+This is a debug message, generated by the authoritative server when an
+attempt to parse a received DNS packet has failed due to something other
+than a protocol error. The reason for the failure is given in the message;
+the server will return a SERVFAIL error code to the sender.
+
+% AUTH_PACKET_PROTOCOL_ERROR DNS packet protocol error: %1. Returning %2
+This is a debug message, generated by the authoritative server when an
+attempt to parse a received DNS packet has failed due to a protocol error.
+The reason for the failure is given in the message, as is the error code
+that will be returned to the sender.
+
+% AUTH_PACKET_RECEIVED message received:\n%1
+This is a debug message output by the authoritative server when it
+receives a valid DNS packet.
+
+Note: This message includes the packet received, rendered in the form of
+multiple lines of text. For this reason, it is suggested that this log message
+not be routed to the syslog file, where the multiple lines could confuse
+programs that expect a format of one message per line.
+
 % AUTH_PROCESS_FAIL message processing failure: %1
 This message is generated by the authoritative server when it has
-encountered an error whilst processing a received packet: the cause of
+encountered an internal error whilst processing a received packet:
-the error is included in the message.
+the cause of the error is included in the message.
 
 The server will return a SERVFAIL error code to the sender of the packet.
 However, this message indicates a potential error in the server.
 Please open a bug ticket for this issue.
 
 % AUTH_RECEIVED_COMMAND command '%1' received
-A debug message issued when the authoritative server has received a command
+This is a debug message issued when the authoritative server has received
-on the command channel.
+a command on the command channel.
 
 % AUTH_RECEIVED_SENDSTATS command 'sendstats' received
-A debug message issues when the authoritative server has received a command
+This is a debug message issues when the authoritative server has received
-from the statistics module to send it the server's statistics data. The
+a command from the statistics module to send it data. The 'sendstats'
-'sendstats' command is handled differently to other commands, which is why
+command is handled differently to other commands, which is why the debug
-the debug message associated with it has its own code.
+message associated with it has its own code.
 
 % AUTH_RESPONSE_RECEIVED received response message, ignoring
-A debug message, this is output if the authoritative server receives a DNS
+This is a debug message, this is output if the authoritative server
-message with the QR bit set, i.e. a response packet. The server ignores the
+receives a DNS packet with the QR bit set, i.e. a DNS response. The
-packet as it only response to question packets.
+server ignores the packet as it only responds to question packets.
 
 % AUTH_SEND_ERROR_RESPONSE sending an error response (%1 bytes):\n%2
 This is a debug message recording that the authoritative server is sending
@@ -165,32 +178,35 @@ multiple lines of text. For this reason, it is suggested that this log message
 not be routed to the syslog file, where the multiple lines could confuse
 programs that expect a format of one message per line.
 
-% AUTH_SERVER_CREATED  server created
+% AUTH_SERVER_CREATED server created
 An informational message indicating that the authoritative server process has
 been created and is initializing. The AUTH_SERVER_STARTED message will be
 output when initialization has successfully completed and the server starts
 accepting queries.
 
-% AUTH_SERVER_FAILED  server failed: %1
+% AUTH_SERVER_FAILED server failed: %1
 The authoritative server has encountered a fatal error and is terminating. The
 reason for the failure is included in the message.
 
-% AUTH_SERVER_STARTED  server stated
+% AUTH_SERVER_STARTED server stated
 Initialization of the authoritative server has completed successfully
 and it is entering the main loop, waiting for queries to arrive.
 
 % AUTH_SQLITE3 nothing to do for loading sqlite3
-A debug message indicating that the authoritative server has found that the
+This is a debug message indicating that the authoritative server has
-data source it is loading is an SQLite3 data source, so no further validation is
+found that the data source it is loading is an SQLite3 data source,
-needed.
+so no further validation is needed.
 
 % AUTH_STATS_CHANNEL_CREATED STATS session channel created
-A debug message indicating that the authoritative server has created a channel
+This is a debug message indicating that the authoritative server has
-to the statistics process.
+created a channel to the statistics process.  It is issued during server
+startup is an indication that the initialization is proceeding normally.
 
 % AUTH_STATS_CHANNEL_ESTABLISHED STATS session channel established
-A debug message indicating that the authoritative server has established
+This is a debug message indicating that the authoritative server
-communication over the previously created statistics channel.
+has established communication over the previously created statistics
+channel.  It is issued during server startup is an indication that the
+initialization is proceeding normally.
 
 % AUTH_STATS_COMMS communication error in sending statistics data: %1
 An error was encountered when the authoritiative server tried to send data
@@ -203,38 +219,42 @@ no acknowledgement within the specified time. The message includes
 additional information describing the reason for the failure.
 
 % AUTH_STATS_TIMER_DISABLED statistics timer has been disabled
-A debug message indicating that the statistics timer has been disabled in the
+This is a debug message indicating that the statistics timer has been
-authoritative server and no statistics information is being produced.
+disabled in the authoritative server and no statistics information is
+being produced.
 
 % AUTH_STATS_TIMER_SET statistics timer set to %1 second(s)
-A debug message indicating that the statistics timer has been enabled and
+This is a debug message indicating that the statistics timer has been
-that the authoritative server will produce statistics data at the specified
+enabled and that the authoritative server will produce statistics data
-interval.
+at the specified interval.
 
 % AUTH_UNSUPPORTED_OPCODE unsupported opcode: %1
-A debug message, produced when a received DNS packet being processed by the
+This is a debug message, produced when a received DNS packet being
-authoritative server has been found to contain an unsupported opcode. (The
+processed by the authoritative server has been found to contain an
-opcode received is included in the message.) The server will return an
+unsupported opcode. (The opcode is included in the message.) The server
-error code of NOTIMPL to the sender.
+will return an error code of NOTIMPL to the sender.
 
 % AUTH_XFRIN_CHANNEL_CREATED XFRIN session channel created
-A debug message indicating that the authoritative server has created a channel
+This is a debug message indicating that the authoritative server has
-to the XFRIN (Transfer-in) process.
+created a channel to the XFRIN (Transfer-in) process.  It is issued
+during server startup is an indication that the initialization is
+proceeding normally.
 
 % AUTH_XFRIN_CHANNEL_ESTABLISHED XFRIN session channel established
-A debug message indicating that the authoritative server has established
+This is a debug message indicating that the authoritative server has
-communication over the previously-created channel to the XFRIN (Transfer-in)
+established communication over the previously-created channel to the
-process.
+XFRIN (Transfer-in) process.  It is issued during server startup is an
+indication that the initialization is proceeding normally.
 
 % AUTH_ZONEMGR_COMMS error communicating with zone manager: %1
-A debug message output during the processing of a NOTIFY request.
+This is a debug message output during the processing of a NOTIFY request.
 An error (listed in the message) has been encountered whilst communicating
-with the zone manager.  The NOTIFY request will not be honored.
+with the zone manager. The NOTIFY request will not be honored.
 
 % AUTH_ZONEMGR_ERROR received error response from zone manager: %1
-A debug message output during the processing of a NOTIFY request.  The zone
+This is a debug message output during the processing of a NOTIFY
-manager component has been informed of the request, but has returned an
+request. The zone manager component has been informed of the request,
-error response (which is included in the message).  The NOTIFY request will
+but has returned an error response (which is included in the message). The
-not be honored.
+NOTIFY request will not be honored.
 
 

src/bin/auth/auth_srv.cc

@@ -425,14 +425,14 @@ AuthSrv::processMessage(const IOMessage& io_message, MessagePtr message,
         // Parse the message.
         message->fromWire(request_buffer);
     } catch (const DNSProtocolError& error) {
-        LOG_DEBUG(auth_logger, DBG_AUTH_DETAIL, AUTH_MESSAGE_PROTOCOL_ERROR)
+        LOG_DEBUG(auth_logger, DBG_AUTH_DETAIL, AUTH_PACKET_PROTOCOL_ERROR)
                   .arg(error.getRcode().toText()).arg(error.what());
         makeErrorMessage(message, buffer, error.getRcode(),
                          impl_->verbose_mode_);
         server->resume(true);
         return;
     } catch (const Exception& ex) {
-        LOG_DEBUG(auth_logger, DBG_AUTH_DETAIL, AUTH_MESSAGE_PARSE_ERROR)
+        LOG_DEBUG(auth_logger, DBG_AUTH_DETAIL, AUTH_PACKET_PARSE_ERROR)
                   .arg(ex.what());
         makeErrorMessage(message, buffer, Rcode::SERVFAIL(),
                          impl_->verbose_mode_);
@@ -440,7 +440,7 @@ AuthSrv::processMessage(const IOMessage& io_message, MessagePtr message,
         return;
     } // other exceptions will be handled at a higher layer.
 
-    LOG_DEBUG(auth_logger, DBG_AUTH_MESSAGES, AUTH_RESPONSE_RECEIVED)
+    LOG_DEBUG(auth_logger, DBG_AUTH_MESSAGES, AUTH_PACKET_RECEIVED)
               .arg(message->toText());
 
     // Perform further protocol-level validation.

src/bin/auth/main.cc

@@ -157,7 +157,7 @@ main(int argc, char* argv[]) {
 
         DNSService dns_service(io_service, checkin, lookup, answer);
         auth_server->setDNSService(dns_service);
-        LOG_DEBUG(auth_logger, DBG_AUTH_START, AUTH_DNSSERVICES_CREATED);
+        LOG_DEBUG(auth_logger, DBG_AUTH_START, AUTH_DNS_SERVICES_CREATED);
 
         cc_session = new Session(io_service.get_io_service());
         LOG_DEBUG(auth_logger, DBG_AUTH_START, AUTH_CONFIG_CHANNEL_CREATED);