From: Aleš Mrázek <ales.mrazek@nic.cz>
Date: Tue, 25 Mar 2025 12:25:38 +0000 (+0100)
Subject: datamodel: logging: removed debugging options
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6e593beb30ea0bfc028ece4a6ac6377a3c4fe429;p=thirdparty%2Fknot-resolver.git

datamodel: logging: removed debugging options
---

diff --git a/NEWS b/NEWS
index ae95ca416..e76b20765 100644
--- a/NEWS
+++ b/NEWS
@@ -5,6 +5,12 @@ Improvements
 ------------
 - reduce validation strictness for domain names (#934, !1727)
 
+Incompatible changes
+--------------------
+- Removed options from declarative configuration model (YAML).  
+  These are mostly experimental and debugging/testing options that are not useful for general users (remain in Lua):
+  - /logging/debugging
+
 
 Knot Resolver 6.0.15 (2025-07-17)
 =================================
diff --git a/doc/_static/config.schema.json b/doc/_static/config.schema.json
index 88e11901d..4fc731f77 100644
--- a/doc/_static/config.schema.json
+++ b/doc/_static/config.schema.json
@@ -1617,27 +1617,6 @@
                     ],
                     "description": "Logging DNS requests and responses to a unix socket.",
                     "default": false
-                },
-                "debugging": {
-                    "description": "Advanced debugging parameters for kresd (Knot Resolver daemon).",
-                    "type": "object",
-                    "properties": {
-                        "assertion-abort": {
-                            "type": "boolean",
-                            "description": "Allow the process to be aborted in case it encounters a failed assertion.",
-                            "default": false
-                        },
-                        "assertion-fork": {
-                            "type": "string",
-                            "pattern": "^(\\d+)(us|ms|s|m|h|d)$",
-                            "description": "Fork and abord child kresd process to obtain a coredump, while the parent process recovers and keeps running.",
-                            "default": "5m"
-                        }
-                    },
-                    "default": {
-                        "assertion_abort": false,
-                        "assertion_fork": "5m"
-                    }
                 }
             },
             "default": {
@@ -1645,11 +1624,7 @@
                 "target": "stdout",
                 "groups": null,
                 "dnssec_bogus": false,
-                "dnstap": false,
-                "debugging": {
-                    "assertion_abort": false,
-                    "assertion_fork": "5m"
-                }
+                "dnstap": false
             }
         },
         "monitoring": {
diff --git a/doc/user/config-logging-debugging.rst b/doc/user/config-logging-debugging.rst
deleted file mode 100644
index 79dd54e42..000000000
--- a/doc/user/config-logging-debugging.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-.. SPDX-License-Identifier: GPL-3.0-or-later
-
-Debugging options
-=================
-
-In case the resolver crashes, it is often helpful to collect a coredump from
-the crashed process. Configuring the system to collect coredump from crashed
-process is out of the scope of this documentation, but some tips can be found
-`here <https://lists.nic.cz/hyperkitty/list/knot-resolver-users@lists.nic.cz/message/GUHW4JSDXZ6SZUAYYQ3U2WWOZEIVVF2S/>`_.
-
-Kresd uses its own mechanism for assertions. They are checks that should always
-pass and indicate some weird or unexpected state if they don't. In such cases,
-they show up in the log as errors. By default, the process recovers from those
-states if possible, but the behaviour can be changed with the following options
-to aid further debugging.
-
-.. option:: logging/debugging:
-
-   .. option:: assertion-abort: true|false
-
-      :default: false
-
-      Allow the process to be aborted in case it encounters a failed assertion.
-      (Some critical conditions always lead to abortion, regardless of settings.)
-
-   .. option:: assertion-fork: <time ms|s|m|h|d>
-
-      :default: 5m
-
-      If a process should be aborted, it can be done in two ways. When this is
-      set to nonzero (default), a child is forked and aborted to obtain a coredump,
-      while the parent process recovers and keeps running. This can be useful to
-      debug a rare issue that occurs in production, since it doesn't affect the
-      main process.
-
-      As the dumping can be costly, the value is a lower bound on delay between
-      consecutive coredumps of each process. It is randomized by +-25% each time.
-
-.. code-block:: yaml
-
-   logging:
-     debugging:
-       assertion-abort: true
-       assertion-fork: 10m
diff --git a/doc/user/config-logging-monitoring.rst b/doc/user/config-logging-monitoring.rst
index a181f05ba..dfe77101e 100644
--- a/doc/user/config-logging-monitoring.rst
+++ b/doc/user/config-logging-monitoring.rst
@@ -66,4 +66,3 @@ needs you can configure your own checks and exports using `asynchronous events <
    config-ta-signal-query
    config-time-skew-detection
    config-time-jump-detection
-   config-logging-debugging
diff --git a/python/knot_resolver/datamodel/logging_schema.py b/python/knot_resolver/datamodel/logging_schema.py
index 6c398a859..a504c3a83 100644
--- a/python/knot_resolver/datamodel/logging_schema.py
+++ b/python/knot_resolver/datamodel/logging_schema.py
@@ -1,7 +1,7 @@
 import os
 from typing import Any, List, Literal, Optional, Set, Type, Union, cast
 
-from knot_resolver.datamodel.types import TimeUnit, WritableFilePath
+from knot_resolver.datamodel.types import WritableFilePath
 from knot_resolver.utils.modeling import ConfigSchema
 from knot_resolver.utils.modeling.base_schema import is_obj_type_valid
 
@@ -80,19 +80,6 @@ class DnstapSchema(ConfigSchema):
     log_tcp_rtt: bool = True
 
 
-class DebuggingSchema(ConfigSchema):
-    """
-    Advanced debugging parameters for kresd (Knot Resolver daemon).
-
-    ---
-    assertion_abort: Allow the process to be aborted in case it encounters a failed assertion.
-    assertion_fork: Fork and abord child kresd process to obtain a coredump, while the parent process recovers and keeps running.
-    """
-
-    assertion_abort: bool = False
-    assertion_fork: TimeUnit = TimeUnit("5m")
-
-
 class LoggingSchema(ConfigSchema):
     class Raw(ConfigSchema):
         """
@@ -104,7 +91,6 @@ class LoggingSchema(ConfigSchema):
         groups: List of groups for which 'debug' logging level is set.
         dnssec_bogus: Logging a message for each DNSSEC validation failure.
         dnstap: Logging DNS requests and responses to a unix socket.
-        debugging: Advanced debugging parameters for kresd (Knot Resolver daemon).
         """
 
         level: LogLevelEnum = "notice"
@@ -112,7 +98,6 @@ class LoggingSchema(ConfigSchema):
         groups: Optional[List[LogGroupsEnum]] = None
         dnssec_bogus: bool = False
         dnstap: Union[Literal[False], DnstapSchema] = False
-        debugging: DebuggingSchema = DebuggingSchema()
 
     _LAYER = Raw
 
@@ -121,7 +106,6 @@ class LoggingSchema(ConfigSchema):
     groups: Optional[List[LogGroupsEnum]]
     dnssec_bogus: bool
     dnstap: Union[Literal[False], DnstapSchema]
-    debugging: DebuggingSchema
 
     def _target(self, raw: Raw) -> LogTargetEnum:
         if raw.target == "from-env":
diff --git a/python/knot_resolver/datamodel/templates/logging.lua.j2 b/python/knot_resolver/datamodel/templates/logging.lua.j2
index 2d5937a83..c031b47cc 100644
--- a/python/knot_resolver/datamodel/templates/logging.lua.j2
+++ b/python/knot_resolver/datamodel/templates/logging.lua.j2
@@ -35,9 +35,3 @@ dnstap.config({
     }
 })
 {%- endif %}
-
--- logging.debugging.assertion-abort
-debugging.assertion_abort = {{ boolean(cfg.logging.debugging.assertion_abort) }}
-
--- logging.debugging.assertion-fork
-debugging.assertion_fork = {{ cfg.logging.debugging.assertion_fork.millis() }}