Skip to content
Snippets Groups Projects
Commit ca07577d authored by Zuzana Lena Ansorgova's avatar Zuzana Lena Ansorgova
Browse files

doc: documentation fixes - troubleshooting finished

parent 1af232f0
No related branches found
No related tags found
No related merge requests found
......@@ -6,21 +6,21 @@ Troubleshooting
***************
First of all, check the logs (:ref:`Logging section`). Enabling at least
the ``warning`` message severity may help you identify some problems.
the ``warning`` message severity may help you to identify some problems.
.. _Submitting a bugreport:
Submitting a bugreport
Reporting bugs
======================
If you are unable to solve the problem by yourself, you can submit a
bugreport to the Knot DNS team. For security issues (e.g. crash) do
not use the public mailing list. Instead, write to
bugreport to the Knot DNS team. *Do NOT use the public mailing list
for security issues (e.g. crash), though!* Instead, write to
`knot-dns@labs.nic.cz <mailto:knot-dns@labs.nic.cz>`_. All other bugs
and questions may be directed to the Knot DNS users mailing list
(`knot-dns-users@lists.nic.cz <mailto:knot-dns-users@lists.nic.cz>`_).
The bugreport should contain at least:
A bugreport should contain at least:
* Knot DNS version and type of installation (source, package, etc.)
* Type and version of your operating system
......@@ -28,7 +28,7 @@ The bugreport should contain at least:
* Description of the bug
* Log output of all messages (category ``any``, severity ``info``)
* Steps to reproduce the bug (if known)
* Backtrace (if the bug caused a crash; see next section)
* Backtrace (if the bug caused a crash; see the next section)
If it is possible, the actual configuration file and/or zone file(s)
will be very useful as well.
......@@ -38,8 +38,8 @@ will be very useful as well.
Generating backtrace
====================
There are several ways to achieve that, the most common way is to
leave core dumps and then extract a backtrace from it. This doesn't
There are several ways to achieve that. The most common way is to
leave a core dump and then extract a backtrace from it. This doesn't
affect any server operation, you just need to make sure the OS is
configured to generate them::
......@@ -61,50 +61,3 @@ like stuck process and similar::
(gdb) thread apply all bt
(gdb) q
.. _Debug messages:
Debug messages
==============
In some cases the aforementioned information may not be enough to find
and fix the bug. In these cases it may be useful to turn on debug
messages.
Two steps are required in order to log debug messages. First you need
to allow the debug messages in the server. Then the logging must be
configured to log debug messages (:ref:`Logging section`). It is recommended to
log these messages to a file. Firstly, the debug output may be rather
large and secondly, it is easier to use the data for debugging.
.. _Enabling debug messages:
Enabling debug messages
-----------------------
Allowing debug messages in the server is possible only when
configuring the sources. Two ``configure`` options are required
to do this:
* The ``--enable-debug`` option specifies the server modules for which
you want to enable debug messages. One or more of the following
modules may be listed, separated by commas:
* ``server`` - Messages related to networking, threads and low-level
journal handling.
* ``zones`` - All operations with zones (loading, updating, saving,
timers, high-level journal management).
* ``ns`` - Query processing, high-level handling of all requests
(transfers, notifies, normal queries).
* ``loader`` - Zone loading and semantic checks.
* ``dnssec`` - DNSSEC operations.
* The ``--enable-debuglevel`` option is used to specify the verbosity
of the debug output. Be careful with this, as the ``details``
verbosity may produce really large logs (in order of GBs). There are
three levels of verbosity: ``brief``, ``verbose`` and ``details``.
Example:
::
$ ./configure --enable-debug=server,zones --enable-debuglevel=verbose
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment