Skip to content

Commit b441d8e

Browse files
committed
doc: administration: configuring-fluent-bit: classic-mode: configuration-file: Clean up Service key table
- Sort the Service section key table alphabetically by key name, from `coro_stack_size` through `windows.maxstdio`. Row content is unchanged; this is a pure reorder that matches the ordering already used by the YAML `service-section.md` table. - Remove the italics wrapping from the `FLB_TRACE` code span in the `log_level` row, so it renders as a plain code span and matches how `FLB_TRACE` is written on the YAML `service-section.md` and `build-and-install.md` pages. Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 45e40b8 commit b441d8e

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

administration/configuring-fluent-bit/classic-mode/configuration-file.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ The `Service` section defines global properties of the service. The following ke
1919

2020
| Key | Description | Default Value |
2121
| --------------- | ------------- | ------------- |
22-
| `flush` | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when it's required to flush the records ingested by input plugins through the defined output plugins. | `1` |
23-
| `grace` | Set the grace time in `seconds` as an integer value. The engine loop uses a grace timeout to define wait time on exit. | `5` |
22+
| `coro_stack_size` | Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Setting the value too small (`4096`) can cause coroutine threads to overrun the stack buffer. The default value of this parameter shouldn't be changed. | `24576` |
2423
| daemon | Boolean. Determines whether Fluent Bit should run as a Daemon (background). Allowed values are: `yes`, `no`, `on`, and `off`. Don't enable when using a Systemd based unit, such as the one provided in Fluent Bit packages.  | `Off` |
2524
| `dns.mode` | Set the primary transport layer protocol used by the asynchronous DNS resolver. Can be overridden on a per plugin basis. | `UDP` |
26-
| `log_file` | Absolute path for an optional log file. By default all logs are redirected to the standard error interface (stderr). | _none_ |
27-
| `log_level` | Set the logging verbosity level. Allowed values are: `off`, `error`, `warn`, `info`, `debug`, and `trace`. Values are cumulative. If `debug` is set, it will include `error`, `warning`, `info`, and `debug`. Trace mode is only available if Fluent Bit was built with the _`FLB_TRACE`_ option enabled. | `info` |
28-
| `parsers_file` | Path for a `parsers` configuration file. Multiple `Parsers_File` entries can be defined within the section. | _none_ |
29-
| `plugins_file` | Path for a `plugins` configuration file. A `plugins` configuration file defines paths for external plugins. [See an example](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). | _none_ |
30-
| `streams_file` | Path for the Stream Processor configuration file. [Learn more about Stream Processing configuration](../../../stream-processing/overview.md). | _none_|
31-
| `http_server` | Enable the built-in HTTP Server. | `Off` |
25+
| `flush` | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when it's required to flush the records ingested by input plugins through the defined output plugins. | `1` |
26+
| `grace` | Set the grace time in `seconds` as an integer value. The engine loop uses a grace timeout to define wait time on exit. | `5` |
3227
| `http_listen` | Set listening interface for HTTP Server when it's enabled. | `0.0.0.0` |
3328
| `http_port` | Set TCP Port for the HTTP Server. | `2020` |
34-
| `coro_stack_size` | Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Setting the value too small (`4096`) can cause coroutine threads to overrun the stack buffer. The default value of this parameter shouldn't be changed. | `24576` |
35-
| `scheduler.cap` | Set a maximum retry time in seconds. Supported in v1.8.7 and greater. | `2000` |
36-
| `scheduler.base` | Set a base of exponential backoff. Supported in v1.8.7 and greater. | `5` |
29+
| `http_server` | Enable the built-in HTTP Server. | `Off` |
3730
| `json.convert_nan_to_null` | If enabled, `NaN` converts to `null` when Fluent Bit converts `msgpack` to `json`. | `false` |
3831
| `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` |
32+
| `log_file` | Absolute path for an optional log file. By default all logs are redirected to the standard error interface (stderr). | _none_ |
33+
| `log_level` | Set the logging verbosity level. Allowed values are: `off`, `error`, `warn`, `info`, `debug`, and `trace`. Values are cumulative. If `debug` is set, it will include `error`, `warning`, `info`, and `debug`. Trace mode is only available if Fluent Bit was built with the `FLB_TRACE` option enabled. | `info` |
34+
| `parsers_file` | Path for a `parsers` configuration file. Multiple `Parsers_File` entries can be defined within the section. | _none_ |
35+
| `plugins_file` | Path for a `plugins` configuration file. A `plugins` configuration file defines paths for external plugins. [See an example](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). | _none_ |
36+
| `scheduler.base` | Set a base of exponential backoff. Supported in v1.8.7 and greater. | `5` |
37+
| `scheduler.cap` | Set a maximum retry time in seconds. Supported in v1.8.7 and greater. | `2000` |
3938
| `sp.convert_from_str_to_num` | If enabled, Stream processor converts from number string to number type. | `true` |
39+
| `streams_file` | Path for the Stream Processor configuration file. [Learn more about Stream Processing configuration](../../../stream-processing/overview.md). | _none_|
4040
| `windows.maxstdio` | If specified, the limit of stdio is adjusted. Only provided for Windows. From 512 to 2048 is allowed. | `512` |
4141

4242
The following is an example of a `SERVICE` section:

0 commit comments

Comments
 (0)