Skip to content

Commit

Permalink
Merge pull request PowerDNS#14530 from andrewimeson/adi/docs_link_to_…
Browse files Browse the repository at this point in the history
…library

docs: Add link to the fstrm FrameStream library
  • Loading branch information
rgacogne authored Jul 29, 2024
2 parents 8091171 + eb9a676 commit 7c9dce9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
14 changes: 8 additions & 6 deletions pdns/dnsdistdist/docs/reference/dnstap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
:param string path: A local AF_UNIX socket path. Note that most platforms have a rather short limit on the length.
:param table options: A table with key: value pairs with options.

The following options apply to the settings of the framestream library. Refer to the documentation of that
library for the default and allowed values for these options, as well as their exact descriptions.
For all these options, absence or a zero value has the effect of using the library-provided default value.
The following options apply to the settings of the `framestream library
<https://github.com/farsightsec/fstrm>`. Refer to the documentation of that library for the default and
allowed values for these options, as well as their exact descriptions. For all these options, absence or a
zero value has the effect of using the library-provided default value.

* ``bufferHint=0``: unsigned
* ``flushTimeout=0``: unsigned
Expand All @@ -45,9 +46,10 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
:param string address: An IP:PORT combination where the logger will connect to.
:param table options: A table with key: value pairs with options.

The following options apply to the settings of the framestream library. Refer to the documentation of that
library for the default and allowed values for these options, as well as their exact descriptions.
For all these options, absence or a zero value has the effect of using the library-provided default value.
The following options apply to the settings of the `framestream library
<https://github.com/farsightsec/fstrm>`. Refer to the documentation of that library for the default and
allowed values for these options, as well as their exact descriptions. For all these options, absence or a
zero value has the effect of using the library-provided default value.

* ``bufferHint=0``: unsigned
* ``flushTimeout=0``: unsigned
Expand Down
14 changes: 8 additions & 6 deletions pdns/recursordist/docs/lua-config/protobuf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,10 @@ The recursor must have been built with configure ``--enable-dnstap`` to make thi
* ``logQueries=true``: bool - log outgoing queries
* ``logResponses=true``: bool - log incoming responses

The following options apply to the settings of the framestream library. Refer to the documentation of that
library for the default values, exact description and allowable values for these options.
For all these options, absence or a zero value has the effect of using the library-provided default value.
The following options apply to the settings of the `framestream library
<https://github.com/farsightsec/fstrm>`. Refer to the documentation of that library for the default
values, exact description and allowable values for these options. For all these options, absence or a zero
value has the effect of using the library-provided default value.

* ``bufferHint=0``: unsigned
* ``flushTimeout=0``: unsigned
Expand All @@ -169,9 +170,10 @@ The recursor must have been built with configure ``--enable-dnstap`` to make thi
* ``logNODs=true``: bool - log NODs
* ``logUDRs=false``: bool - log UDRs

The following options apply to the settings of the framestream library. Refer to the documentation of that
library for the default values, exact description and allowable values for these options.
For all these options, absence or a zero value has the effect of using the library-provided default value.
The following options apply to the settings of the `framestream library
<https://github.com/farsightsec/fstrm>`. Refer to the documentation of that library for the default
values, exact description and allowable values for these options. For all these options, absence or a zero
value has the effect of using the library-provided default value.

* ``bufferHint=0``: unsigned
* ``flushTimeout=0``: unsigned
Expand Down

0 comments on commit 7c9dce9

Please sign in to comment.