From: Petr Špaček <petr.spacek@nic.cz>
Date: Wed, 8 Jan 2020 08:42:03 +0000 (+0100)
Subject: doc: move graphite and prometheus do sub-sections of stats
X-Git-Tag: v5.0.0~8^2~19
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=74023b3f46f36ffd5342fbb14787852ca8984ce2;p=thirdparty%2Fknot-resolver.git

doc: move graphite and prometheus do sub-sections of stats

Neither graphire nor Prometheus are useful without stats, and any data
they export needs explanation from stats module so it does not make
sense to separate them.
---

diff --git a/doc/config-logging-monitoring.rst b/doc/config-logging-monitoring.rst
index 4e8dc55c8..fed233d8b 100644
--- a/doc/config-logging-monitoring.rst
+++ b/doc/config-logging-monitoring.rst
@@ -34,8 +34,6 @@ If none of these options fits your deployment or if you have special needs you c
 
    modules-nsid
    modules-stats
-   modules-graphite
-   modules-http-prometheus
    modules-dnstap
    modules-watchdog
    modules-bogus_log
diff --git a/doc/modules-graphite.rst b/doc/modules-graphite.rst
deleted file mode 120000
index 29d7c2a44..000000000
--- a/doc/modules-graphite.rst
+++ /dev/null
@@ -1 +0,0 @@
-../modules/graphite/README.rst
\ No newline at end of file
diff --git a/doc/modules-http-prometheus.rst b/doc/modules-http-prometheus.rst
deleted file mode 120000
index 5f9ac97bc..000000000
--- a/doc/modules-http-prometheus.rst
+++ /dev/null
@@ -1 +0,0 @@
-../modules/http/prometheus.rst
\ No newline at end of file
diff --git a/modules/graphite/README.rst b/modules/graphite/README.rst
index 82cf682a8..c0e611434 100644
--- a/modules/graphite/README.rst
+++ b/modules/graphite/README.rst
@@ -1,7 +1,7 @@
 .. _mod-graphite:
 
 Graphite/InfluxDB/Metronome
-===========================
+---------------------------
 
 The ``graphite`` sends statistics over the Graphite_ protocol to either Graphite_, Metronome_, InfluxDB_ or any compatible storage. This allows powerful visualization over metrics collected by Knot Resolver.
 
@@ -36,7 +36,7 @@ The module supports sending data to multiple servers at once.
 	}
 
 Dependencies
-------------
+^^^^^^^^^^^^
 
 * `lua cqueues <https://25thandclement.com/~william/projects/cqueues.html>`_ package.
 
diff --git a/modules/http/prometheus.rst b/modules/http/prometheus.rst
index 8549de197..12ddd61a6 100644
--- a/modules/http/prometheus.rst
+++ b/modules/http/prometheus.rst
@@ -1,7 +1,7 @@
 .. _mod-http-prometheus:
 
 Prometheus metrics endpoint
-===========================
+---------------------------
 
 The `HTTP module <mod-http>`_ exposes ``/metrics`` endpoint that serves metrics
 from :ref:`mod-stats` in Prometheus_ text format.
diff --git a/modules/stats/README.rst b/modules/stats/README.rst
index 029432516..3a805750d 100644
--- a/modules/stats/README.rst
+++ b/modules/stats/README.rst
@@ -196,4 +196,5 @@ and include subrequests. The list maximum size is 5000 entries, make diffs if yo
 
 Clear the list of most frequent iterative queries.
 
-
+.. include:: ../modules/graphite/README.rst
+.. include:: ../modules/http/prometheus.rst