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
Copy file name to clipboardExpand all lines: administration/configuring-fluent-bit.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
@@ -1,6 +1,6 @@
1
1
# Configure Fluent Bit
2
2
3
-
Fluent Bit uses configuration files to store information about your specified [inputs](../data-pipeline/inputs.md), [outputs](../data-pipeline/outputs.md), [filters](../data-pipeline/filters.md), and more. You can write these configuration files in one of these formats:
3
+
Fluent Bit uses configuration files to store information about your specified [inputs](../pipeline/inputs.md), [outputs](../pipeline/outputs.md), [filters](../pipeline/filters.md), and more. You can write these configuration files in one of these formats:
4
4
5
5
-[YAML configuration files](./configuring-fluent-bit/yaml.md) are the standard configuration format as of Fluent Bit v3.2. They use the `.yaml` file extension.
6
6
-[Classic configuration files](./configuring-fluent-bit/classic-mode.md) will be deprecated at the end of 2026. They use the `.conf` file extension.
In Fluent Bit v3.2 and later, YAML configuration files support all of the settings
6
-
and features that [classic configuration files](../administration/configuring-fluent-bit/classic-mode.md) support, plus additional features that classic configuration files
6
+
and features that [classic configuration files](./classic-mode.md) support, plus additional features that classic configuration files
7
7
don't support, like processors.
8
8
9
9
YAML configuration files support the following top-level sections:
-`includes`: Specifies additional YAML configuration files to [include as part of a parent file](../administration/configuring-fluent-bit/yaml/includes-section).
13
-
-`service`: Configures global properties of the Fluent Bit [service](../administration/configuring-fluent-bit/yaml/service-section).
14
-
-`pipeline`: Configures active [`inputs`, `filters`, and `outputs`](../administration/configuring-fluent-bit/yaml/pipeline-section).
-`plugins`: Defines paths for [custom plugins](./yaml/plugins-section).
18
+
-`upstream_servers`: Defines [nodes](./yaml/upstream-servers-section) for output plugins.
19
19
20
20
{% hint style="info" %}
21
21
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>.
Copy file name to clipboardExpand all lines: administration/configuring-fluent-bit/yaml/service-section.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,22 +11,22 @@ The `service` section defines global properties of the service. The available co
11
11
|`dns.mode`| Sets the primary transport layer protocol used by the asynchronous DNS resolver. Can be overridden on a per-plugin basis. |`UDP`|
12
12
|`log_file`| Absolute path for an optional log file. By default, all logs are redirected to the standard error interface (`stderr`). |_none_|
13
13
|`log_level`| Sets the logging verbosity level. Possible values: `off`, `error`, `warn`, `info`, `debug`, and `trace`. Values are cumulative. For example, if `debug` is set, it will include `error`, `warning`, `info`, and `debug`. The `trace` mode is only available if Fluent Bit was built with the `WITH_TRACE` option enabled. |`info`|
14
-
|`parsers_file`| Path for a parsers configuration file. Multiple `parsers_file` entries can be defined within the section. Parsers can be declared directly in the [`parsers` section](../administration/configuring-fluent-bit/yaml/parsers-section.md) of YAML configuration files. |_none_|
15
-
|`plugins_file`| Path for a `plugins` configuration file. This file specifies the paths to custom plugins (.so files) that Fluent Bit can load at runtime. Plugins can be declared directly in the [`plugins` section](../administration/configuring-fluent-bit/yaml/plugins-section.md) of YAML configuration files. |_none_|
16
-
|`streams_file`| Path for the [stream processor](../stream-processing/overview.md) configuration file. This file defines the rules and operations for stream processing in Fluent Bit. Stream processor configurations can also be defined directly in the `streams` section of YAML configuration files. |_none_|
14
+
|`parsers_file`| Path for a parsers configuration file. Multiple `parsers_file` entries can be defined within the section. Parsers can be declared directly in the [`parsers` section](./parsers-section.md) of YAML configuration files. |_none_|
15
+
|`plugins_file`| Path for a `plugins` configuration file. This file specifies the paths to custom plugins (.so files) that Fluent Bit can load at runtime. Plugins can be declared directly in the [`plugins` section](./plugins-section.md) of YAML configuration files. |_none_|
16
+
|`streams_file`| Path for the [stream processor](../../../stream-processing/overview.md) configuration file. This file defines the rules and operations for stream processing in Fluent Bit. Stream processor configurations can also be defined directly in the `streams` section of YAML configuration files. |_none_|
17
17
|`http_server`| Enables the built-in HTTP server. |`off`|
18
18
|`http_listen`| Sets the listening interface for the HTTP Server when it's enabled. |`0.0.0.0`|
19
19
|`http_port`| Sets the TCP port for the HTTP server. |`2020`|
20
-
|`hot_reload`| Enables [hot reloading](../administration/hot-reload.md) of configuration with SIGHUP. |`on`|
20
+
|`hot_reload`| Enables [hot reloading](../../../administration/hot-reload.md) of configuration with SIGHUP. |`on`|
21
21
|`coro_stack_size`| Sets the coroutines stack size in bytes. The value must be greater than the page size of the running system. Setting the value too small (for example, `4096`) can cause coroutine threads to overrun the stack buffer. For best results, don't change this parameter from its default value. |`24576`|
22
22
|`scheduler.cap`| Sets a maximum retry time in seconds. |`2000`|
23
23
|`scheduler.base`| Sets the base of exponential backoff. |`5`|
24
-
|`json.convert_nan_to_null`| If enabled, `NaN` is converted to `null` when Fluent Bit converts msgpack to JSON. |`false`|
24
+
|`json.convert_nan_to_null`| If enabled, `NaN` is converted to `null` when Fluent Bit converts `msgpack` to JSON. |`false`|
25
25
|`json.escape_unicode`| Controls how Fluent Bit serializes non‑ASCII / multi‑byte Unicode characters in JSON strings. When enabled, Unicode characters are escaped as `\uXXXX` sequences (characters outside BMP become surrogate pairs). When disabled, Fluent Bit emits raw UTF‑8 bytes. |`true`|
26
26
|`sp.convert_from_str_to_num`| If enabled, the stream processor converts strings that represent numbers to a numeric type. |`true`|
27
27
|`windows.maxstdio`| If specified, adjusts the limit of `stdio`. Only provided for Windows. Values from `512` to `2048` are allowed. |`512`|
28
28
29
-
###Storage configuration
29
+
## Storage configuration
30
30
31
31
The following storage-related keys can be set in the `service` section:
Copy file name to clipboardExpand all lines: concepts/data-pipeline.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
@@ -29,7 +29,7 @@ graph LR
29
29
30
30
## Buffer
31
31
32
-
The [buffering](./buffering.md) phase in the pipeline aims to provide a unified and persistent mechanism to store your data, using the primary in-memory model or the file system-based mode.
32
+
The [buffering](../pipeline//buffering.md) phase in the pipeline aims to provide a unified and persistent mechanism to store your data, using the primary in-memory model or the file system-based mode.
Copy file name to clipboardExpand all lines: development/external-libraries.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ description: External libraries embedded in Fluent Bit
4
4
5
5
# External libraries
6
6
7
-
Fluent Bit embeds several external libraries in its [/lib](https://github.com/fluent/fluent-bit/tree/master/lib) directory. These libraries are included to minimize external dependencies and maximize cross-platform compatibility.
7
+
Fluent Bit embeds several external libraries in its [`/lib`](https://github.com/fluent/fluent-bit/tree/master/lib) directory. These libraries are included to minimize external dependencies and maximize cross-platform compatibility.
8
8
9
-
## Core fluent libraries
9
+
## Core Fluent Bit libraries
10
10
11
11
These libraries are developed and maintained by the Fluent Bit team:
12
12
@@ -18,7 +18,7 @@ These libraries are developed and maintained by the Fluent Bit team:
18
18
|[`CTraces`](https://github.com/fluent/ctraces)| Creates and manages trace contexts with encoding/decoding support for OpenTelemetry and other formats. | Apache 2.0 |
19
19
|[`CProfiles`](https://github.com/fluent/cprofiles)| Creates and manages profiling data based on the OpenTelemetry Profiles schema. | Apache 2.0 |
20
20
|[`Fluent OTel Proto`](https://github.com/fluent/fluent-otel-proto)| Provides C interfaces for OpenTelemetry protocol buffer definitions (common, resource, trace, logs, metrics). | Apache 2.0 |
21
-
|[`flb_libco`](https://github.com/fluent/flb_libco)| Fork of [libco](https://byuu.org/library/libco/) for cooperative multithreading (coroutines). Includes ARMv8 fixes and macOS support. | Internet Systems Consortium |
21
+
|[`flb_libco`](https://github.com/fluent/fluent-bit/tree/master/lib/flb_libco)| Fork of [`libco`](https://github.com/higan-emu/libco) for cooperative multithreading (coroutines). Includes ARMv8 fixes and macOS support. | Internet Systems Consortium |
22
22
23
23
## HTTP and networking
24
24
@@ -42,7 +42,7 @@ These libraries are developed and maintained by the Fluent Bit team:
42
42
| Library | Purpose | License |
43
43
|---------|---------|---------|
44
44
|[`Onigmo`](https://github.com/k-takata/Onigmo)| Regular expression library (fork of Oniguruma). Supports Perl 5.10+ expressions like `\K`, `\R`, and conditional patterns. Default regular expression engine for Ruby 2.0+. | BSD |
45
-
|[`tutf8e`](https://github.com/papplampe/tutf8e)| Tiny UTF-8 encoder supporting ISO-8859-x and Windows-125x character set conversions. | Massachusetts Institute of Technology (MIT) |
45
+
|[`tutf8e`](https://github.com/nigels-com/tutf8e)| Tiny UTF-8 encoder supporting ISO-8859-x and Windows-125x character set conversions. | Massachusetts Institute of Technology (MIT) |
Copy file name to clipboardExpand all lines: installation/downloads/linux.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
@@ -33,7 +33,7 @@ The GPG Key fingerprint of the old key is:
33
33
F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A
34
34
```
35
35
36
-
Refer to the [supported platform documentation](../getting-started-with-fluent-bit.md#supported-platforms-and-packages) to see which platforms are supported in each release.
36
+
Refer to the [supported platform documentation](../downloads.md#supported-platforms-and-packages) to see which platforms are supported in each release.
Copy file name to clipboardExpand all lines: installation/downloads/source/build-and-install.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ To build and install Fluent Bit from source, you must also install the following
14
14
-`libyaml-dev`
15
15
-`pkg-config`
16
16
17
-
Additionally, certain [input](../pipeline/inputs.md) or [output](../pipeline/outputs.md) plugins might depend on additional components. For example, some plugins require Kafka.
17
+
Additionally, certain [input](../../../pipeline/inputs.md) or [output](../../../pipeline/outputs.md) plugins might depend on additional components. For example, some plugins require Kafka.
18
18
19
19
## Prepare environment
20
20
@@ -305,7 +305,7 @@ The following table describes the output plugins available:
Copy file name to clipboardExpand all lines: pipeline/inputs/tail.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
@@ -10,7 +10,7 @@ The plugin supports the following configuration parameters:
10
10
11
11
| Key | Description | Default |
12
12
|:----|:------------|:--------|
13
-
|`buffer_chunk_size`| Set the initial buffer size to read file data. This value is used to increase buffer size. The value must be according to the [Unit Size](../../administration/configuring-fluent-bit/unit-sizes.md) specification. |`32k`|
13
+
|`buffer_chunk_size`| Set the initial buffer size to read file data. This value is used to increase buffer size. The value must be according to the [Unit Size](../../administration/configuring-fluent-bit.md#unit-sizes) specification. |`32k`|
14
14
|`buffer_max_size`| Set the limit of the buffer size per monitored file. When a buffer needs to be increased, this value is used to restrict the memory buffer growth. If reading a file exceeds this limit, the file is removed from the monitored file list. The value must be according to the [Unit Size](../../administration/configuring-fluent-bit.md#unit-sizes) specification. |`32k`|
15
15
|`db`| Specify the database file to keep track of monitored files and offsets. Recommended to be unique per plugin. |_none_|
16
16
|`db.compare_filename`| This option determines whether to review both `inode` and `filename` when retrieving stored file information from the database. `true` verifies both `inode` and `filename`, while `false` checks only the `inode`. To review the `inode` and `filename` in the database, refer [see `keep_state`](#tailing-files-keeping-state). |`false`|
Copy file name to clipboardExpand all lines: pipeline/processors/filters.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
@@ -44,7 +44,7 @@ pipeline:
44
44
45
45
### Lua
46
46
47
-
In this example configuration, an input plugin uses the [Lua](../pipeline/filters/lua.md) filter as a processor to add a new key `hostname` with the value `monox`. Then, an output plugin adds a new key named `output` with the value `new data`.
47
+
In this example configuration, an input plugin uses the [Lua](../filters/lua.md) filter as a processor to add a new key `hostname` with the value `monox`. Then, an output plugin adds a new key named `output` with the value `new data`.
0 commit comments