Skip to content

Commit 1673e12

Browse files
committed
darwinosl: options update for syslog-ng/syslog-ng#5547
Signed-off-by: Hofi <hofione@gmail.com>
1 parent 4aadf8e commit 1673e12

File tree

3 files changed

+20
-28
lines changed

3 files changed

+20
-28
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## log-fetch-delay()
2+
3+
|Type:| integer|
4+
|Default:| `10000`|
5+
6+
*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`.
7+
8+
**NOTE:** Increasing the value of this parameter (which lowers delay time) can increase log feed performance, but at could increase system load.
9+
{: .notice--info}
10+
11+
## log-fetch-retry-delay()
12+
13+
|Type:| integer|
14+
|Default:| `1`|
15+
16+
*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.

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

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,40 +24,16 @@ The `darwin-oslog()` source has the following options.
2424

2525
*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.
2626

27-
## fetch-delay()
28-
29-
|Type:| integer|
30-
|Default:| `10000`|
31-
32-
*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`.
33-
34-
**NOTE:** Increasing the value of this parameter (which lowers delay time) can increase log feed performance, but at could increase system load.
35-
{: .notice--info}
36-
37-
38-
## fetch-retry-delay()
39-
40-
|Type:| integer|
41-
|Default:| `1`|
42-
43-
*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.
44-
4527
## go-reverse()
4628

4729
|Type:| boolean|
4830
|Default:| `no`|
4931

5032
*Description:* If set to `yes`, the logs are processed in reverse order (latest to oldest).
5133

52-
## log-fetch-limit
53-
54-
**NOTE:** This option is currently disabled due to an OSLog API bug.
55-
{: .notice--info}
56-
57-
|Type:| integer|
58-
|Default:| `0`(unlimited)|
34+
{% include doc/admin-guide/options/log-fetch-delays.md %}
5935

60-
*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.
36+
{% include doc/admin-guide/options/log-fetch-limit.md %}
6137

6238
## max-bookmark-distance()
6339

doc/_dev-guide/chapter_4/section_2/macos-testing-status/system-source/01_collecting-native-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For more info, see [oslog](https://developer.apple.com/documentation/oslog?langu
5252
- boolean value, controls if {{ site.product.short_name }} should start reading logs from the oldest
5353
available at first start (or if no bookmark can be found)
5454
- default value: `no`
55-
- `fetch-delay()`
55+
- `log-fetch-delay()`
5656
- integer value, controls how much time {{ site.product.short_name }} should wait between reading/sending
5757
log messages, this is a fraction of a second, where wait_time = 1 second / n, so,
5858
e.g. n=1 means that only about 1 log will be read and sent in each second,
@@ -61,7 +61,7 @@ For more info, see [oslog](https://developer.apple.com/documentation/oslog?langu
6161
- Use with care, though lower delay time can increase log feed performance, at the
6262
same time could lead to a heavy system load!
6363
- default value: `10 000`
64-
- `fetch-retry-delay()`
64+
- `log-fetch-retry-delay()`
6565
- integer value, controls how many seconds {{ site.product.short_name }} will wait before a repeated
6666
attempt to read/send once it's out of available logs
6767
- default value: `1`

0 commit comments

Comments
 (0)