From: Petr Špaček Date: Thu, 18 Apr 2019 15:33:21 +0000 (+0200) Subject: http: polish docs X-Git-Tag: v4.0.0~1^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d9da74ca3991d24828ade3d8fda321a1a8f5fa34;p=thirdparty%2Fknot-resolver.git http: polish docs --- diff --git a/modules/http/README.rst b/modules/http/README.rst index e56768919..3b2e43fbb 100644 --- a/modules/http/README.rst +++ b/modules/http/README.rst @@ -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 ` 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 ` from :ref:`mod-stats` in JSON format." + "``/metrics``", "Prometheus metrics", "Exported metrics for Prometheus_." + "``/trace/:name/:type``", "Tracking", ":ref:`Trace resolution ` 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 ^^^^^^^^^^^^^^^^ diff --git a/modules/stats/README.rst b/modules/stats/README.rst index 74910140d..afa1e5c3b 100644 --- a/modules/stats/README.rst +++ b/modules/stats/README.rst @@ -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 ^^^^^^^^^^^^^^^^^^^