Skip to content

Commit 025f69e

Browse files
committed
Admin: config: yaml: config: final style
Signed-off-by: Lynette Miles <[email protected]>
1 parent f48a996 commit 025f69e

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

administration/configuring-fluent-bit/yaml/configuration-file.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The YAML configuration file doesn't support the following sections:
2626
YAML configuration is used in the smoke tests for containers. An always-correct up-to-date example is here: <https://github.com/fluent/fluent-bit/blob/master/packaging/testing/smoke/container/fluent-bit.yaml>.
2727
{% endhint %}
2828

29-
## Env
29+
## `env`
3030

3131
The `env` section allows the definition of configuration variables that will be used later in the configuration file.
3232

@@ -79,7 +79,7 @@ The `service` section defines the global properties of the service. The Service
7979
| `coro_stack_size` | Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small a value (for example, `4096`), or coroutine threads can overrun the stack buffer. Don't change the default value of this parameter unless you know what you are doing. | `24576` |
8080
| `scheduler.cap` | Set a maximum retry time in seconds. Supported from v1.8.7. | `2000` |
8181
| `scheduler.base` | Sets the base of exponential backoff. Supported from v1.8.7. | `5` |
82-
| `json.convert_nan_to_null` | If enabled, NaN is converted to null when fluent-bit converts msgpack to JSON. | `false` |
82+
| `json.convert_nan_to_null` | If enabled, NaN is converted to null when Fluent Bit converts `msgpack` to JSON. | `false` |
8383
| `sp.convert_from_str_to_num` | If enabled, Stream processor converts from number string to number type. | `true |
8484

8585
The following is an example of a `service` section:
@@ -122,7 +122,7 @@ pipeline:
122122
port: 8080
123123
```
124124

125-
This pipeline consists of two `inputs`: a tail plugin and an HTTP server plugin. Each plugin has its own map in the array of `inputs` consisting of simple properties. To use more advanced properties that consist of multiple values the property itself can be defined using an array, such as the `record` and `allowlist_key` properties for the `record_modifier` `filter`:
125+
This pipeline consists of two `inputs`: a tail plugin and an HTTP server plugin. Each plugin has its own map in the array of `inputs` consisting of basic properties. To use more advanced properties that consist of multiple values the property itself can be defined using an array, such as the `record` and `allowlist_key` properties for the `record_modifier` `filter`:
126126

127127
```yaml
128128
pipeline:
@@ -214,7 +214,7 @@ pipeline:
214214
match: 'my*cpu'
215215
```
216216

217-
#### Example: collecting CPU metrics
217+
#### Collecting `cpu` metrics example
218218

219219
The following configuration file example demonstrates how to collect CPU metrics and flush the results every five seconds to the standard output:
220220

@@ -235,7 +235,7 @@ pipeline:
235235

236236
## Processors
237237

238-
Fluent-Bit 2.1.2 and greater implements an interface called "processor" to extend the processing capabilities in input and output plugins directly without routing the data. The input and output plugins can run in separate threads. This interface allows users to apply data transformations and filtering to incoming data records before they're processed further in the pipeline.
238+
Fluent Bit 2.1.2 and greater implements an interface called `processor` to extend the processing capabilities in input and output plugins directly without routing the data. The input and output plugins can run in separate threads. This interface allows users to apply data transformations and filtering to incoming data records before they're processed further in the pipeline.
239239

240240
This capability is only exposed in YAML configuration and not in classic configuration mode due to the restriction of nested levels of configuration.
241241

vale-styles/FluentBit/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,3 +121,4 @@ exceptions:
121121
- VS
122122
- WebSocket
123123
- Windows
124+
- YAML

0 commit comments

Comments
 (0)