]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
http: polish docs
authorPetr Špaček <petr.spacek@nic.cz>
Thu, 18 Apr 2019 15:33:21 +0000 (17:33 +0200)
committerPetr Špaček <petr.spacek@nic.cz>
Thu, 18 Apr 2019 15:36:06 +0000 (17:36 +0200)
modules/http/README.rst
modules/stats/README.rst

index e567689191c75a072ec8248ca89880613acc73af..3b2e43fbba73a4b08f827e56e780615139cc842d 100644 (file)
@@ -13,13 +13,13 @@ or publish metrics on request for Prometheus scraper.
 By default this module provides two kinds of endpoints,
 and unlimited number of "used-defined kinds" can be added in configuration.
 
-+--------------+---------------------------------------------+
-| **Endpoint** | **Explanation**                             |
-+--------------+---------------------------------------------+
-| doh          | :ref:`mod-http-doh`                         |
-+--------------+---------------------------------------------+
-| webmgmt      | built-in web management APIs (includes DoH) |
-+--------------+---------------------------------------------+
++--------------+---------------------------------------------------------------------------------+
+| **Endpoint** | **Explanation**                                                                 |
++--------------+---------------------------------------------------------------------------------+
+| doh          | :ref:`mod-http-doh`                                                             |
++--------------+---------------------------------------------------------------------------------+
+| webmgmt      | :ref:`built-in web management <mod-http-built-in-services>` APIs (includes DoH) |
++--------------+---------------------------------------------------------------------------------+
 
 Each network address and port combination can be configured to expose
 one kind of endpoint. This is done using the same mechanisms as
@@ -118,9 +118,9 @@ The HTTP module has several built-in services to use.
 .. csv-table::
  :header: "Endpoint", "Service", "Description"
 
- "``/stats``", "Statistics/metrics", "Exported metrics in JSON."
- "``/metrics``", "Prometheus metrics", "Exported metrics for Prometheus_"
- "``/trace/:name/:type``", "Tracking", "Trace resolution of the query and return the verbose logs."
+ "``/stats``", "Statistics/metrics", "Exported :ref:`metrics <mod-stats-list>` from :ref:`mod-stats` in JSON format."
+ "``/metrics``", "Prometheus metrics", "Exported metrics for Prometheus_."
+ "``/trace/:name/:type``", "Tracking", ":ref:`Trace resolution <mod-http-trace>` of a DNS query and return the verbose logs."
  "``/doh``", "DNS-over-HTTP", ":rfc:`8484` endpoint, see :ref:`mod-http-doh`."
 
 Prometheus metrics endpoint
@@ -162,6 +162,8 @@ You can also add custom metrics or rewrite existing metrics before they are retu
                table.insert(metrics, 'build_info{version="1.2.3"} 1')
         end
 
+.. _mod-http-trace:
+
 Tracing requests
 ^^^^^^^^^^^^^^^^
 
index 74910140dac43def465c07255ff206e5e92c3daa..afa1e5c3bf981d756b680f18d9059bacc83ab067 100644 (file)
@@ -86,6 +86,7 @@ and include subrequests. The list maximum size is 5000 entries, make diffs if yo
 
 Clear the list of most frequent iterative queries.
 
+.. _mod-stats-list:
 
 Built-in statistics
 ^^^^^^^^^^^^^^^^^^^