Merge branch 'master' into add-new-log-rotation-method

Author: HofiOne

.github/ISSUE_TEMPLATE/10-doc-issue.md renamed to .github/ISSUE_TEMPLATE/10-doc-issue-bug.md

@@ -1,8 +1,8 @@
 ---
-name: 📚 Documentation issue
-about: Use this template for reporting an issue in the documentation.
+name: 📚 Documentation bug
+about: Use this template for reporting a bug in the documentation.
 title: ''
-labels: 'documentation'
+labels: [documentation, bug]
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/15-doc-issue-enhancements.md

@@ -0,0 +1,30 @@
+---
+name: 📚 Documentation enhancements
+about: Use this template for sending an enhancement request for the documentation.
+title: ''
+labels: [documentation, enhancement]
+assignees: ''
+
+---
+
+<!--
+*******************
+PLEASE TAKE CARE!!!
+*******************
+
+This is a syslog-ng documentation related ONLY request.
+
+For creating issue request related to the syslog-ng application, use
+
+https://github.com/syslog-ng/syslog-ng/issues/new/choose
+
+-->
+
+## What section you wish to enhance
+<!-- Which section of the documentation needs enhancement? Please include a link to it, if that is possible. -->
+
+## Description of the problem
+<!-- What would you like to add, do differently, etc. in the documentation? -->
+
+## Proposed solution
+<!-- How would you correct/enhance it? -->

.github/ISSUE_TEMPLATE/20-doc-building-bug-report.md

@@ -2,7 +2,7 @@
 name: 📚 Documentation building bug report
 about: Use this template for reporting a bug related to building the documentation.
 title: ''
-labels: bug
+labels: 'bug'
 assignees: ''
 
 ---

_includes/doc/admin-guide/notes/kafka-c.md

@@ -0,0 +1,2 @@
+**NOTE:** The deprecated `{{ include.old }}()` option is an alias for the `{{ include.new }}()` option, retained for compatibility with earlier {{ site.product.short_name }} versions, but it may be removed at any time without further notice!
+{: .notice--info}

_includes/doc/admin-guide/options/deprecated-options.md

@@ -0,0 +1,20 @@
+## log-fetch-delay()
+
+|Type:|     integer|
+|Default:| `10000`|
+
+*Description:* Sets the time {{ site.product.short_name }} waits between reading and sending log messages. The unit of this parameter is a fraction of a second, where `wait_time = 1 second / <defined value>`. For example, setting it to `1` results in approximately one log being read/sent per second, while `1000000` means a delay of only 1 microsecond between read/write attempts. The maximum value of this parameter is `1000000`.
+
+**NOTE:** Increasing the value of this parameter (which reduces the delay time) can improve log feed performance, but it may also increase system load.
+{: .notice--info}
+
+{% include doc/admin-guide/options/deprecated-options.md old='fetch-delay' new='log-fetch-delay' %}
+
+## log-fetch-retry-delay()
+
+|Type:|     integer|
+|Default:| `1`|
+
+*Description:* Controls how many seconds {{ site.product.short_name }} remains idle before checking for new logs, in case no new logs were read during the previous check.
+
+{% include doc/admin-guide/options/deprecated-options.md old='fetch-retry-delay' new='log-fetch-retry-delay' %}

_includes/doc/admin-guide/options/log-fetch-delays.md

@@ -2,7 +2,7 @@
 title: darwin-oslog() source options
 id: adm-src-darw-osl-opt
 description: >-
-    The `darwin-oslog()` source is based on the native OSLog Framework to read logs from the local store of the unified logging system on darwin OSes. The {{ site.product.short_name }} `system()` source automatically uses this new source on darwin platforms if the `darwinosl` plugin is available. This plugin is available only on macOS 10.15 Catalina and later versions. The 10.15 version is the first to support the OSLog API.
+    The `darwin-oslog()` source is based on the native OSLog Framework to read logs from the local store of the unified logging system on Darwin OSes. The {{ site.product.short_name }} `system()` source automatically uses this new source on Darwin platforms if the `darwinosl` plugin is available. This plugin is available only on macOS 10.15 Catalina and later versions. The 10.15 version is the first to support the OSLog API.
 ---
 
 **NOTE:** The persistent OSLog store keeps about 7 days of logs on the disk.
