Skip to content

Commit 4f7355c

Browse files
authored
docs: standard-input: fix config params, case, code blocks (#2352)
- Fix config parameter table keys to use lowercase (buffer_size, parser, threaded) to match docs standards - Fix classic config examples to use title case (Name, Format, Regex, Parsers_File) - Change code block language from bash to shell for script examples Fixes #2351 Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 1ee6a9f commit 4f7355c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pipeline/inputs/standard-input.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ The plugin supports the following configuration parameters:
1515

1616
| Key | Description | Default |
1717
|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
18-
| `Buffer_Size` | Set the buffer size to read data. This value is used to increase buffer size and must be set according to the [Unit Size](../../administration/configuring-fluent-bit.md#unit-sizes) specification. | `16k` |
19-
| `Parser` | The name of the parser to invoke instead of the default JSON input parser. | _none_ |
20-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
18+
| `buffer_size` | Set the buffer size to read data. This value is used to increase buffer size and must be set according to the [Unit Size](../../administration/configuring-fluent-bit.md#unit-sizes) specification. | `16k` |
19+
| `parser` | The name of the parser to invoke instead of the default JSON input parser. | _none_ |
20+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2121

2222
## Input formats
2323

@@ -51,7 +51,7 @@ To demonstrate how the plugin works, you can use a `bash` script that generates
5151

5252
1. Write the following content in a file named `test.sh`:
5353

54-
```bash
54+
```shell
5555
#!/bin/sh
5656

5757
for ((i=0; i<=5; i++)); do
@@ -81,7 +81,7 @@ To demonstrate how the plugin works, you can use a `bash` script that generates
8181
8282
1. An input event timestamp can also be supplied. Replace `test.sh` with:
8383
84-
```bash
84+
```shell
8585
#!/bin/sh
8686
8787
for ((i=0; i<=5; i++)); do
@@ -118,7 +118,7 @@ To demonstrate how the plugin works, you can use a `bash` script that generates
118118
119119
1. Additional metadata is supported in Fluent Bit v2.1.0 and later by replacing the timestamp with a two-element object. For example:
120120
121-
```bash
121+
```shell
122122
#!/bin/sh
123123
for ((i=0; i<=5; i++)); do
124124
echo -n "
@@ -181,10 +181,10 @@ parsers:
181181

182182
```text
183183
[PARSER]
184-
name stringify_message
185-
format regex
184+
Name stringify_message
185+
Format regex
186186
Key_Name message
187-
regex ^(?<message>.*)
187+
Regex ^(?<message>.*)
188188
```
189189

190190
{% endtab %}
@@ -215,7 +215,7 @@ pipeline:
215215
216216
```text
217217
[SERVICE]
218-
parsers_file parsers.conf
218+
Parsers_File parsers.conf
219219

220220
[INPUT]
221221
Name stdin

0 commit comments

Comments
 (0)