From: Suzanne Goldlust Date: Thu, 31 Jan 2019 16:27:34 +0000 (-0500) Subject: Update logging.xml X-Git-Tag: 481-remote-subnet4-set-inconsistent-work-when-id-subnet-is-duplicated_base~25 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bdbf523e4ff0bc8fc42250a9fbfe0dce4c0defe9;p=thirdparty%2Fkea.git Update logging.xml --- diff --git a/doc/guide/logging.xml b/doc/guide/logging.xml index 4e0a2094a2..e93ed45722 100644 --- a/doc/guide/logging.xml +++ b/doc/guide/logging.xml @@ -14,8 +14,8 @@ Logging Configuration During its operation Kea may produce many messages. They differ in - severity (some are more important than others) and source (some are - produced by specific components, e.g. hooks). It is useful to understand + severity (some are more important than others) and source (different components + (e.g. hooks) produce different messages). It is useful to understand which log messages are critical and which are not, and configure your logging appropriately. For example, debug-level messages can be safely ignored in a typical deployment. They are, however, very useful when @@ -41,7 +41,7 @@ processes, may use multiple loggers to log messages pertaining to different logical functions of the component. For example, the DHCPv4 server uses one logger for messages - pertaining to packet reception and transmission, another + about packet reception and transmission, another logger for messages related to lease allocation, and so on. Some of the libraries used by the Kea server, e.g. libdhcpsrv, use their own loggers. @@ -55,7 +55,7 @@ messages produced by the hooks library can be distinguished from messages issued by the core Kea code. Unique names also allow the loggers to be configured independently of loggers used - by Kea. Whenever it makes sense, a hook library can use multiple + by Kea. Whenever it makes sense, a hooks library can use multiple loggers to log messages pertaining to different logical parts of the library. @@ -65,7 +65,7 @@ configuration for zero or more loggers (including loggers used by the proprietary hooks libraries). If there are no loggers specified, the code will use default values; these cause Kea to log messages of INFO - severity or greater to standard output. There is also a small + severity or greater to standard output. There is a small time window after Kea has been started but before it has read its configuration; logging in this short period can be controlled using environment variables. For details, see . @@ -162,10 +162,11 @@ that might match a particular logger, the specification with the more specific logger name takes precedence. For example, if there are entries for both kea-dhcp4 and - kea-dhcp4.dhcpsrv, the DHCPv4 server — and all - libraries it uses that are not dhcpsrv — will log messages + kea-dhcp4.dhcpsrv, the main DHCPv4 server program — and all + libraries it uses other than the dhcpsrv library (libdhcpsrv) — will log messages according to the configuration in the first entry - (kea-dhcp4). + (kea-dhcp4). Messages generated by the dhcpsrv library + will be logged according to the configuration set by the second entry. @@ -195,7 +196,7 @@ kea-ctrl-agent.httpcoreA logger which outputs log messages related to receiving, parsing, and sending HTTP messages. kea-dhcp4coreThe root logger for the DHCPv4 server. All components used by the DHCPv4 server inherit the settings from this logger. kea-dhcp6coreThe root logger for the DHCPv6 server. All components used by the DHCPv6 server inherit the settings from this logger. - kea-dhcp4.alloc-enginekea-dhcp6.alloc-enginecoreUsed by the lease allocation engine, which is responsible for managing leases in the lease database, i.e. create, modify, and remove DHCP leases as a result of processing messages from the clients. + kea-dhcp4.alloc-enginekea-dhcp6.alloc-enginecoreUsed by the lease allocation engine, which is responsible for managing leases in the lease database, i.e. creating, modifying, and removing DHCP leases as a result of processing messages from the clients. kea-dhcp4.bad-packetskea-dhcp6.bad-packetscoreUsed by the DHCP servers for logging inbound client packets that were dropped or to which the server responded with a DHCPNAK. It allows administrators to configure a separate log output that contains only packet drop and reject entries. kea-dhcp4.calloutskea-dhcp6.calloutscoreUsed to log messages pertaining to the callouts registration and execution for the particular hook point. kea-dhcp4.commandskea-dhcp6.commandscoreUsed to log messages relating to the handling of commands received by the DHCP server over the command channel. @@ -207,18 +208,18 @@ kea-dhcp4.host-cache-hookskea-dhcp6.host-cache-hookslibdhcp_host_cache premium hook libraryThis logger is used to log messages related to the operation of the Host Cache Hook Library. kea-dhcp4.flex-id-hookskea-dhcp6.flex-id-hookslibdhcp_flex_id premium hook libraryThis logger is used to log messages related to the operation of the Flexible Identifiers Hook Library. kea-dhcp4.ha-hookskea-dhcp6.ha-hookslibdhcp_ha hook libraryThis logger is used to log messages related to the operation of the High Availability Hook Library. - kea-dhcp4.hookskea-dhcp6.hookscoreUsed to log messages related to management of hooks libraries, e.g. registration and deregistration of the libraries, and to the initialization of the callouts execution for various hook points within the DHCP server. - kea-dhcp4.host-cmds-hookskea-dhcp6.host-cmds-hookslibdhcp_host_cmds premium hook libraryThis logger is used to log messages related to the operation of the Host Cmds hooks library. In general, these will pertain to loading and unloading the library and the execution of commands by the library. + kea-dhcp4.hookskea-dhcp6.hookscoreUsed to log messages related to the management of hooks libraries, e.g. registration and deregistration of the libraries, and to the initialization of the callouts execution for various hook points within the DHCP server. + kea-dhcp4.host-cmds-hookskea-dhcp6.host-cmds-hookslibdhcp_host_cmds premium hook libraryThis logger is used to log messages related to the operation of the Host Cmds hooks library. In general, these will pertain to the loading and unloading of the library and the execution of commands by the library. kea-dhcp4.hostskea-dhcp6.hostscoreUsed within the libdhcpsrv, it logs messages related to the management of the DHCP host reservations, i.e. retrieval of the reservations and adding new reservations. - kea-dhcp4.lease-cmds-hookskea-dhcp6.lease-cmds-hookslibdhcp_lease_cmds hook libraryThis logger is used to log messages related to the operation of the Lease Cmds hooks library. In general, these will pertain to loading and unloading the library and the execution of commands by the library. - kea-dhcp4.leaseskea-dhcp6.leasescoreUsed by the DHCP server to log messages related to the lease allocation. The messages include detailed information about the allocated or offered leases, errors during the lease allocation, etc. + kea-dhcp4.lease-cmds-hookskea-dhcp6.lease-cmds-hookslibdhcp_lease_cmds hook libraryThis logger is used to log messages related to the operation of the Lease Cmds hooks library. In general, these will pertain to the loading and unloading of the library and the execution of commands by the library. + kea-dhcp4.leaseskea-dhcp6.leasescoreUsed by the DHCP server to log messages related to lease allocation. The messages include detailed information about the allocated or offered leases, errors during the lease allocation, etc. kea-dhcp4.legal-log-hookskea-dhcp6.legal-log-hookslibdhcp_legal_log premium hook libraryThis logger is used to log messages related to the operation of the Forensic Logging Hooks Library. - kea-dhcp4.optionskea-dhcp4.optionscoreUsed by the DHCP server to log messages related to processing of the options in the DHCP messages, i.e. parsing options, encoding options into on-wire format, and packet classification using options contained in the received packets. - kea-dhcp4.packetskea-dhcp6.packetscoreThis logger is mostly used to log messages related to transmission of the DHCP packets, i.e. packet reception and sending a response. Such messages include information about the source and destination IP addresses and interfaces used to transmit packets. The logger is also used to log messages related to subnet selection, as this selection is usually based on the IP addresses, relay addresses, and/or interface names, which can be retrieved from the received packet even before the DHCP message carried in the packet is parsed. + kea-dhcp4.optionskea-dhcp4.optionscoreUsed by the DHCP server to log messages related to the processing of options in the DHCP messages, i.e. parsing options, encoding options into on-wire format, and packet classification using options contained in the received packets. + kea-dhcp4.packetskea-dhcp6.packetscoreThis logger is mostly used to log messages related to transmission of the DHCP packets, i.e. packet reception and the sending of a response. Such messages include information about the source and destination IP addresses and interfaces used to transmit packets. The logger is also used to log messages related to subnet selection, as this selection is usually based on the IP addresses, relay addresses, and/or interface names, which can be retrieved from the received packet even before the DHCP message carried in the packet is parsed. kea-dhcp4.radius-hookskea-dhcp6.radius-hookslibdhcp_radius premium hook libraryThis logger is used to log messages related to the operation of the Radius Hook Library. - kea-dhcp4.stat-cmds-hookskea-dhcp6.stat-cmds-hookslibdhcp_stat_cmds hook libraryThis logger is used to log messages related to the operation of the Stats Cmds hooks library. In general, these will pertain to loading and unloading the library and the execution of commands by the library. - kea-dhcp4.subnet-cmds-hookskea-dhcp6.subnet-cmds-hookslibdhcp_subnet_cmds hook libraryThis logger is used to log messages related to the operation of the Subnet Cmds hooks library. In general, these will pertain to loading and unloading the library and the execution of commands by the library. - kea-dhcp-ddnscoreThe root logger for the kea-dhcp-ddns daemon. All components used by this daemon inherit the settings from this logger if there is no specialized logger provided. + kea-dhcp4.stat-cmds-hookskea-dhcp6.stat-cmds-hookslibdhcp_stat_cmds hook libraryThis logger is used to log messages related to the operation of the Statistics Commands hooks library. In general, these will pertain to loading and unloading the library and the execution of commands by the library. + kea-dhcp4.subnet-cmds-hookskea-dhcp6.subnet-cmds-hookslibdhcp_subnet_cmds hook libraryThis logger is used to log messages related to the operation of the Subnet Commands hooks library. In general, these will pertain to loading and unloading the library and the execution of commands by the library. + kea-dhcp-ddnscoreThe root logger for the kea-dhcp-ddns daemon. All components used by this daemon inherit the settings from this logger unless there are configurations for more specialized loggers.. kea-dhcp-ddns.dctlcoreThe logger used by the kea-dhcp-ddns daemon for logging basic information about the process, received signals, and triggered reconfigurations. kea-dhcp-ddns.dhcpddnscoreThe logger used by the kea-dhcp-ddns daemon for logging events related to DDNS operations. kea-dhcp-ddns.dhcp-to-d2coreUsed by the kea-dhcp-ddns daemon for logging information about events dealing with receiving messages from the DHCP servers and adding them to the queue for processing. @@ -229,8 +230,8 @@ - Note that user-defined hook libraries should not use any of those - loggers, but should define new loggers with names that correspond to + Note that user-defined hook libraries should not use any of the loggers + mentioned above, but should define new loggers with names that correspond to the libraries using them. Suppose that the user created the library called libdhcp-packet-capture to dump packets received and transmitted by the server to the file. An appropriate name for the