From: Petr Špaček Date: Mon, 6 Jan 2020 19:02:36 +0000 (+0100) Subject: doc: remove Operations/Monitoring - it was duplicate of Config/Monitoring X-Git-Tag: v5.0.0~8^2~23 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a6fabe689f4c55b35e9c395cd937e39130f309b9;p=thirdparty%2Fknot-resolver.git doc: remove Operations/Monitoring - it was duplicate of Config/Monitoring --- diff --git a/doc/config.rst b/doc/config.rst index d3daaf61a..ec850b749 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -96,7 +96,13 @@ For debugging purposes it is possible to enable very verbose logging using On busy systems vebose logging can produce several MB of logs per second and will slow down operation. -More fine-grained tools are available in following modules: +Less verbose logging for DNSSEC validation errors can be enabled using :ref:`mod-bogus_log` module. + +Various statistics for monitoring purposes are available in :ref:`mod-stats` module, including export to central systems like Graphite, Metronome, InfluxDB, or Prometheus format. + +Resolver :ref:`mod-watchdog` is tool to detect and recover from potential bugs that cause the resolver to stop responding properly to queries. + +If none of these options fits your deployment or if you have special needs you can configure your own checks and exports using :ref:`async-events`. .. contents:: :depth: 1 diff --git a/doc/index.rst b/doc/index.rst index 28bbc5bb8..786c93e07 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -27,7 +27,6 @@ and it provides a state-machine like API for extensions. :caption: Operation :maxdepth: 1 - monitoring upgrading NEWS diff --git a/doc/monitoring.rst b/doc/monitoring.rst deleted file mode 100644 index e6964e60e..000000000 --- a/doc/monitoring.rst +++ /dev/null @@ -1,15 +0,0 @@ -********** -Monitoring -********** - -Statistics for monitoring purposes are available in :ref:`mod-stats` module. If you want to export these statistics to a central system like Graphite, Metronome, InfluxDB or any other compatible storage see :ref:`mod-graphite`. Statistics can also be made available over HTTP protocol in Prometheus format, see module providing :ref:`mod-http`, Prometheus is supported by ``webmgmt`` endpoint. - -.. note:: - - Please remember that each Knot Resolver instance keeps its own statistics, and instances can be started and stopped dynamically. This might affect your data postprocessing procedures. - -More extensive logging can be enabled using :ref:`mod-bogus_log` module. - -Resolver watchdog is tool to detect and recover from potential bugs that cause the resolver to stop responding properly to queries. See :ref:`mod-watchdog` for more information about this functionality. - -If none of these options fits your deployment or if you have special needs you can configure your own checks and exports using :ref:`async-events`. diff --git a/modules/stats/README.rst b/modules/stats/README.rst index 27f67e88e..ea62d3689 100644 --- a/modules/stats/README.rst +++ b/modules/stats/README.rst @@ -9,6 +9,10 @@ These metrics can be either exported to :ref:`mod-graphite`, exposed as :ref:`mod-http-prometheus`, or processed using user-provided script as described in chapter :ref:`async-events`. +.. note:: + + Please remember that each Knot Resolver instance keeps its own statistics, and instances can be started and stopped dynamically. This might affect your data postprocessing procedures if you are using `Multiple instances`_. + .. _mod-stats-list: Built-in statistics