Update sub_filter description for zmq4 and nanomsg

adamwasila · Feb 3, 2020 · 8dfb894 · 8dfb894
1 parent 784a73a
commit 8dfb894
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/lib/input/nanomsg.go b/lib/input/nanomsg.go
@@ -21,7 +21,7 @@ Currently only PULL and SUB sockets are supported.`,
 			docs.FieldCommon("urls", "A list of URLs to connect to (or as). If an item of the list contains commas it will be expanded into multiple URLs."),
 			docs.FieldCommon("bind", "Whether the URLs provided should be connected to, or bound as."),
 			docs.FieldCommon("socket_type", "The socket type to use.").HasOptions("PULL", "SUB"),
-			docs.FieldCommon("sub_filters", "A list of sub filters to use when consuming from a SUB socket."),
+			docs.FieldCommon("sub_filters", "A list of subcription topic filters to use when consuming from a SUB socket. Specifying a single sub_filter of `''` will subscribe to everything."),
 			docs.FieldAdvanced("poll_timeout", "The period to wait until a poll is abandoned and reattempted."),
 			docs.FieldDeprecated("reply_timeout"),
 		},

diff --git a/lib/input/zmq4.go b/lib/input/zmq4.go
@@ -37,7 +37,7 @@ socket types then they can be added easily.`,
 			docs.FieldCommon("urls", "A list of URLs to connect to. If an item of the list contains commas it will be expanded into multiple URLs."),
 			docs.FieldCommon("bind", "Whether to bind to the specified URLs or connect."),
 			docs.FieldCommon("socket_type", "The socket type to connect as.").HasOptions("PULL", "SUB"),
-			docs.FieldCommon("sub_filters", "A list of filters to use when connecting as a `SUB` socket."),
+			docs.FieldCommon("sub_filters", "A list of subcription topic filters to use when consuming from a SUB socket. Specifying a single sub_filter of `''` will subscribe to everything."),
 			docs.FieldAdvanced("high_water_mark", "The message high water mark to use."),
 			docs.FieldAdvanced("poll_timeout", "The poll timeout to use."),
 		},

diff --git a/website/docs/components/inputs/nanomsg.md b/website/docs/components/inputs/nanomsg.md
@@ -72,7 +72,7 @@ Options are: `PULL`, `SUB`.
 
 ### `sub_filters`
 
-`array` A list of sub filters to use when consuming from a SUB socket.
+`array` A list of subcription topic filters to use when consuming from a SUB socket. Specifying a single sub_filter of `''` will subscribe to everything.
 
 ### `poll_timeout`
 

diff --git a/website/docs/components/inputs/zmq4.md b/website/docs/components/inputs/zmq4.md
@@ -87,7 +87,7 @@ Options are: `PULL`, `SUB`.
 
 ### `sub_filters`
 
-`array` A list of filters to use when connecting as a `SUB` socket.
+`array` A list of subcription topic filters to use when consuming from a SUB socket. Specifying a single sub_filter of `''` will subscribe to everything.
 
 ### `high_water_mark`