From ee2b806d689773878ccd78bc8b6a884db03f9738 Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Wed, 17 Jul 2024 10:21:02 -0600 Subject: [PATCH] docs: Clarify poll vs notify (#15631) --- cmd/telegraf/main.go | 5 +++-- plugins/inputs/tail/README.md | 2 ++ plugins/inputs/tail/sample.conf | 2 ++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/cmd/telegraf/main.go b/cmd/telegraf/main.go index 7e818b094..e21281755 100644 --- a/cmd/telegraf/main.go +++ b/cmd/telegraf/main.go @@ -295,8 +295,9 @@ func runApp(args []string, outputBuffer io.Writer, pprof Server, c TelegrafConfi Usage: "pprof host/IP and port to listen on (e.g. 'localhost:6060')", }, &cli.StringFlag{ - Name: "watch-config", - Usage: "monitoring config changes [notify, poll] of --config and --config-directory options", + Name: "watch-config", + Usage: "monitoring config changes [notify, poll] of --config and --config-directory options. " + + "Notify supports linux, *bsd, and macOS. Poll is required for Windows and checks every 250ms.", }, &cli.StringFlag{ Name: "pidfile", diff --git a/plugins/inputs/tail/README.md b/plugins/inputs/tail/README.md index 1dc4bef68..7e6358129 100644 --- a/plugins/inputs/tail/README.md +++ b/plugins/inputs/tail/README.md @@ -63,6 +63,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # pipe = false ## Method used to watch for file updates. Can be either "inotify" or "poll". + ## inotify is supported on linux, *bsd, and macOS, while Windows requires + ## using poll. Poll checks for changes every 250ms. # watch_method = "inotify" ## Maximum lines of the file to process that have not yet be written by the diff --git a/plugins/inputs/tail/sample.conf b/plugins/inputs/tail/sample.conf index 368d7959f..1863546ee 100644 --- a/plugins/inputs/tail/sample.conf +++ b/plugins/inputs/tail/sample.conf @@ -19,6 +19,8 @@ # pipe = false ## Method used to watch for file updates. Can be either "inotify" or "poll". + ## inotify is supported on linux, *bsd, and macOS, while Windows requires + ## using poll. Poll checks for changes every 250ms. # watch_method = "inotify" ## Maximum lines of the file to process that have not yet be written by the