Skip to content

Commit 7bf533d

Browse files
committed
sources: started to add the missing common source options
Signed-off-by: Hofi <[email protected]>
1 parent af5b282 commit 7bf533d

File tree

9 files changed

+90
-40
lines changed

9 files changed

+90
-40
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## chain-hostname()
2+
3+
| Type:| `yes`, `no`|
4+
|Default:| `no`|
5+
6+
*Description:* This option can be used to enable or disable the chained hostname format. For more information, see the chain-hostnames() global option.
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1+
## default-level()
2+
3+
This is just an alias of default-priority().
4+
15
## default-priority()
26

37
| Type:| priority string |
48
| Default: | {{ page.priority_default | default: '' }} |
59

6-
*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.
11+
For example, `default-priority(warning)`.
12+
13+
## default-severity()
14+
15+
This is just an alias of default-priority().
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## dns-cache()
2+
3+
| Type:| `yes`, `no`|
4+
|Default:| `no`|
5+
6+
*Description:* This option enables or disables the DNS cache usage.

doc/_admin-guide/060_Sources/020_File/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,6 @@ source s_tail {
4848

4949
**NOTE:** If the message does not have a proper syslog header, syslog-ng
5050
treats messages received from files as sent by the kern facility. Use
51-
the **default-facility()** and **default-priority()** options in the
51+
the default-facility() and default-priority() options in the
5252
source definition to assign a different facility if needed.
5353
{: .notice--info}

doc/_admin-guide/060_Sources/021_Wildcard-file/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Note the following important points:
5050

5151
- If the message does not have a proper syslog header, {{ site.product.short_name }}
5252
treats messages received from files as sent by the user facility.
53-
Use the **default-facility()** and **default-priority()** options in
53+
Use the default-facility() and default-priority() options in
5454
the source definition to assign a different facility if needed.
5555

5656
- For every message that {{ site.product.short_name }} reads from the source files,

doc/_admin-guide/060_Sources/038_Kafka/001_Kafka_options.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Options of the kafka() source"
33
id: adm-src-kafka-opt
4+
src: kafka
45
description: >-
56
This section describes the options of the kafka() source in {{ site.product.short_name }}.
67
---
@@ -13,18 +14,32 @@ To use the kafka() source, the following two options are required: bootstrap-ser
1314

1415
{% include doc/admin-guide/options/bootstrap-servers.md %}
1516

17+
{% include doc/admin-guide/options/chain-hostname.md %}
18+
1619
{% 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`' %}
1720

21+
{% include doc/admin-guide/options/default-facility.md %}
22+
23+
{% include doc/admin-guide/options/default-priority.md %}
24+
1825
{% include doc/admin-guide/options/disable-bookmarks.md %}
1926
See Bookmarking in the kafka() source for more details.
2027

28+
{% include doc/admin-guide/options/dns-cache.md %}
29+
2130
{% include doc/admin-guide/options/hook.md %}
2231

32+
{% include doc/admin-guide/options/host-override.md %}
33+
2334
{% include doc/admin-guide/options/ignore-saved-bookmarks.md %} (depending on the setting of the read-old-records() option.\
2435
See Bookmarking in the kafka() source for more details.
2536

2637
{% include doc/admin-guide/options/kafka-logging.md %}
2738

39+
{% include doc/admin-guide/options/keep-hostname.md %}
40+
41+
{% include doc/admin-guide/options/keep-timestamp.md %}
42+
2843
## log-fetch-limit()
2944

3045
| Type: | integer |
@@ -72,6 +87,8 @@ For example, with `workers(3)` and `fetch-limit(100000)`, the 2 processor worker
7287
{% include doc/admin-guide/options/read-old-records.md %}\
7388
See Bookmarking in the kafka() source for more details.
7489

90+
{% include doc/admin-guide/options/program-override.md %}
91+
7592
## separated-worker-queues()
7693

7794
| Type: | yes \| no |
@@ -82,6 +99,13 @@ See Bookmarking in the kafka() source for more details.
8299
**NOTE:** This approach can improve performance, especially in high-throughput scenarios, but may also lead to significantly increased memory usage.
83100
{: .notice--info}
84101

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+
85109
## strategy-hint()
86110

87111
| Accepted values: | assign, subscribe |
@@ -93,6 +117,10 @@ Why is it worth using dual consumer strategies? describes the differences betwee
93117

94118
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
95119

120+
{% include doc/admin-guide/options/tags.md %}
121+
122+
{% include doc/admin-guide/options/time-zone.md %}
123+
96124
## time-reopen()
97125

98126
| Type: | integer in seconds |
@@ -130,6 +158,10 @@ The partition number must be:
130158

131159
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?
132160

161+
{% include doc/admin-guide/options/use-dns.md %}
162+
163+
{% include doc/admin-guide/options/use-fqdn.md %}
164+
133165
## workers()
134166

135167
| Type: | integer |

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

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,23 @@ description: >-
1010

1111
The `darwin-oslog()` source has the following options.
1212

13+
{% include doc/admin-guide/options/chain-hostname.md %}
14+
15+
{% include doc/admin-guide/options/default-facility.md %}
16+
17+
{% include doc/admin-guide/options/default-priority.md %}
18+
19+
{% include doc/admin-guide/options/disable-bookmarks.md %}
20+
21+
{% include doc/admin-guide/options/dns-cache.md %}
22+
1323
## filter-predicate()
1424

1525
|Type:| string|
1626
|Default:|`(eventType == 'logEvent' || eventType == 'lossEvent' || eventType == 'stateEvent' || eventType == 'userActionEvent') && (logType != 'debug')`|
1727

1828
*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"`
1929

20-
{% include doc/admin-guide/options/disable-bookmarks.md %}
21-
2230
## go-reverse()
2331

2432
|Type:| boolean|
@@ -28,10 +36,18 @@ The `darwin-oslog()` source has the following options.
2836

2937
{% include doc/admin-guide/options/hook.md %}
3038

39+
{% include doc/admin-guide/options/host-override.md %}
40+
41+
{% include doc/admin-guide/options/hook.md %}
42+
3143
{% include doc/admin-guide/options/ignore-saved-bookmarks.md %} (depending on the setting of the go-reverse() and the read-old-records() options.
3244

3345
{% include doc/admin-guide/options/deprecated-options.md old='do-not-use-bookmark()' new='ignore-saved-bookmarks()' %}
3446

47+
{% include doc/admin-guide/options/keep-hostname.md %}
48+
49+
{% include doc/admin-guide/options/keep-timestamp.md %}
50+
3551
{% include doc/admin-guide/options/log-fetch-delays.md %}
3652

3753
{% include doc/admin-guide/options/log-fetch-limit.md %}
@@ -43,4 +59,15 @@ The `darwin-oslog()` source has the following options.
4359

4460
*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.
4561

62+
{% include doc/admin-guide/options/program-override.md %}
63+
4664
{% 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 %}
69+
70+
{% include doc/admin-guide/options/use-dns.md %}
71+
72+
{% include doc/admin-guide/options/use-fqdn.md %}
73+

doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: syslog-ng-otlp() source options
33
id: adm-src-sng-otlp-opt
4+
src: syslog-ng-otlp
5+
priority_default: notice
46
description: >-
57
This section describes the options of the syslog-ng-otlp() source in {{ site.product.short_name }}.
68
---
@@ -66,12 +68,7 @@ destination {
6668
};
6769
```
6870

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 %}
7572

7673
{% include doc/admin-guide/options/channel-args.md %}
7774

@@ -82,28 +79,11 @@ destination {
8279

8380
*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.
8481

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 %}
9883

9984
{% include doc/admin-guide/options/default-priority.md %}
10085

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 %}
10787

10888
## ebpf()
10989

doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,6 @@ The systemd-journal() driver has the following options:
1414

1515
{% include doc/admin-guide/options/default-priority.md %}
1616

17-
## default-level()
18-
19-
|Type: |string|
20-
|Default: |notice|
21-
22-
*Description:* The default level value if the `PRIORITY` entry does not
23-
exist.
24-
2517
{% include doc/admin-guide/options/hook.md %}
2618

2719
{% include doc/admin-guide/options/host-override.md %}

0 commit comments

Comments
 (0)