[#1723] add debug levels to message documentation

Author: andrei-pavel

src/bin/agent/ca_messages.mes

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2022 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2016-2024 Internet Systems Consortium, Inc. ("ISC")
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -11,10 +11,12 @@ This informational message is issued when the CA successfully forwards
 the control message to the specified Kea service and receives a response.
 
 % CTRL_AGENT_COMMAND_FORWARD_BEGIN begin forwarding command %1 to service %2
+Logged at debug log level 10.
 This debug message is issued when the Control Agent starts forwarding a
 received command to one of the Kea servers.
 
 % CTRL_AGENT_COMMAND_FORWARD_FAILED failed forwarding command %1: %2
+Logged at debug log level 10.
 This debug message is issued when the Control Agent failed forwarding a
 received command to one of the Kea servers. The second argument provides
 the details of the error.
@@ -52,6 +54,7 @@ on the specified address and port. All control commands should be sent to this
 address and port.
 
 % CTRL_AGENT_RUN_EXIT application is exiting the event loop
+Logged at debug log level 0.
 This is a debug message issued when the Control Agent exits its
 event loop.
 

src/bin/dhcp4/dhcp4_messages.mes

@@ -11,6 +11,7 @@ This informational message is issued when the initial configuration
 was retrieved using NETCONF and successfully applied to Kea server.
 
 % NETCONF_CONFIG_CHANGED_DETAIL YANG configuration changed: %1
+Logged at debug log level 55.
 This debug message indicates a YANG configuration change. The format
 is the change operation (created, modified, deleted or moved) followed
 by xpaths and values of old and new nodes.
@@ -38,6 +39,7 @@ This is a fatal error message issued when kea-netconf
 got an unrecoverable error from within the event loop.
 
 % NETCONF_GET_CONFIG got configuration from %1 server: %2
+Logged at debug log level 55.
 This debug message indicates that kea-netconf got the configuration from a
 Kea server. The server name and the retrieved configuration are printed.
 
@@ -99,10 +101,12 @@ there may be other more unexpected causes as well.
 The server name, module name and the error are printed.
 
 % NETCONF_RUN_EXIT application is exiting the event loop
+Logged at debug log level 0.
 This is a debug message issued when kea-netconf exits its
 event loop. This is a normal step during kea-netconf shutdown.
 
 % NETCONF_SET_CONFIG set configuration to %1 server: %2
+Logged at debug log level 55.
 This debug message indicates that kea-netconf set the configuration to a
 Kea server. The server name and the applied configuration are printed.
 
@@ -137,6 +141,7 @@ This information message indicates that kea-netconf is trying to subscribe to
 notifications for a Kea server. The server name and module name are printed.
 
 % NETCONF_UPDATE_CONFIG updating configuration with %1 server: %2
+Logged at debug log level 55.
 This debug message indicates that kea-netconf update the configuration
 of a Kea server. The server name and the updated configuration are
 printed.
@@ -156,6 +161,7 @@ This informational message indicates that kea-netconf is trying to update the
 configuration of a Kea server.
 
 % NETCONF_VALIDATE_CONFIG validating configuration with %1 server: %2
+Logged at debug log level 55.
 This debug message indicates that kea-netconf is validating the configuration
 with a Kea server. The server name and the validated configuration are
 printed.

src/bin/dhcp6/dhcp6_messages.mes

@@ -1,6 +1,7 @@
-# Copyright (C) 2019-2020 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2019-2024 Internet Systems Consortium, Inc. ("ISC")
 
 % BOOTP_BOOTP_QUERY recognized a BOOTP query: %1
+Logged at debug log level 40.
 This debug message is printed when the BOOTP query was recognized. The
 BOOTP client class was added and the message type set to DHCPREQUEST.
 The query client and transaction identification are displayed.
@@ -9,12 +10,14 @@ The query client and transaction identification are displayed.
 This info message indicates that the Bootp hooks library has been loaded.
 
 % BOOTP_PACKET_OPTIONS_SKIPPED an error unpacking an option, caused subsequent options to be skipped: %1
+Logged at debug log level 40.
 A debug message issued when an option failed to unpack correctly, making it
 impossible to unpack the remaining options in the DHCPv4 query. The server
 will still attempt to service the packet. The sole argument provides a
 reason for unpacking error.
 
 % BOOTP_PACKET_PACK %1: preparing on-wire format of the packet to be sent
+Logged at debug log level 40.
 This debug message is issued when the server starts preparing the on-wire
 format of the packet to be sent back to the client. The argument specifies
 the client and the transaction identification information.
@@ -25,6 +28,7 @@ packet has failed. The first argument identifies the client and the
 BOOTP transaction.  The second argument includes the error string.
 
 % BOOTP_PACKET_UNPACK_FAILED failed to parse query from %1 to %2, received over interface %3, reason: %4
+Logged at debug log level 40.
 This debug message is issued when received DHCPv4 query is malformed and
 can't be parsed by the buffer4_receive callout. The query will be
 dropped by the server. The first three arguments specify source IP address,

src/bin/netconf/netconf_messages.mes

@@ -1,16 +1,18 @@
-# Copyright (C) 2019-2022 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2019-2024 Internet Systems Consortium, Inc. ("ISC")
 
 % FLEX_OPTION_LOAD_ERROR loading Flex Option hooks library failed: %1
 This error message indicates an error during loading the Flex Option
 hooks library. The details of the error are provided as argument of
 the log message.
 
 % FLEX_OPTION_PROCESS_ADD Added the option code %1 with value %2
+Logged at debug log level 40.
 This debug message is printed when an option was added into the response
 packet. The option code and the value (between quotes if printable, in
 hexadecimal if not) are provided.
 
 % FLEX_OPTION_PROCESS_CLIENT_CLASS Skip processing of the option code %1 for class '%2'
+Logged at debug log level 40.
 This debug message is printed when the processing for an option is skipped
 because the query does not belongs to the client class. The option code and
 the client class name are provided.
@@ -22,34 +24,41 @@ from the query and the details of the error are provided as arguments
 of the log message.
 
 % FLEX_OPTION_PROCESS_REMOVE Removed option code %1
+Logged at debug log level 40.
 This debug message is printed when an option was removed from the response
 packet. The option code is provided.
 
 % FLEX_OPTION_PROCESS_SUB_ADD Added the sub-option code %1 in option code %2 with value %3
+Logged at debug log level 40.
 This debug message is printed when an sub-option was added into the response
 packet. The sub-option and container option codes, and the value
 (between quotes if printable, in hexadecimal if not) are provided.
 
 % FLEX_OPTION_PROCESS_SUB_CLIENT_CLASS Skip processing of the sub-option code %1 in option code %2 for class '%3'
+Logged at debug log level 40.
 This debug message is printed when the processing for a sub-option is skipped
 because the query does not belongs to the client class. The sub-option and
 container option codes, and the client class name are provided.
 
 % FLEX_OPTION_PROCESS_SUB_REMOVE Removed sub-option code %1 in option code %2
+Logged at debug log level 40.
 This debug message is printed when a sub-option was removed from the response
 packet. The sub-option and container option codes are provided.
 
 % FLEX_OPTION_PROCESS_SUB_SUPERSEDE Supersedes the sub-option code %1 in option code %2 with value %3
+Logged at debug log level 40.
 This debug message is printed when a sub-option was superseded into the
 response packet. The sub-option and container option codes, and the value
 (between quotes if printable, in hexadecimal if not) are provided.
 
 % FLEX_OPTION_PROCESS_SUPERSEDE Supersedes the option code %1 with value %2
+Logged at debug log level 40.
 This debug message is printed when an option was superseded into the response
 packet. The option code and the value (between quotes if printable, in
 hexadecimal if not) are provided.
 
 % FLEX_OPTION_PROCESS_VENDOR_ID_MISMATCH Skip processing of vendor option code %1 with vendor id %2 not matching wanted %3
+Logged at debug log level 40.
 This debug message is printed when a sub-option of a vendor option is
 processed but vendor ids do not match. The code of the vendor option
 and the two vendor ids are provided.

src/hooks/dhcp/bootp/bootp_messages.mes

@@ -8,6 +8,7 @@ point failed.  This may occur as a result of an internal server error.
 The argument contains a reason for the error.
 
 % HA_BUFFER4_RECEIVE_NOT_FOR_US %1: dropping query to be processed by another server
+Logged at debug log level 40.
 This debug message is issued when the received DHCPv4 query is dropped
 by this server because it should be served by another server. This
 is the case when the remote server was designated to process the packet
@@ -16,12 +17,14 @@ hot standby configuration. The argument provides client identification
 information retrieved from the query.
 
 % HA_BUFFER4_RECEIVE_PACKET_OPTIONS_SKIPPED an error unpacking an option, caused subsequent options to be skipped: %1
+Logged at debug log level 40.
 A debug message issued when an option failed to unpack correctly, making it
 impossible to unpack the remaining options in the DHCPv4 query. The server
 will still attempt to service the packet. The sole argument provides a
 reason for unpacking error.
 
 % HA_BUFFER4_RECEIVE_UNPACK_FAILED failed to parse query from %1 to %2, received over interface %3, reason: %4
+Logged at debug log level 40.
 This debug message is issued when received DHCPv4 query is malformed and
 can't be parsed by the buffer4_receive callout. The query will be
 dropped by the server. The first three arguments specify source IP address,
@@ -34,6 +37,7 @@ point failed. This may occur as a result of an internal server error.
 The argument contains a reason for the error.
 
 % HA_BUFFER6_RECEIVE_NOT_FOR_US %1: dropping query to be processed by another server
+Logged at debug log level 40.
 This debug message is issued when the received DHCPv6 query is dropped
 by this server because it should be served by another server. This
 is the case when the remote server was designated to process the packet
@@ -42,12 +46,14 @@ hot standby configuration. The argument provides client identification
 information retrieved from the query.
 
 % HA_BUFFER6_RECEIVE_PACKET_OPTIONS_SKIPPED an error unpacking an option, caused subsequent options to be skipped: %1
+Logged at debug log level 40.
 A debug message issued when an option failed to unpack correctly, making it
 impossible to unpack the remaining options in the DHCPv6 query. The server
 will still attempt to service the packet. The sole argument provides a
 reason for unpacking error.
 
 % HA_BUFFER6_RECEIVE_UNPACK_FAILED failed to parse query from %1 to %2, received over interface %3, reason: %4
+Logged at debug log level 40.
 This debug message is issued when received DHCPv6 query is malformed and
 can't be parsed by the buffer6_receive callout. The query will be
 dropped by the server. The first three arguments specify source IP address,
@@ -281,6 +287,7 @@ the callout by the DHCP server (unlikely internal server error).
 The argument contains a reason for the error.
 
 % HA_LEASES4_COMMITTED_NOTHING_TO_UPDATE %1: leases4_committed callout was invoked without any leases
+Logged at debug log level 40.
 This debug message is issued when the "leases4_committed" callout returns
 because there are neither new leases nor deleted leases for which updates
 should be sent. The sole argument specifies the details of the client
@@ -300,6 +307,7 @@ the callout by the DHCP server (unlikely internal server error).
 The argument contains a reason for the error.
 
 % HA_LEASES6_COMMITTED_NOTHING_TO_UPDATE %1: leases6_committed callout was invoked without any leases
+Logged at debug log level 40.
 This debug message is issued when the "leases6_committed" callout returns
 because there are neither new leases nor deleted leases for which updates
 should be sent. The sole argument specifies the details of the client
@@ -377,6 +385,7 @@ provided as a first argument. The third argument provides a reason for
 the failure.
 
 % HA_LEASE_SYNC_STALE_LEASE4_SKIP %1: skipping stale lease %2 in subnet %3
+Logged at debug log level 40.
 This debug message is issued during lease database synchronization, when
 fetched IPv4 lease instance appears to be older than the instance in the
 local database. The newer instance is left in the database and the fetched
@@ -386,6 +395,7 @@ specifies the local server's name. The second argument specifies leased
 address. The third argument specifies a subnet to which the lease belongs.
 
 % HA_LEASE_SYNC_STALE_LEASE6_SKIP %1: skipping stale lease %2 in subnet %3
+Logged at debug log level 40.
 This debug message is issued during lease database synchronization, when
 fetched IPv6 lease instance appears to be older than the instance in the
 local database. The newer instance is left in the database and the fetched
@@ -440,12 +450,14 @@ by the partner exceeds the limit set with max-rejected-lease-updates
 configuration parameter.
 
 % HA_LOAD_BALANCING_DUID_MISSING %1: load balancing failed for the DHCPv6 message (transaction id: %2) because DUID is missing
+Logged at debug log level 40.
 This debug message is issued when the HA hook library was unable to load
 balance an incoming DHCPv6 query because neither client identifier nor
 HW address was included in the query. The query will be dropped. The
 sole argument contains transaction id.
 
 % HA_LOAD_BALANCING_IDENTIFIER_MISSING %1: load balancing failed for the DHCPv4 message (transaction id: %2) because HW address and client identifier are missing
+Logged at debug log level 40.
 This debug message is issued when the HA hook library was unable to load
 balance an incoming DHCPv4 query because neither client identifier nor
 HW address was included in the query. The query will be dropped. The
@@ -622,6 +634,7 @@ The first argument is the client identification information. The second argument
 is a subnet prefix.
 
 % HA_SUBNET4_SELECT_NOT_FOR_US %1: dropping query in relationship %2 to be processed by another server
+Logged at debug log level 40.
 This debug message is issued when the received DHCPv4 query is dropped
 by this server because it should be served by another server. This
 is the case when a remote primary server is operational. The first argument
@@ -648,6 +661,7 @@ the client identification information. The second argument is a subnet
 prefix.
 
 % HA_SUBNET4_SELECT_NO_SUBNET_SELECTED %1: unable to determine HA relationship because no subnet has been selected for the client
+Logged at debug log level 40.
 This debug message is issued when the received DHCPv4 query is dropped
 by this server because it could not select a subnet for this client.
 Selecting the subnet is required to find a suitable HA relationship.
@@ -667,6 +681,7 @@ The first argument is the client identification information. The second argument
 is a subnet prefix.
 
 % HA_SUBNET6_SELECT_NOT_FOR_US %1: dropping query in relationship %2 to be processed by another server
+Logged at debug log level 40.
 This debug message is issued when the received DHCPv6 query is dropped
 by this server because it should be served by another server. This
 is the case when a remote primary server is operational. The first argument
@@ -693,6 +708,7 @@ the client identification information. The second argument is a subnet
 prefix.
 
 % HA_SUBNET6_SELECT_NO_SUBNET_SELECTED %1: unable to determine HA relationship because no subnet has been selected for the client
+Logged at debug log level 40.
 This debug message is issued when the received DHCPv6 query is dropped
 by this server because it could not select a subnet for this client.
 Selecting the subnet is required to find a suitable HA relationship.

src/hooks/dhcp/flex_option/flex_option_messages.mes

@@ -1,6 +1,7 @@
 # Copyright (C) 2017-2024 Internet Systems Consortium, Inc. ("ISC")
 
 % LEASE_CMDS_ADD4 lease4-add command successful (address: %1)
+Logged at debug log level 20.
 The lease4-add command has been successful. Lease IPv4 address
 is logged.
 
@@ -14,6 +15,7 @@ The lease4-add command has failed. Both the reason as well as the
 parameters passed are logged.
 
 % LEASE_CMDS_ADD6 lease6-add command successful (address: %1)
+Logged at debug log level 20.
 The lease6-add command has been successful. Lease IPv6 address
 is logged.
 
@@ -27,6 +29,7 @@ The lease6-add command has failed. Both the reason as well as the
 parameters passed are logged.
 
 % LEASE_CMDS_BULK_APPLY6 lease6-bulk-apply command successful (applied addresses count: %1)
+Logged at debug log level 20.
 The lease6-bulk-apply command has been successful. The number of applied
 addresses is logged.
 
@@ -44,6 +47,7 @@ This info message indicates that the Lease Commands hooks library has been
 removed successfully.
 
 % LEASE_CMDS_DEL4 lease4-del command successful (address: %1)
+Logged at debug log level 20.
 The attempt to delete an IPv4 lease (lease4-del command) has been successful.
 Lease IPv4 address is logged.
 
@@ -52,6 +56,7 @@ The attempt to delete an IPv4 lease (lease4-del command) has failed. Both the
 reason as well as the parameters passed are logged.
 
 % LEASE_CMDS_DEL6 lease4-del command successful (address: %1)
+Logged at debug log level 20.
 The attempt to delete an IPv4 lease (lease4-del command) has been successful.
 Lease IPv6 address is logged.
 
@@ -93,6 +98,7 @@ A request to update DNS for the requested IPv6 lease has failed.  The
 reason for the failure is logged.
 
 % LEASE_CMDS_UPDATE4 lease4-update command successful (address: %1)
+Logged at debug log level 20.
 The lease4-update command has been successful. Lease IPv4 address
 is logged.
 
@@ -107,6 +113,7 @@ The lease4-update command has failed. Both the reason as well as the
 parameters passed are logged.
 
 % LEASE_CMDS_UPDATE6 lease6-update command successful (address: %1)
+Logged at debug log level 20.
 The lease6-update command has been successful. Lease IPv6 address
 is logged.