From 5193c342e5de92d889d3aa52263abe97e4328677 Mon Sep 17 00:00:00 2001 From: Marcin Siodelski Date: Wed, 6 Jun 2018 20:05:12 +0200 Subject: [PATCH] [5622] Updated list of loggers. --- doc/guide/logging.xml | 390 ++++++------------------------------------ 1 file changed, 57 insertions(+), 333 deletions(-) diff --git a/doc/guide/logging.xml b/doc/guide/logging.xml index e92009f9a9..577fa0b294 100644 --- a/doc/guide/logging.xml +++ b/doc/guide/logging.xml @@ -169,341 +169,71 @@ - Currently defined loggers are: + Currently defined loggers are defined in the following table. The + "Software Package" column of this table specifies whether the particular + loggers belong to the core Kea code (open source Kea binaries and + libraries), or hook libraries (open source or premium). - - - - kea-ctrl-agent - the root logger for the - Control Agent exposing RESTful control API. All components used - by the Control Agent inherit the settings from this logger. - - - - - - kea-ctrl-agent.http - a logger which outputs - log messages related to receiving, parsing and sending HTTP - messages. - - - - - - kea-dhcp4 - the root logger for the DHCPv4 - server. All components used by the DHCPv4 server inherit the - settings from this logger. - - - - - - kea-dhcp4.alloc-engine - used by the lease - allocation engine, which is responsible for managing leases in the - lease database, i.e. create, modify and remove DHCPv4 leases as a - result of processing messages from the clients. - - - - - - kea-dhcp4.bad-packets - used by the DHCPv4 - server daemon 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.callouts - used to log messages - pertaining to the callouts registration and execution for the - particular hook point. - - - - - - kea-dhcp4.commands - used to log messages - relating to the handling of commands received by the the DHCPv4 - server over the command channel. - - - - - - kea-dhcp4.ddns - used by the DHCPv4 server to - log messages related to the Client FQDN and Hostname option - processing. It also includes log messages related to the relevant - DNS updates. - - - - - - kea-dhcp4.dhcp4 - used by the DHCPv4 server - daemon to log basic operations. - - - - - - kea-dhcp4.dhcpsrv - the base logger for the - libdhcpsrv library. - - - - - - kea-dhcp4.eval - used to log messages relating - to the client classification expression evaluation code. - - - - - - kea-dhcp4.hooks - used 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 DHCPv4 - server. - - - - - - kea-dhcp4.hosts - used within the libdhcpsrv - and it logs messages related to the management of the DHCPv4 host - reservations, i.e. retrieval of the reservations and adding new - reservations. - - - - - - kea-dhcp4.leases - used by the DHCPv4 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.options - used by the DHCPv4 server - to log messages related to processing of the options in the DHCPv4 - messages, i.e. parsing options, encoding options into on-wire - format and packet classification using options contained in the - received packets. - - - - - - kea-dhcp4.packets - this logger is mostly used - to log messages related to transmission of the DHCPv4 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 and/or interface names, which - can be retrieved from the received packet, even before the DHCPv4 - message carried in the packet is parsed. - - - - - - kea-dhcp4.stat-cmds-hooks - this logger is - used to log messages related to 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-dhcp6 - the root logger for the DHCPv6 - server. All components used by the DHCPv6 server inherit the - settings from this logger if there is no specialized logger - provided. - - - - - - kea-dhcp6.alloc-engine - used used by the lease - allocation engine, which is responsible for managing leases in the - lease database, i.e. create, modify and remove DHCPv6 leases as a - result of processing messages from the clients. - - - - - kea-dhcp6.bad-packets - used used by the DHCPv6 - server daemon for logging inbound client packets that were - dropped. - - - - - - kea-dhcp6.callouts - used to log messages - pertaining to the callouts registration and execution for the - particular hook point. - - - - - - kea-dhcp6.commands - used to log messages - relating to the handling of commands received by the the DHCPv6 - server over the command channel. - - - - - - kea-dhcp6.ddns - this logger is used by the - DHCPv6 server to log messages related to the Client FQDN option - processing. It also includes log messages related to the relevant - DNS updates. - - - - - - kea-dhcp6.dhcp6 - used DHCPv6 server daemon to - log basic operations. - - - - - - kea-dhcp6.dhcpsrv - the base logger for the - libdhcpsrv library. - - - - - - kea-dhcp6.eval - used to log messages relating - to the client classification expression evaluation code. - - - - - - kea-dhcp6.hooks - this logger is used 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 DHCPv6 server. - - - - - - kea-dhcp6.hosts - used within the libdhcpsrv - and it logs messages related to the management of the DHCPv6 host - reservations, i.e. retrieval of the reservations and adding new - reservations. - - - - - - kea-dhcp6.leases - used by the DHCPv6 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-dhcp6.options - used by the DHCPv6 server - to log messages related to processing of the options in the DHCPv6 - messages, i.e. parsing options, encoding options into on-wire - format and packet classification using options contained in the - received packets. - - - - - - kea-dhcp6.packets - this logger is mostly used - to log messages related to transmission of the DHCPv6 packets, - i.e. packet reception and sending a response. Such messages - include the information about the source and destination IP - addresses and interfaces used to transmit packets. This logger is - also used to log messages related to subnet selection, as this - selection is usually based on the IP addresses and/or interface - names, which can be retrieved from the received packet, even - before the DHCPv6 message carried in the packet is parsed. - - - - - - kea-dhcp6.stat-cmds-hooks - this logger is - used to log messages related to 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-dhcp-ddns - the 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-dhcp-ddns.dctl - the logger used by the - kea-dhcp-ddns daemon for logging basic information about the - process, received signals and triggered reconfigurations. - - - - - - kea-dhcp-ddns.dhcpddns - the logger used by the - kea-dhcp-ddns daemon for logging events related to DDNS operations. - - - - - - kea-dhcp-ddns.dhcp-to-d2 - used 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. - - - - - - kea-dhcp-ddns.d2-to-dns - used by the - kea-dhcp-ddns daemon for logging information about events dealing - with sending and receiving messages with the DNS servers. - - - + + + List of loggers supported by Kea servers and hooks libraries + shipped with Kea and premium packages + + + + + + + Logger Name + Software Package + Description + + + + kea-ctrl-agentcoreThe root logger for the Control Agent exposing RESTful control API. All components used by the Control Agent inherit the settings from this logger. + 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.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 the DHCP server over the command channel. + kea-dhcp4.ddnskea-dhcp6.ddnscoreUsed by the DHCP server to log messages related to the Client FQDN and Hostname option processing. It also includes log messages related to the relevant DNS updates. + kea-dhcp4.dhcp4coreUsed by the DHCPv4 server daemon to log basic operations. + kea-dhcp4.dhcpsrvkea-dhcp6.dhcpsrvcoreThe base loggers for the libkea-dhcpsrv library. + kea-dhcp4.evalkea-dhcp6.evalcoreUsed to log messages relating to the client classification expression evaluation code. + kea-dhcp4.host-cache-hookskea-dhcp6.host-cache-hookslibdhcp_host_cache premium hook libraryThis logger is used to log messages related to 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 operation of the Flexible Identifiers Hook Library. + kea-dhcp4.ha-hookskea-dhcp6.ha-hookslibdhcp_ha premium hook libraryThis logger is used to log messages related to 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 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.hostskea-dhcp6.hostscoreUsed within the libdhcpsrv and 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 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.legal-log-hookskea-dhcp6.legal-log-hookslibdhcp_legal_log premium hook libraryThis logger is used to log messages related to 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.radius-hookskea-dhcp6.radius-hookslibdhcp_radius premium hook libraryThis logger is used to log messages related to 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 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 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-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. + kea-dhcp-ddns.d2-to-dnscoreUsed by the kea-dhcp-ddns daemon for logging information about events dealing with sending and receiving messages with the DNS servers. + + +
+ Note that user-defined hook libraries should not use any of those loggers but should define new loggers with names that correspond to the libraries using them. Suppose that the user created the library - called libpacket-capture to dump packets received and + called libdhcp-packet-capture to dump packets received and transmitted by the server to the file. The appropriate name for the - logger could be kea-dhcp4.packet-capture. (Note + logger could be kea-dhcp4.packet-capture-hooks. (Note that the hook library implementor only specifies the second part of this name, i.e. packet-capture. The first part is a root logger name and is prepended by the Kea logging system.) It is @@ -512,12 +242,6 @@ that can be overridden by an entry in the configuration file. - - The list of loggers above excludes any loggers implemented in hooks - libraries. Please consult the documentation for the libraries for the - names of the loggers they define. - - Additional loggers may be defined in future versions of Kea. The easiest way to find out the logger name is to configure all logging to -- 2.47.2