docs: Document `newRemoteLogger` in dnsdist

diff --git a/pdns/dnsdistdist/docs/reference/protobuf.rst b/pdns/dnsdistdist/docs/reference/protobuf.rst
index 90397c7483a5c732b4d7d379086956b6614e4d90..de53b81bca2fa66c53caf078dcf3ecfd7d6cab63 100644 (file)
--- a/pdns/dnsdistdist/docs/reference/protobuf.rst
+++ b/pdns/dnsdistdist/docs/reference/protobuf.rst
@@ -1,6 +1,15 @@
 Protobuf Logging Reference
 ==========================
 
+.. function:: newRemoteLogger(address [, timeout=2[, maxQueuedEntries=100[, reconnectWaitTime=1]]])
+
+  Create a Remote Logger object, to use with :func:`RemoteLogAction` and :func:`RemoteLogResponseAction`.
+
+  :param string address: An IP:PORT combination where the logger is listening
+  :param int timeout: TCP connect timeout in seconds
+  :param int maxQueuedEntries: Queue this many messages before dropping new ones (e.g. when the remote listener closes the connection)
+  :param int reconnectWaitTime: Time in seconds between reconnection attempts
+
 .. class:: DNSDistProtoBufMessage
 
   This object represents a single protobuf message as emitted by :program:`dnsdist`.

diff --git a/pdns/dnsdistdist/docs/rules-actions.rst b/pdns/dnsdistdist/docs/rules-actions.rst
index 583916de311b3b77383f037fe6c4c986b348e449..78b7b26fffb6cd715eef7754b9b764affd9545ce 100644 (file)
--- a/pdns/dnsdistdist/docs/rules-actions.rst
+++ b/pdns/dnsdistdist/docs/rules-actions.rst
@@ -695,7 +695,7 @@ The following actions exist.
   Send the content of this query to a remote logger via Protocol Buffer.
   ``alterFunction`` is a callback, receiving a :class:`DNSQuestion` and a :class:`DNSDistProtoBufMessage`, that can be used to modify the Protocol Buffer content, for example for anonymization purposes
 
-  :param string remoteLogger: An IP:PORT combo to send the remote log to
+  :param string remoteLogger: The :func:`remoteLogger <newRemoteLogger>` object to write to
   :param string alterFunction: Name of a function to modify the contents of the logs before sending
 
 .. function:: RemoteLogResponseAction(remoteLogger[, alterFunction[, includeCNAME]])
@@ -705,7 +705,7 @@ The following actions exist.
   ``includeCNAME`` indicates whether CNAME records inside the response should be parsed and exported.
   The default is to only exports A and AAAA records
 
-  :param string remoteLogger: An IP:PORT combo to send the remote log to
+  :param string remoteLogger: The :func:`remoteLogger <newRemoteLogger>` object to write to
   :param string alterFunction: Name of a function to modify the contents of the logs before sending
   :param bool includeCNAME: Whether or not to parse and export CNAMEs. Default false