You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*Description:* This option can be used to enable or disable the chained hostname format. For more information, see the chain-hostnames() global option.
*Description:* This parameter assigns an emergency level to the messages
7
-
received from the {{ page.src | default: 'file' }} source if the message does not specify one. For
8
-
example, default-priority(warning).
10
+
*Description:* This option defines the default level value if the `PRIORITY` entry does not exist in the msg received from the {{ page.src | default: 'file' }} source.
Copy file name to clipboardExpand all lines: doc/_admin-guide/060_Sources/038_Kafka/001_Kafka_options.md
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
title: "Options of the kafka() source"
3
3
id: adm-src-kafka-opt
4
+
src: kafka
4
5
description: >-
5
6
This section describes the options of the kafka() source in {{ site.product.short_name }}.
6
7
---
@@ -13,18 +14,32 @@ To use the kafka() source, the following two options are required: bootstrap-ser
13
14
14
15
{% include doc/admin-guide/options/bootstrap-servers.md %}
15
16
17
+
{% include doc/admin-guide/options/chain-hostname.md %}
18
+
16
19
{% include doc/admin-guide/options/config-kafka.md kafka_type='consumer' type='source' protected_options='`bootstrap.servers``metadata.broker.list``enable.auto.offset.store``auto.offset.reset``enable.auto.commit``auto.commit.enable`' %}
17
20
21
+
{% include doc/admin-guide/options/default-facility.md %}
22
+
23
+
{% include doc/admin-guide/options/default-priority.md %}
24
+
18
25
{% include doc/admin-guide/options/disable-bookmarks.md %}
19
26
See Bookmarking in the kafka() source for more details.
20
27
28
+
{% include doc/admin-guide/options/dns-cache.md %}
29
+
21
30
{% include doc/admin-guide/options/hook.md %}
22
31
32
+
{% include doc/admin-guide/options/host-override.md %}
33
+
23
34
{% include doc/admin-guide/options/ignore-saved-bookmarks.md %} (depending on the setting of the read-old-records() option.\
24
35
See Bookmarking in the kafka() source for more details.
25
36
26
37
{% include doc/admin-guide/options/kafka-logging.md %}
27
38
39
+
{% include doc/admin-guide/options/keep-hostname.md %}
40
+
41
+
{% include doc/admin-guide/options/keep-timestamp.md %}
42
+
28
43
## log-fetch-limit()
29
44
30
45
| Type: | integer |
@@ -72,6 +87,8 @@ For example, with `workers(3)` and `fetch-limit(100000)`, the 2 processor worker
72
87
{% include doc/admin-guide/options/read-old-records.md %}\
73
88
See Bookmarking in the kafka() source for more details.
74
89
90
+
{% include doc/admin-guide/options/program-override.md %}
91
+
75
92
## separated-worker-queues()
76
93
77
94
| Type: | yes \| no |
@@ -82,6 +99,13 @@ See Bookmarking in the kafka() source for more details.
82
99
**NOTE:** This approach can improve performance, especially in high-throughput scenarios, but may also lead to significantly increased memory usage.
83
100
{: .notice--info}
84
101
102
+
## state-update-timeout()
103
+
104
+
| Type: | integer in milliseconds |
105
+
|Default:| 1000 |
106
+
107
+
*Description:* Specifies the maximum amount of time {{ site.product.short_name }} waits during Kafka broker state queries or other requests, such as metadata queries, partition offset queries/seeking, etc.
108
+
85
109
## strategy-hint()
86
110
87
111
| Accepted values: | assign, subscribe |
@@ -93,6 +117,10 @@ Why is it worth using dual consumer strategies? describes the differences betwee
93
117
94
118
For details about how the resulting topic names, partitions, and Kafka assign/subscribe strategies are determined in different scenarios, see Basic startegy usage cross-reference of the different topic configuration cases
95
119
120
+
{% include doc/admin-guide/options/tags.md %}
121
+
122
+
{% include doc/admin-guide/options/time-zone.md %}
123
+
96
124
## time-reopen()
97
125
98
126
| Type: | integer in seconds |
@@ -130,6 +158,10 @@ The partition number must be:
130
158
131
159
For details about how the resulting topic names, partitions, and Kafka assign/subscribe strategies are determined in different scenarios, see Basic startegy usage cross-reference of the different topic configuration cases and Why is it worth using dual consumer strategies?
*Description:* String for native macOS log message filtering using predicates. For example, the following predicate selects AirDrop logs: `subsystem=="com.apple.sharing" and category=="AirDrop"`
19
29
20
-
{% include doc/admin-guide/options/disable-bookmarks.md %}
21
-
22
30
## go-reverse()
23
31
24
32
|Type:| boolean|
@@ -28,10 +36,18 @@ The `darwin-oslog()` source has the following options.
28
36
29
37
{% include doc/admin-guide/options/hook.md %}
30
38
39
+
{% include doc/admin-guide/options/host-override.md %}
40
+
41
+
{% include doc/admin-guide/options/hook.md %}
42
+
31
43
{% include doc/admin-guide/options/ignore-saved-bookmarks.md %} (depending on the setting of the go-reverse() and the read-old-records() options.
32
44
33
45
{% include doc/admin-guide/options/deprecated-options.md old='do-not-use-bookmark()' new='ignore-saved-bookmarks()' %}
34
46
47
+
{% include doc/admin-guide/options/keep-hostname.md %}
48
+
49
+
{% include doc/admin-guide/options/keep-timestamp.md %}
50
+
35
51
{% include doc/admin-guide/options/log-fetch-delays.md %}
36
52
37
53
{% include doc/admin-guide/options/log-fetch-limit.md %}
@@ -43,4 +59,15 @@ The `darwin-oslog()` source has the following options.
43
59
44
60
*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.
45
61
62
+
{% include doc/admin-guide/options/program-override.md %}
63
+
46
64
{% include doc/admin-guide/options/read-old-records.md %}
65
+
66
+
{% include doc/admin-guide/options/tags.md %}
67
+
68
+
{% include doc/admin-guide/options/time-zone.md %}
Copy file name to clipboardExpand all lines: doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md
+5-25Lines changed: 5 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
---
2
2
title: syslog-ng-otlp() source options
3
3
id: adm-src-sng-otlp-opt
4
+
src: syslog-ng-otlp
5
+
priority_default: notice
4
6
description: >-
5
7
This section describes the options of the syslog-ng-otlp() source in {{ site.product.short_name }}.
6
8
---
@@ -66,12 +68,7 @@ destination {
66
68
};
67
69
```
68
70
69
-
## chain-hostname()
70
-
71
-
| Type:|`yes`, `no`|
72
-
|Default:|`no`|
73
-
74
-
*Description:* This option can be used to enable or disable the chained hostname format. For more information, see the chain-hostnames() global option.
71
+
{% include doc/admin-guide/options/chain-hostname.md %}
75
72
76
73
{% include doc/admin-guide/options/channel-args.md %}
77
74
@@ -82,28 +79,11 @@ destination {
82
79
83
80
*Description:* This option configures the upper limit of in-flight gRPC requests per worker. It is advisd to set this value in the range of 10s or 100s when there are a high number of clients sending simultaneously. In an optimized solution, the number of `workers()` and `concurrent-requests()` is greater than or equal to the number of clients. However, this can cause an increase in memory usage.
84
81
85
-
## default-facility()
86
-
87
-
| Type:| facility string|
88
-
|Default:| kern|
89
-
90
-
*Description:* This option assigns a facility value to messages received from the file source if the message does not specify one.
91
-
92
-
## default-level()
93
-
94
-
| Type:| string|
95
-
|Default:| notice|
96
-
97
-
*Description:* This option defines the default level value if the `PRIORITY` entry does not exist.
82
+
{% include doc/admin-guide/options/default-facility.md %}
98
83
99
84
{% include doc/admin-guide/options/default-priority.md %}
100
85
101
-
## dns-cache()
102
-
103
-
| Type:|`yes`, `no`|
104
-
|Default:|`no`|
105
-
106
-
*Description:* This option enables or disables the DNS cache usage.
86
+
{% include doc/admin-guide/options/dns-cache.md %}
0 commit comments