mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 05:55:28 +00:00
Code Issues Releases Wiki Activity

[#2554] add missing loggers

Browse Source
This commit is contained in:
Andrei Pavel
2023-06-06 16:49:08 +03:00
parent aaa3a91b9b
commit 0bd79fcf79
1 changed files with 408 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

244
doc/sphinx/arm/logging.rst
View File

@@ -134,9 +134,9 @@ libraries), or hook libraries (open source or premium).
:class: longtable
:widths: 20 20 60
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| Logger Name | Software Package | Description |
+==================================+========================+================================+
+==================================+=======================================+================================+
| ``kea-ctrl-agent`` | core | The root logger for |
| | | the Control Agent |
| | | exposing the RESTful |
@@ -145,32 +145,43 @@ libraries), or hook libraries (open source or premium).
| | | the Control Agent |
| | | inherit the settings |
| | | from this logger. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.auth`` | core | A logger which covers |
| | | access control details, such as|
| | | a result of the basic HTTP |
| | | authentication. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.ctrl-agent`` | core | Used to log results of |
| | | configuration checks, |
| | | information about services |
| | | starting or failing to start, |
| | | command receival and |
| | | forwarding. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.http`` | core | A logger which |
| | | outputs log messages |
| | | related to receiving, |
| | | parsing, and sending |
| | | HTTP messages. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.rbac-hooks`` | :ischooklib:`libca_rbac.so` | Used to log messages related |
| | enterprise hook library | to the operation of the RBAC |
| | | hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4`` | core | The root logger for |
| | | the DHCPv4 server. |
| | | All components used |
| | | by the DHCPv4 server |
| | | inherit the settings |
| | | from this logger. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp6`` | core | The root logger for |
| | | the DHCPv6 server. |
| | | All components used |
| | | by the DHCPv6 server |
| | | inherit the settings |
| | | from this logger. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.alloc-engine``, | core | Used by the lease |
| ``kea-dhcp6.alloc-engine`` | | allocation engine, |
| | | which is responsible |
@@ -182,7 +193,11 @@ libraries), or hook libraries (open source or premium).
| | | leases as a result of |
| | | processing messages |
| | | from clients. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.auth``, | core | Used to log malformed HTTP |
| ``kea-dhcp4.auth``, | | packets when using basic |
| ``kea-dhcp6.auth`` | | authentication. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.bad-packets``, | core | Used by the DHCP |
| ``kea-dhcp6.bad-packets`` | | servers for logging |
| | | inbound client |
@@ -196,31 +211,44 @@ libraries), or hook libraries (open source or premium).
| | | that contains only |
| | | packet drop and |
| | | reject entries. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.bootp-hooks`` | libdhcp_bootp | This logger is used to log |
| | hook library | messages related to the |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.bootp-hooks`` | :ischooklib:`libdhcp_bootp.so` | This logger is used to log |
| | open-source hook library | messages related to the |
| | | operation of the BOOTP hook |
| | | library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.callouts``, | core | Used to log messages |
| ``kea-dhcp6.callouts`` | | pertaining to the |
| | | callouts registration |
| | | and execution for the |
| | | particular hook |
| | | point. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.callouts``, | core | Used to log messages |
| ``kea-dhcp4.callouts``, | | pertaining to the |
| ``kea-dhcp6.callouts``, | | callouts registation and |
| ``kea-dhcp-ddns.callouts`` | | execution for a particular |
| | | hook point. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.cb-cmds-hooks``, | :ischooklib:`libdhcp_cb_cmds.so` | Used to log messages related |
| ``kea-dhcp6.cb-cmds-hooks`` | subscription hook library | to the operation of the |
| | | Config Backend Commands |
| | | hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.class-cmds-hooks``, | :ischooklib:`libdhcp_class_cmds.so` | Used to log messages related |
| ``kea-dhcp6.class-cmds-hooks`` | subscription hook library | to the operation of the |
| | | Class Commands |
| | | hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.commands``, | core | Used to log messages |
| ``kea-dhcp6.commands`` | | relating to the |
| | | handling of commands |
| | | received by the DHCP |
| | | server over the |
| | | command channel. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.database``, | core | Used to log messages |
| ``kea-dhcp6.database`` | | relating to general |
| | | operations on the |
| | | relational databases. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.ddns-tuning-hooks``, | :ischooklib:`libdhcp_ddns_tuning.so` | Used to log messages related |
| ``kea-dhcp6.ddns-tuning-hooks`` | premium hook library | to the operation of the |
| | | DDNS Tuning hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.ddns``, | core | Used by the DHCP |
| ``kea-dhcp6.ddns`` | | server to log |
| | | messages related to |
@@ -230,46 +258,43 @@ libraries), or hook libraries (open source or premium).
| | | includes log messages |
| | | related to the |
| | | relevant DNS updates. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.dhcp4`` | core | Used by the DHCPv4 |
| | | server daemon to log |
| | | basic operations. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.dhcpsrv``, | core | The base loggers for |
| ``kea-dhcp6.dhcpsrv`` | | the ``libkea-dhcpsrv`` |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.dhcp4``, | core | Used to log basic operations. |
| ``kea-dhcp6.dhcp6`` | | |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.dhcpsrv``, | core | The base loggers for the |
| ``kea-dhcp6.dhcpsrv`` | | :ischooklib:`libkea-dhcpsrv` |
| | | library. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.eval``, | core | Used to log messages |
| ``kea-dhcp6.eval`` | | relating to the |
| | | client classification |
| | | expression evaluation |
| | | code. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.host-cache-hooks``, | libdhcp_host_cache | Used |
| ``kea-dhcp6.host-cache-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the Host |
| | | Cache hook library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.flex-id-hooks``, | libdhcp_flex_id | Used |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.flex-id-hooks``, | :ischooklib:`libdhcp_flex_id.so` | Used |
| ``kea-dhcp6.flex-id-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Flexible Identifier |
| | | hook library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.ha-hooks``, | libdhcp_ha hook | Used |
| ``kea-dhcp6.ha-hooks`` | library | to log messages |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.flex-option-hooks``, | :ischooklib:`libdhcp_flex_option.so` | Used to log messages related |
| ``kea-dhcp6.flex-option-hooks`` | open-source hook library | to the operaton of |
| | | the Flexible Option |
| | | hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.ha-hooks``, | :ischooklib:`libdhcp_ha.so` | Used |
| ``kea-dhcp6.ha-hooks`` | open-source hook library | to log messages |
| | | related to the |
| | | operation of the High |
| | | Availability hook |
| | | library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.hooks``, | core | Used to log messages |
| ``kea-dhcp6.hooks`` | | related to the |
| | | management of hook |
| | | libraries, e.g. |
| | | registration and |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.hooks``, | core | Used to log messages related |
| ``kea-dhcp4.hooks``, | | to the maagemet of hook |
| ``kea-dhcp6.hooks``, | | libraries, e.g. |
| ``kea-dhcp-ddns.hooks`` | | registatin and |
| | | deregistration of the |
| | | libraries, and to the |
| | | initialization of the |
@@ -277,8 +302,14 @@ libraries), or hook libraries (open source or premium).
| | | for various hook |
| | | points within the |
| | | DHCP server. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.host-cmds-hooks``, | libdhcp_host_cmds | Used |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.host-cache-hooks``, | :ischooklib:`libdhcp_host_cache.so` | Used |
| ``kea-dhcp6.host-cache-hooks`` | subscription hook library | to log messages |
| | | related to the |
| | | operation of the Host |
| | | Cache hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.host-cmds-hooks``, | :ischooklib:`libdhcp_host_cmds.so` | Used |
| ``kea-dhcp6.host-cmds-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the Host |
@@ -290,7 +321,7 @@ libraries), or hook libraries (open source or premium).
| | | library and the |
| | | execution of commands |
| | | by the library. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.hosts``, | core | Used within |
| ``kea-dhcp6.hosts`` | | ``libdhcpsrv``, it logs |
| | | messages related to |
@@ -301,9 +332,9 @@ libraries), or hook libraries (open source or premium).
| | | reservations and |
| | | adding new |
| | | reservations. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.lease-cmds-hooks``, | libdhcp_lease_cmds | Used |
| ``kea-dhcp6.lease-cmds-hooks`` | hook library | to log messages |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.lease-cmds-hooks``, | :ischooklib:`libdhcp_lease_cmds.so` | Used |
| ``kea-dhcp6.lease-cmds-hooks`` | open-source hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Lease Commands hook |
@@ -314,7 +345,17 @@ libraries), or hook libraries (open source or premium).
| | | library and the |
| | | execution of commands |
| | | by the library. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.limits-hooks``, | :ischooklib:`libdhcp_limits.so` | Used to log messages related |
| ``kea-dhcp6.limits-hooks`` | subscription hook library | to the operation of the |
| | | Limits hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.lease-query-hooks``, | :ischooklib:`libdhcp_lease_query.so` | Used |
| ``kea-dhcp6.lease-query-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Leasequery hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.leases``, | core | Used by the DHCP |
| ``kea-dhcp6.leases`` | | server to log |
| | | messages related to |
@@ -326,14 +367,22 @@ libraries), or hook libraries (open source or premium).
| | | errors during the |
| | | lease allocation, |
| | | etc. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.legal-log-hooks``, | libdhcp_legal_log | Used |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.legal-log-hooks``, | :ischooklib:`libdhcp_legal_log.so` | Used |
| ``kea-dhcp6.legal-log-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Forensic Logging |
| | | hook library. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.mysql-cb-hooks``, | :ischooklib:`libdhcp_mysql_cb.so` | Used |
| ``kea-dhcp6.mysql-cb-hooks`` | open-source hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | MySQL Configuration |
| | | Backend hook |
| | | library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.options``, | core | Used by the DHCP |
| ``kea-dhcp6.options`` | | server to log |
| | | messages related to |
@@ -347,7 +396,7 @@ libraries), or hook libraries (open source or premium).
| | | using options |
| | | contained in the |
| | | received packets. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.packets``, | core | Mostly |
| ``kea-dhcp6.packets`` | | used to log messages |
| | | related to |
@@ -378,15 +427,27 @@ libraries), or hook libraries (open source or premium).
| | | before the DHCP |
| | | message carried in |
| | | the packet is parsed. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.radius-hooks``, | libdhcp_radius | Used |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.pgsql-cb-hooks``, | :ischooklib:`libdhcp_pgsql_cb.so` | Used |
| ``kea-dhcp6.pgsql-cb-hooks`` | open-source hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | PostgreSQL Configuration |
| | | Backend hook |
| | | library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.run-script-hooks``, | :ischooklib:`libdhcp_run_script.so` | Used to log messages related |
| ``kea-dhcp6.run-script-hooks`` | open-source hook library | to the operation of the |
| | | Run Script hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.radius-hooks``, | :ischooklib:`libdhcp_radius.so` | Used |
| ``kea-dhcp6.radius-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | RADIUS hook library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.stat-cmds-hooks``, | libdhcp_stat_cmds | Used |
| ``kea-dhcp6.stat-cmds-hooks`` | hook library | to log messages |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.stat-cmds-hooks``, | :ischooklib:`libdhcp_stat_cmds.so` | Used |
| ``kea-dhcp6.stat-cmds-hooks`` | opens-source hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Statistics Commands |
@@ -397,9 +458,9 @@ libraries), or hook libraries (open source or premium).
| | | library and the |
| | | execution of commands |
| | | by the library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.subnet-cmds-hooks``, | libdhcp_subnet_cmds | Used |
| ``kea-dhcp6.subnet-cmds-hooks`` | hook library | to log messages |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.subnet-cmds-hooks``, | :ischooklib:`libdhcp_subnet_cmds.so` | Used |
| ``kea-dhcp6.subnet-cmds-hooks`` | premium hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Subnet Commands hook |
@@ -409,15 +470,14 @@ libraries), or hook libraries (open source or premium).
| | | the library and the |
| | | execution of commands |
| | | by the library. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.mysql-cb-hooks``, | libdhcp_mysql_cb_hooks | Used |
| ``kea-dhcp6.mysql-cb-hooks`` | hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | MySQL Configuration |
| | | Backend hook |
| | | library. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.tcp``, | core | Used to log messages related |
| ``kea-dhcp6.tcp`` | | to TCP traffic. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp4.user_chk``, | :ischooklib:`libdhcp_user_chk.so` | Used to log messages related |
| ``kea-dhcp6.user_chk`` | hook library | to the operaton of the |
| | | User Check hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns`` | core | The root logger for |
| | | the :iscman:`kea-dhcp-ddns` |
| | | daemon. All |
@@ -429,22 +489,23 @@ libraries), or hook libraries (open source or premium).
| | | configurations for |
| | | more specialized |
| | | loggers. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp-ddns.dctl`` | core | Used by |
| | | the :iscman:`kea-dhcp-ddns` |
| | | daemon to log |
| | | basic information |
| | | about the process, |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-ctrl-agent.dctl``, | core | Used to log basic inofrmaton |
| ``kea-dhcp-ddns.dctl`` | | about the process, |
| | | received signals, and |
| | | triggered |
| | | reconfigurations. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns.asiodns``, | core | Used to log messages about |
| | | network events in DDNS |
| | | operations. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns.dhcpddns`` | core | Used by |
| | | the :iscman:`kea-dhcp-ddns` |
| | | daemon to log |
| | | events related to |
| | | DDNS operations. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns.dhcp-to-d2`` | core | Used by the |
| | | :iscman:`kea-dhcp-ddns` daemon |
| | | to log |
@@ -455,7 +516,7 @@ libraries), or hook libraries (open source or premium).
| | | and adding them to |
| | | the queue for |
| | | processing. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns.d2-to-dns`` | core | Used by the |
| | | :iscman:`kea-dhcp-ddns` daemon |
| | | to log |
@@ -464,7 +525,14 @@ libraries), or hook libraries (open source or premium).
| | | sending and receiving |
| | | messages to and from |
| | | the DNS servers. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns.gss-tsig-hooks`` | :ischooklib:`libddns_gss_tsig.so` | Used to log messages related |
| | subscription hook library | to the operation of the |
| | | GSS-TSIG hook library. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-dhcp-ddns.libdhcp-ddns`` | core | Used to log events related to |
| | | DDNS operations. |
+----------------------------------+---------------------------------------+--------------------------------+
| ``kea-netconf`` | core | The root logger for |
| | | the NETCONF agent. |
| | | All components used |
@@ -473,13 +541,7 @@ libraries), or hook libraries (open source or premium).
| | | this logger if there |
| | | is no specialized |
| | | logger provided. |
+----------------------------------+------------------------+--------------------------------+
| ``kea-dhcp4.lease-query-hooks``, | libdhcp_lease_query | Used |
| ``kea-dhcp6.lease-query-hooks`` | hook library | to log messages |
| | | related to the |
| | | operation of the |
| | | Leasequery hook library. |
+----------------------------------+------------------------+--------------------------------+
+----------------------------------+---------------------------------------+--------------------------------+
Note that user-defined hook libraries should not use any of the loggers
mentioned above, but should instead define new loggers with names that