Skip to content

Commit 4d50711

Browse files
committed
Merge branch 'master' into darwinosl-options
Signed-off-by: Hofi <hofione@gmail.com>
2 parents db47ce0 + f334aef commit 4d50711

File tree

4 files changed

+20
-22
lines changed

4 files changed

+20
-22
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
|Type:| integer|
44
|Default:| `10000`|
55

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`.
6+
*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`.
77

8-
**NOTE:** Increasing the value of this parameter (which lowers delay time) can increase log feed performance, but at could increase system load.
8+
**NOTE:** Increasing the value of this parameter (which reduces the delay time) can improve log feed performance, but it may also increase system load.
99
{: .notice--info}
1010

1111
{% include doc/admin-guide/options/deprecated-options.md old='fetch-delay' new='log-fetch-delay' %}
@@ -15,6 +15,6 @@
1515
|Type:| integer|
1616
|Default:| `1`|
1717

18-
*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.
18+
*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.
1919

2020
{% include doc/admin-guide/options/deprecated-options.md old='fetch-retry-delay' new='log-fetch-retry-delay' %}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: darwin-oslog() source options
33
id: adm-src-darw-osl-opt
44
description: >-
5-
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.
5+
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.
66
---
77

88
**NOTE:** The persistent OSLog store keeps about 7 days of logs on the disk.
@@ -22,7 +22,7 @@ The `darwin-oslog()` source has the following options.
2222
|Type:| boolean|
2323
|Default:| `no`|
2424

25-
*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.
25+
*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.
2626

2727
## go-reverse()
2828

@@ -40,11 +40,11 @@ The `darwin-oslog()` source has the following options.
4040
|Type:| integer|
4141
|Default:| `0`(unlimited) [seconds]|
4242

43-
*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.
43+
*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.
4444

4545
## read-old-records()
4646

4747
|Type:| boolean|
4848
|Default:| `no`|
4949

50-
*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.
50+
*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/070_Destinations/100_Kafka-c/003_Kafka-c_options.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,19 @@ key(\"${PROGRAM}\").
149149

150150
{% include doc/admin-guide/options/local-time-zone.md %}
151151

152+
## message()
153+
154+
| Type:| message template|
155+
|Default:| ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
156+
157+
*Description:* The message as published to Apache Kafka. You can use
158+
templates and template functions (for example, format-json()) to format
159+
the message, for example, template(\"$(format-json \--scope rfc5424
160+
\--exclude DATE \--key ISODATE)\").
161+
162+
For details on formatting messages in JSON format, see
163+
[[format-json|adm-temp-func#format-json]].
164+
152165
{% include doc/admin-guide/options/on-error.md %}
153166

154167
{% include doc/admin-guide/options/persist-name.md %}
@@ -196,19 +209,6 @@ recommends that you set sync-send() to "yes", as this setting
196209
delivers messages to the Kafka client more reliably.
197210
{: .notice--danger}
198211

199-
## message()
200-
201-
| Type:| message template|
202-
|Default:| ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
203-
204-
*Description:* The message as published to Apache Kafka. You can use
205-
templates and template functions (for example, format-json()) to format
206-
the message, for example, template(\"$(format-json \--scope rfc5424
207-
\--exclude DATE \--key ISODATE)\").
208-
209-
For details on formatting messages in JSON format, see
210-
[[format-json|adm-temp-func#format-json]].
211-
212212
{% include doc/admin-guide/options/throttle.md %}
213213

214214
{% include doc/admin-guide/options/time-zone.md %}

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,6 @@ For more info, see [oslog](https://developer.apple.com/documentation/oslog?langu
6666
attempt to read/send once it's out of available logs
6767
- default value: `1`
6868
- `log-fetch-limit()`
69-
- **Warning**: _This option is now disabled due to an [OSLog API bug](https://openradar.appspot.com/radar?id=5597032077066240), once it's fixed it_
70-
_will be enabled again_
7169
- integer value, that limits the number of logs {{ site.product.short_name }} will send in one run
7270
- default value: `0`, which means no limit
7371

0 commit comments

Comments
 (0)