From 4d96035bbcd4dcabb8b4cf11394ca98414042ea3 Mon Sep 17 00:00:00 2001 From: Hofi Date: Thu, 27 Jun 2024 20:23:55 +0200 Subject: [PATCH] Added file() and wildcard-file() following explanations Added the new monitor-freq() option description Signed-off-by: Hofi --- _data/navigation.yml | 4 +- .../doc/admin-guide/options/follow-freq.md | 9 +- .../warnings/file-source-follow-warning.md | 2 + _layouts/single.html | 2 +- .../minimal-mistakes/_tables.scss | 3 + .../020_File/001_File_following.md | 164 ++++++++++++++++++ ..._options.md => 002_File_source_options.md} | 0 .../060_Sources/020_File/README.md | 2 + .../000_Wildcard-file_options.md | 27 ++- .../060_Sources/030_Wildcard-file/README.md | 2 + 10 files changed, 203 insertions(+), 12 deletions(-) create mode 100644 _includes/doc/admin-guide/warnings/file-source-follow-warning.md create mode 100644 doc/_admin-guide/060_Sources/020_File/001_File_following.md rename doc/_admin-guide/060_Sources/020_File/{001_File_source_options.md => 002_File_source_options.md} (100%) diff --git a/_data/navigation.yml b/_data/navigation.yml index 63829f9e..d5da1bbd 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -142,8 +142,10 @@ admin-guide-nav: subnav: - title: "Notes on reading kernel messages" url: /admin-guide/060_Sources/020_File/000_Notes_on_reading_kernel_messages + - title: "How file sources are followed" + url: /admin-guide/060_Sources/020_File/001_File_following - title: "file() source options" - url: /admin-guide/060_Sources/020_File/001_File_source_options + url: /admin-guide/060_Sources/020_File/002_File_source_options - title: "Arr logs" url: /admin-guide/060_Sources/025_Arr_logs/README subnav: diff --git a/_includes/doc/admin-guide/options/follow-freq.md b/_includes/doc/admin-guide/options/follow-freq.md index 927b64a1..e8ab84f3 100644 --- a/_includes/doc/admin-guide/options/follow-freq.md +++ b/_includes/doc/admin-guide/options/follow-freq.md @@ -5,7 +5,10 @@ *Description:* Indicates that the source should be checked periodically. This is useful for files which always indicate readability, even though -no new lines were appended. If this value is higher than zero, syslog-ng -will not attempt to use poll() on the file, but checks whether the file -changed every time the follow-freq() interval (in seconds) has elapsed. +no new lines were appended (e.g. regular file system files). If this value +is higher than zero, syslog-ng will not attempt to use ivikys file change +notification methods on the file (poll(), epoll(), etc.), but checks whether +the file changed every time the follow-freq() interval (in seconds) has elapsed.\ Floating-point numbers (for example, **1.5**) can be used as well. + +{% include doc/admin-guide/warnings/file-source-follow-warning.md %} diff --git a/_includes/doc/admin-guide/warnings/file-source-follow-warning.md b/_includes/doc/admin-guide/warnings/file-source-follow-warning.md new file mode 100644 index 00000000..aea647e8 --- /dev/null +++ b/_includes/doc/admin-guide/warnings/file-source-follow-warning.md @@ -0,0 +1,2 @@ +![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** As the follow-freq(), the monitor-method(), and the monitor-freq() options could have performance penalty effects, it is important to understand how the file and directory monitoring operates depending on these values. For details, refer to How content changes are followed in file() and wildcard-file() sources. +{: .notice--warning} diff --git a/_layouts/single.html b/_layouts/single.html index e6c89208..432fd57a 100644 --- a/_layouts/single.html +++ b/_layouts/single.html @@ -33,7 +33,7 @@ {% if page.title %} {% comment %}{% endcomment %}

- +

{% endif %} {% comment %}