@@ -22,25 +22,7 @@ The `darwin-oslog()` source has the following options.
 |Type:|     boolean|
 |Default:| `no`|
 
-*Description:* By default, {{ site.product.short_name }} continues to read the logs from the last remembered position after a restart. If this option is set to `yes`, it always starts reading from the end or beginning of the available log list (depending on the setting of the `go-reverse()` option.
-
-## fetch-delay()
-
-|Type:|     integer|
-|Default:| `10000`|
-
-*Description:* Sets the time {{ site.product.short_name }} waits between reading and sending log messages. The dimension of this parameter is a fraction of a second, where `wait_time = 1 second / <defined value>`, so setting `1` would result that only about 1 log is sent in each second, and `1000000` means only 1 microsecond is the delay between read/write attempts. The maximum value of this parameter is `1000000`.
-
-**NOTE:** Increasing the value of this parameter (which lowers delay time) can increase log feed performance, but at could increase system load.
-{: .notice--info}
-
-
-## fetch-retry-delay()
-
-|Type:|     integer|
-|Default:| `1`|
-
-*Description:* Controls how many seconds {{ site.product.short_name }} spends idle before checking for new logs, in case no new logs were read the last time.
+*Description:* By default, {{ site.product.short_name }} continues to read the logs from the last remembered position after a restart. If this option is set to `yes`, it always starts reading from the end or beginning of the available log list (depending on the setting of the `go-reverse()` and the `read-old-records()` options.
 
 ## go-reverse()
 
@@ -49,26 +31,20 @@ The `darwin-oslog()` source has the following options.
 
 *Description:* If set to `yes`, the logs are processed in reverse order (latest to oldest).
 
-## log-fetch-limit
-
-**NOTE:** This option is currently disabled due to an OSLog API bug.
-{: .notice--info}
-
-|Type:|     integer|
-|Default:| `0`(unlimited)|
+{% include doc/admin-guide/options/log-fetch-delays.md %}
 
-*Description:* The maximum number of messages fetched from a source with a single poll loop. The destination queues might fill up before `flow-control` could stop reading if the defined `log-fetch-limit()` value is too high.
+{% include doc/admin-guide/options/log-fetch-limit.md %}
 
 ## max-bookmark-distance()
 
 |Type:|     integer|
 |Default:| `0`(unlimited) [seconds]|
 
-*Description:* The maximum distance in seconds that a bookmark can point backwards. That is, if {{ site.product.short_name }} is stopped for 10 minutes (600 seconds) and `max-bookmark-distance()` is set to `60`, then {{ site.product.short_name }} starts reading the logs from 60 seconds before the startup, missing 9 minutes (540 seconds) worth of logs.
+*Description:* The maximum distance in seconds that a bookmark can point backward. That is, if {{ site.product.short_name }} is stopped for 10 minutes (600 seconds) and `max-bookmark-distance()` is set to `60`, then {{ site.product.short_name }} starts reading the logs from 60 seconds before the startup, missing 9 minutes (540 seconds) worth of logs.
 
 ## read-old-records()
 
 |Type:|     boolean|
 |Default:| `no`|
 
-*Description:* If set to yes, {{ site.product.short_name }} starts reading logs starting from the oldest available log when the system starts, or if there are no bookmarks present.
+*Description:* If set to yes, {{ site.product.short_name }} starts reading logs from the oldest available entry when the system starts, or if no bookmarks are present.

doc/_admin-guide/060_Sources/085_macOS/000_darwin_oslog_options.md

@@ -21,8 +21,6 @@ You can specify multiple, comma-separated addresses, demonstrated in the followi
 bootstrap-servers("127.0.0.1:2525,remote-server-hostname:6464")
 ```
 
-{% include doc/admin-guide/notes/kafka-c.md %}
-
 {% include doc/admin-guide/options/batch-lines.md %}
 
 **NOTE:** The {{ site.product.short_name }} configuration accepts this option with
@@ -82,8 +80,6 @@ The programming language accepts this option for better compatibility.
 
 *Description:* You can use this option to set the properties of the kafka producer.
 
-{% include doc/admin-guide/notes/kafka-c.md %}
-
 The {{ site.product.short_name }} kafka destination supports all properties of the
 official Kafka producer. For details, see the librdkafka documentation.
 
@@ -149,6 +145,19 @@ key(\"${PROGRAM}\").
 
 {% include doc/admin-guide/options/local-time-zone.md %}
 
+## message()
+
+|  Type:|      message template|
+  |Default:|   ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
+
+*Description:* The message as published to Apache Kafka. You can use
+templates and template functions (for example, format-json()) to format
+the message, for example, template(\"$(format-json \--scope rfc5424
+\--exclude DATE \--key ISODATE)\").
+
+For details on formatting messages in JSON format, see
+[[format-json|adm-temp-func#format-json]].
+
 {% include doc/admin-guide/options/on-error.md %}
 
 {% include doc/admin-guide/options/persist-name.md %}
@@ -163,8 +172,6 @@ client about the amount of messages sent since the last poll-timeout ().
 In case of multithreading, the first {{ site.product.short_name }} worker is responsible for
 poll-timeout().
 
-{% include doc/admin-guide/notes/kafka-c.md %}
-
 {% include doc/admin-guide/options/retries.md %}
 
 {% include doc/admin-guide/options/send-time-zone.md %}
@@ -196,19 +203,6 @@ recommends that you set sync-send() to "yes", as this setting
 delivers messages to the Kafka client more reliably.
 {: .notice--danger}
 
-## message()
-
-|  Type:|      message template|
-  |Default:|   ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
-
-*Description:* The message as published to Apache Kafka. You can use
-templates and template functions (for example, format-json()) to format
-the message, for example, template(\"$(format-json \--scope rfc5424
-\--exclude DATE \--key ISODATE)\").
-
-For details on formatting messages in JSON format, see
-[[format-json|adm-temp-func#format-json]].
-
 {% include doc/admin-guide/options/throttle.md %}
 
 {% include doc/admin-guide/options/time-zone.md %}

doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md

@@ -52,7 +52,7 @@ For more info, see [oslog](https://developer.apple.com/documentation/oslog?langu
   - boolean value, controls if {{ site.product.short_name }} should start reading logs from the oldest
         available at first start (or if no bookmark can be found)
   - default value: `no`
-- `fetch-delay()`
+- `log-fetch-delay()`
   - integer value, controls how much time {{ site.product.short_name }} should wait between reading/sending
         log messages, this is a fraction of a second, where wait_time = 1 second / n, so,
         e.g. n=1 means that only about 1 log will be read and sent in each second,
@@ -61,13 +61,11 @@ For more info, see [oslog](https://developer.apple.com/documentation/oslog?langu
   - Use with care, though lower delay time can increase log feed performance, at the
         same time could lead to a heavy system load!
   - default value: `10 000`
-- `fetch-retry-delay()`
+- `log-fetch-retry-delay()`
   - integer value, controls how many seconds {{ site.product.short_name }} will wait before a repeated
         attempt to read/send once it's out of available logs
   - default value: `1`
 - `log-fetch-limit()`
-  - **Warning**: _This option is now disabled due to an [OSLog API bug](https://openradar.appspot.com/radar?id=5597032077066240), once it's fixed it_
-        _will be enabled again_
   - integer value, that limits the number of logs {{ site.product.short_name }} will send in one run
   - default value: `0`, which means no limit