Skip to content

Commit e430575

Browse files
committed
Admin: config: yaml: more cleanup
Signed-off-by: Lynette Miles <[email protected]>
1 parent 66ba277 commit e430575

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

administration/configuring-fluent-bit/yaml/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# YAML configuration
22

3-
## Before You Get Started
3+
## Before you get started
44

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.
66

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.
88

99
As of Fluent Bit v3.2, you can configure everything in YAML.
1010

11-
## List of Available Sections
11+
## List of available sections
1212

1313
Configuring Fluent Bit with YAML introduces the following root-level sections:
1414

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
2626

2727
To access detailed configuration guides for each section, use the following links:
2828

administration/configuring-fluent-bit/yaml/pipeline-section.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pipeline:
5050
5151
Processors operate on specific signals such as logs, metrics, and traces. They're attached to an input plugin and must specify the signal type they will process.
5252
53-
### Example of a Processor
53+
### Example of a processor
5454
5555
In the following example, the `content_modifier` processor inserts or updates (upserts) the key `my_new_key` with the value `123` for all log records generated by the tail plugin. This processor is only applied to log signals:
5656

@@ -141,19 +141,19 @@ pipeline:
141141

142142
Processors can be attached to inputs and outputs.
143143

144-
### How Processors are different from Filters
144+
### How processors are different from filters
145145

146146
While processors and filters are similar in that they can transform, enrich, or drop data from the pipeline, there is a significant difference in how they operate:
147147

148148
- Processors: Run in the same thread as the input plugin when the input plugin is configured to be threaded (threaded: true). This design provides better performance, especially in multi-threaded setups.
149149

150150
- Filters: Run in the main event loop. When multiple filters are used, they can introduce performance overhead, particularly under heavy workloads.
151151

152-
## Running Filters as Processors
152+
## Running filters as processors
153153

154154
You can configure existing [Filters](https://docs.fluentbit.io/manual/pipeline/filters) to run as processors. There are no specific changes needed; you use the filter name as if it were a native processor.
155155

156-
### Example of a Filter running as a Processor
156+
### Example of a filter running as a processor
157157

158158
In the following example, the `grep` filter is used as a processor to filter log events based on a pattern:
159159

administration/configuring-fluent-bit/yaml/plugins-section.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Plugins
22

3-
Fluent Bit comes with a variety of built-in plugins, and also supports loading external plugins at runtime. This feature is especially useful for loading Go or WebAssembly (Wasm) plugins that are built as shared object files (.so). Fluent Bit YAML configuration provides the following ways to load these external plugins:
3+
Fluent Bit comes with a variety of built-in plugins, and also supports loading external plugins at runtime. This feature is especially useful for loading Go or WebAssembly (Wasm) plugins that are built as shared object files (`.so`). Fluent Bit YAML configuration provides the following ways to load these external plugins:
44

55
## Inline YAML
66

0 commit comments

Comments
 (0)