|
1 | 1 | # YAML configuration
|
2 | 2 |
|
3 |
| -## Before You Get Started |
| 3 | +## Before you get started |
4 | 4 |
|
5 |
| -Fluent Bit traditionally offered a `classic` configuration mode, a custom configuration format that we are gradually phasing out. While `classic` mode has served well for many years, it has several limitations. Its basic design only supports grouping sections with key-value pairs and lacks the ability to handle sub-sections or complex data structures like lists. |
| 5 | +Fluent Bit traditionally offered a `classic` configuration mode, a custom configuration format that's phasing out. While `classic` mode has served well for many years, it has several limitations. Its basic design only supports grouping sections with key-value pairs and lacks the ability to handle sub-sections or complex data structures like lists. |
6 | 6 |
|
7 |
| -YAML, now a mainstream configuration format, has become essential in a cloud ecosystem where everything is configured this way. To minimize friction and provide a more intuitive experience for creating data pipelines, we strongly encourage users to transition to YAML. The YAML format enables features, such as processors, that are not possible to configure in `classic` mode. |
| 7 | +YAML has become essential in a cloud ecosystem. To minimize friction and provide a more intuitive experience for creating data pipelines, users are encouraged to transition to YAML. The YAML format enables features, such as processors, that aren't possible to configure in `classic` mode. |
8 | 8 |
|
9 | 9 | As of Fluent Bit v3.2, you can configure everything in YAML.
|
10 | 10 |
|
11 |
| -## List of Available Sections |
| 11 | +## List of available sections |
12 | 12 |
|
13 | 13 | Configuring Fluent Bit with YAML introduces the following root-level sections:
|
14 | 14 |
|
15 |
| -| Section Name |Description | |
16 |
| -|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| |
17 |
| -| `service` | Describes the global configuration for the Fluent Bit service. This section is optional; if not set, default values will apply. Only one `service` section can be defined. | |
18 |
| -| `parsers` | Lists parsers to be used by components like inputs, processors, filters, or output plugins. You can define multiple `parsers` sections, which can also be loaded from external files included in the main YAML configuration. | |
19 |
| -| `multiline_parsers` | Lists multiline parsers, functioning similarly to `parsers`. Multiple definitions can exist either in the root or in included files. | |
20 |
| -| `pipeline` | Defines a pipeline composed of inputs, processors, filters, and output plugins. You can define multiple `pipeline` sections, but they will not operate independently. Instead, all components will be merged into a single pipeline internally. | |
21 |
| -| `plugins` | Specifies the path to external plugins (.so files) to be loaded by Fluent Bit at runtime. | |
22 |
| -| `upstream_servers` | Refers to a group of node endpoints that can be referenced by output plugins that support this feature. | |
23 |
| -| `env` | Sets a list of environment variables for Fluent Bit. Note that system environment variables are available, while the ones defined in the configuration apply only to Fluent Bit. | |
24 |
| - |
25 |
| -## Section Documentation |
| 15 | +| Section Name | Description | |
| 16 | +|--------------|-------------| |
| 17 | +| `service` | Describes the global configuration for the Fluent Bit service. Optional. If not set, default values will apply. Only one `service` section can be defined. | |
| 18 | +| `parsers` | Lists parsers to be used by components like inputs, processors, filters, or output plugins. You can define multiple `parsers` sections, which can also be loaded from external files included in the main YAML configuration. | |
| 19 | +| `multiline_parsers` | Lists multiline parsers, functioning similarly to `parsers`. Multiple definitions can exist either in the root or in included files. | |
| 20 | +| `pipeline` | Defines a pipeline composed of inputs, processors, filters, and output plugins. You can define multiple `pipeline` sections, but they won't operate independently. Instead, all components will be merged into a single pipeline internally. | |
| 21 | +| `plugins` | Specifies the path to external plugins (`.so` files) to be loaded by Fluent Bit at runtime. | |
| 22 | +| `upstream_servers` | Refers to a group of node endpoints that can be referenced by output plugins that support this feature. | |
| 23 | +| `env` | Sets a list of environment variables for Fluent Bit. System environment variables are available, while the ones defined in the configuration apply only to Fluent Bit. | |
| 24 | + |
| 25 | +## Section documentation |
26 | 26 |
|
27 | 27 | To access detailed configuration guides for each section, use the following links:
|
28 | 28 |
|
|
0 commit comments