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
{{ message }}
Repository navigation
Commit 7e2c8c7
Browse filesBrowse the repository at this point in the historyBrowse files
docs: fix Vale and markdownlint findings across PR files
Resolve all Vale errors and suggestions in the config example validation
PR, plus markdownlint errors in the new scripts README.
- scripts/README.md: replace "e.g.," with "for example," (3 instances),
convert 5 headings to sentence case, use "aren't" contraction, and fix
markdownlint MD031/MD032/MD040 by adding blank lines around fences and
lists and switching nested Markdown examples to 4-backtick outer fences
- installation/downloads/docker.md: spell out "K8s" as "Kubernetes"
- pipeline/inputs/tail.md: use "`inode` numbers" so the term is in code
font and skipped by the spelling rule
- pipeline/filters/parser.md: use "shouldn't" contraction
- pipeline/outputs/kafka.md: use "isn't" contraction
- pipeline/parsers.md: remove leading ellipsis and rewrite as a complete
sentence
Signed-off-by: Eric D. Schabell <eric@schabell.org>
When the Linux inotify event queue overflows (indicated by an `IN_Q_OVERFLOW` event), Fluent Bit automatically reconciles all monitored files. During reconciliation it:
169
169
170
-
- Detects rotated files by comparing inodes and file names and re-registers watches as needed.
170
+
- Detects rotated files by comparing `inode` numbers and file names and re-registers watches as needed.
171
171
- Resets offset tracking for files that have been truncated.
172
172
- Retries watch registration for files that previously failed, for example due to `ENOSPC` when `fs.inotify.max_user_watches` is exhausted.
Copy file name to clipboardExpand all lines: pipeline/outputs/kafka.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ pipeline:
88
88
89
89
### Avro support
90
90
91
-
Fluent Bit comes with support for Avro encoding for the `out_kafka` plugin but this is not enabled by default for releases.
91
+
Fluent Bit comes with support for Avro encoding for the `out_kafka` plugin but this isn't enabled by default for releases.
92
92
93
93
Avro support is optional and must be activated at build time by using a build definition with `cmake`: `-DFLB_AVRO_ENCODER=On` such as in the following example which activates:
Copy file name to clipboardExpand all lines: scripts/README.md
+24-14Lines changed: 24 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,15 @@
1
-
# Documentation Scripts
1
+
# Documentation scripts
2
2
3
3
This directory contains utility scripts for validating Fluent Bit configuration examples in the documentation.
4
4
5
-
## Configuration Validation
5
+
## Configuration validation
6
6
7
7
### `test-config.sh`
8
8
9
9
Validates all Fluent Bit configuration examples in Markdown files by running them through `fluent-bit --dry-run`.
10
10
11
11
**Usage:**
12
+
12
13
```bash
13
14
./scripts/test-config.sh <markdown-file>
14
15
```
@@ -23,6 +24,7 @@ The script uses a **two-stage approach** to ensure reliable error reporting:
23
24
This approach ensures that extraction errors are always legitimate—never due to reaching the end of examples. Any extraction error indicates a genuine problem with the file structure.
24
25
25
26
**Features:**
27
+
26
28
- Supports multiple examples per Markdown file (processes all examples)
27
29
- Validates both YAML (`fluent-bit.yaml`) and legacy `.conf` (`fluent-bit.conf`) formats
28
30
- Reports all validation failures for a file (doesn't stop at first failure)
@@ -31,11 +33,13 @@ This approach ensures that extraction errors are always legitimate—never due t
31
33
- Only reports errors that are legitimate (malformed examples or configuration issues)
32
34
33
35
**Example - validate a single file:**
36
+
34
37
```bash
35
38
./scripts/test-config.sh pipeline/inputs/tail.md
36
39
```
37
40
38
41
**Example - validate all documentation files:**
42
+
39
43
```bash
40
44
find . -type f -iname "*.md"|whileread -r file;do
41
45
if! ./scripts/test-config.sh "$file";then
@@ -49,22 +53,26 @@ done
49
53
Extracts Fluent Bit configuration code blocks from Markdown files. This is used internally by `test-config.sh` but can also be called directly.
@@ -82,21 +90,23 @@ Extracts Fluent Bit configuration code blocks from Markdown files. This is used
82
90
**Count mode:**
83
91
84
92
The `count` parameter returns the total number of matching code fences for the specified language in the given tab. This is used by `test-config.sh` to:
93
+
85
94
1. Determine how many examples to validate
86
95
2. Avoid trying to extract examples that don't exist
Configuration examples should be formatted using Gitbook-style tabs:
98
108
99
-
```markdown
109
+
````markdown
100
110
{% tabs %}
101
111
{% tab title="fluent-bit.yaml" %}
102
112
```yaml
@@ -111,12 +121,12 @@ service:
111
121
```
112
122
{% endtab %}
113
123
{% endtabs %}
114
-
```
124
+
````
115
125
116
126
Multiple examples in the same file are supported:
117
127
118
-
```markdown
119
-
## First Example
128
+
````markdown
129
+
## First example
120
130
121
131
{% tabs %}
122
132
{% tab title="fluent-bit.yaml" %}
@@ -126,7 +136,7 @@ Multiple examples in the same file are supported:
126
136
{% endtab %}
127
137
{% endtabs %}
128
138
129
-
## Second Example
139
+
## Second example
130
140
131
141
{% tabs %}
132
142
{% tab title="fluent-bit.yaml" %}
@@ -135,14 +145,14 @@ Multiple examples in the same file are supported:
135
145
```
136
146
{% endtab %}
137
147
{% endtabs %}
138
-
```
148
+
````
139
149
140
-
## Suppression List
150
+
## Suppression list
141
151
142
152
Some configuration examples are intentionally skipped in validation. These are configured in the `SUPPRESSED_FILES` array in `test-config.sh`. Files are suppressed if they:
143
153
144
154
- Require additional plugins not included in the standard container image
145
-
- Contain examples that are not yet supported
155
+
- Contain examples that aren't yet supported
146
156
- Are Windows-specific configurations
147
157
148
158
Refer to the comments in `test-config.sh` for the complete list and reasons for each suppression.
0 commit comments