From: Remi Gacogne <remi.gacogne@powerdns.com>
Date: Tue, 31 Oct 2023 09:57:05 +0000 (+0100)
Subject: dnsdist: Document getStatisticsCounters()
X-Git-Tag: rec-5.0.0-beta1~2^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F13436%2Fhead;p=thirdparty%2Fpdns.git

dnsdist: Document getStatisticsCounters()
---

diff --git a/pdns/dnsdistdist/docs/reference/config.rst b/pdns/dnsdistdist/docs/reference/config.rst
index 8e5d4fc599..013740c53f 100644
--- a/pdns/dnsdistdist/docs/reference/config.rst
+++ b/pdns/dnsdistdist/docs/reference/config.rst
@@ -1820,6 +1820,11 @@ Other functions
 
   :param str path: The path to the file, usually /etc/resolv.conf
 
+.. function:: getStatisticsCounters()
+
+  This function returns a Lua associative array of metrics, with the metric name as key and the current value
+  of the counter as value.
+
 .. function:: maintenance()
 
   If this function exists, it is called every second to do regular tasks.