Skip to content

Commit 931a442

Browse files
eschabelleschabell
authored
Administration YAML service section docs have broken links for hot reload docs and examples. Fixes #1957. (#1958)
* Fixing broken link to hot reload docs from service section configuration details. Issue part of #1957. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Fixing broken detailed docs and examples for hot reload. Issue part of #1957. Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 44919d1 commit 931a442

File tree

2 files changed

+38
-36
lines changed

2 files changed

+38
-36
lines changed

‎administration/configuring-fluent-bit/yaml/service-section.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22

33
The `service` section defines global properties of the service. The available configuration keys are:
44

5-
| Key | Description | Default |
6-
|---|---|---|
7-
| `flush` | Sets the flush time in `seconds.nanoseconds`. The engine loop uses a flush timeout to determine when to flush records ingested by input plugins to output plugins. | `1` |
8-
| `grace` | Sets the grace time in `seconds` as an integer value. The engine loop uses a grace timeout to define the wait time before exiting. | `5` |
9-
| `daemon` | Boolean. Specifies whether Fluent Bit should run as a daemon (background process). 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` |
10-
| `dns.mode` | Sets the primary transport layer protocol used by the asynchronous DNS resolver. Can be overridden on a per-plugin basis. | `UDP` |
11-
| `log_file` | Absolute path for an optional log file. By default, all logs are redirected to the standard error interface (stderr). | _none_ |
12-
| `log_level` | Sets 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`, `warn`, `info`, and `debug`. Trace mode is only available if Fluent Bit was built with the _`WITH_TRACE`_ option enabled. | `info` |
13-
| `parsers_file` | Path for a `parsers` configuration file. Multiple `parsers_file` entries can be defined within the section. However, with the new YAML configuration schema, defining parsers using this key is now optional. Parsers can be declared directly in the `parsers` section of your YAML configuration, offering a more streamlined and integrated approach. | _none_ |
14-
| `plugins_file` | Path for a `plugins` configuration file. This file specifies the paths to external plugins (.so files) that Fluent Bit can load at runtime. With the new YAML schema, the `plugins_file` key is optional. External plugins can now be referenced directly within the `plugins` section, simplifying the plugin management process. [See an example](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). | _none_ |
5+
| Key | Description | Default |
6+
|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
7+
| `flush` | Sets the flush time in `seconds.nanoseconds`. The engine loop uses a flush timeout to determine when to flush records ingested by input plugins to output plugins. | `1` |
8+
| `grace` | Sets the grace time in `seconds` as an integer value. The engine loop uses a grace timeout to define the wait time before exiting. | `5` |
9+
| `daemon` | Boolean. Specifies whether Fluent Bit should run as a daemon (background process). 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` |
10+
| `dns.mode` | Sets the primary transport layer protocol used by the asynchronous DNS resolver. Can be overridden on a per-plugin basis. | `UDP` |
11+
| `log_file` | Absolute path for an optional log file. By default, all logs are redirected to the standard error interface (stderr). | _none_ |
12+
| `log_level` | Sets 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`, `warn`, `info`, and `debug`. Trace mode is only available if Fluent Bit was built with the _`WITH_TRACE`_ option enabled. | `info` |
13+
| `parsers_file` | Path for a `parsers` configuration file. Multiple `parsers_file` entries can be defined within the section. However, with the new YAML configuration schema, defining parsers using this key is now optional. Parsers can be declared directly in the `parsers` section of your YAML configuration, offering a more streamlined and integrated approach. | _none_ |
14+
| `plugins_file` | Path for a `plugins` configuration file. This file specifies the paths to external plugins (.so files) that Fluent Bit can load at runtime. With the new YAML schema, the `plugins_file` key is optional. External plugins can now be referenced directly within the `plugins` section, simplifying the plugin management process. [See an example](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). | _none_ |
1515
| `streams_file` | Path for the Stream Processor configuration file. This file defines the rules and operations for stream processing within Fluent Bit. The `streams_file` key is optional, as Stream Processor configurations can be defined directly in the `streams` section of the YAML schema. This flexibility allows for easier and more centralized configuration. [Learn more about Stream Processing configuration](../../../stream-processing/introduction.md). | _none_ |
16-
| `http_server` | Enables the built-in HTTP Server. | `off` |
17-
| `http_listen` | Sets the listening interface for the HTTP Server when it's enabled. | `0.0.0.0` |
18-
| `http_port` | Sets the TCP port for the HTTP Server. | `2020` |
19-
| `hot_reload` | Enables hot [reloading](../../hot_reload.md) of configuration with SIGHUP. | `on` |
20-
| `coro_stack_size` | Sets the coroutine 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` |
21-
| `scheduler.cap` | Sets a maximum retry time in seconds. Supported in v1.8.7 and greater. | `2000` |
22-
| `scheduler.base` | Sets the base of exponential backoff. Supported in v1.8.7 and greater. | `5` |
23-
| `json.convert_nan_to_null` | If enabled, `NaN` is converted to `null` when Fluent Bit converts `msgpack` to `json`. | `false` |
24-
| `sp.convert_from_str_to_num` | If enabled, the Stream Processor converts strings that represent numbers to a numeric type. | `true` |
16+
| `http_server` | Enables the built-in HTTP Server. | `off` |
17+
| `http_listen` | Sets the listening interface for the HTTP Server when it's enabled. | `0.0.0.0` |
18+
| `http_port` | Sets the TCP port for the HTTP Server. | `2020` |
19+
| `hot_reload` | Enables hot [reloading](../../hot-reload) of configuration with SIGHUP. | `on` |
20+
| `coro_stack_size` | Sets the coroutine 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` |
21+
| `scheduler.cap` | Sets a maximum retry time in seconds. Supported in v1.8.7 and greater. | `2000` |
22+
| `scheduler.base` | Sets the base of exponential backoff. Supported in v1.8.7 and greater. | `5` |
23+
| `json.convert_nan_to_null` | If enabled, `NaN` is converted to `null` when Fluent Bit converts `msgpack` to `json`. | `false` |
24+
| `sp.convert_from_str_to_num` | If enabled, the Stream Processor converts strings that represent numbers to a numeric type. | `true` |
2525

2626
## Configuration example
2727

@@ -43,4 +43,4 @@ pipeline:
4343
outputs:
4444
- name: stdout
4545
match: '*'
46-
```
46+
```

‎administration/hot-reload.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,27 @@ To get started with reloading over HTTP, enable the HTTP Server
1515
in the configuration file:
1616

1717
{% tabs %}
18+
{% tab title="fluent-bit.yaml" %}
19+
20+
```yaml
21+
service:
22+
http_server: on
23+
http_listen: 0.0.0.0
24+
http_port: 2020
25+
hot_reload: on
26+
```
27+
28+
{% endtab %}
1829
{% tab title="fluent-bit.conf" %}
30+
1931
```text
2032
[SERVICE]
21-
HTTP_Server On
22-
HTTP_Listen 0.0.0.0
23-
HTTP_PORT 2020
24-
Hot_Reload On
25-
...
33+
HTTP_Server On
34+
HTTP_Listen 0.0.0.0
35+
HTTP_PORT 2020
36+
Hot_Reload On
2637
```
27-
{% endtab %}
2838

29-
{% tab title="fluent-bit.yaml" %}
30-
```yaml
31-
service:
32-
http_server: on
33-
http_listen: 0.0.0.0
34-
http_port: 2020
35-
hot_reload: on
36-
```
3739
{% endtab %}
3840
{% endtabs %}
3941

@@ -51,7 +53,7 @@ Use the following HTTP endpoints to perform a hot reload:
5153

5254
For using curl to reload Fluent Bit, users must specify an empty request body as:
5355

54-
```text
56+
```shell
5557
curl -X POST -d '{}' localhost:2020/api/v2/reload
5658
```
5759

@@ -77,4 +79,4 @@ The endpoint returns `hot_reload_count` as follows:
7779
{"hot_reload_count":3}
7880
```
7981

80-
The default value of the counter is `0`.
82+
The default value of the counter is `0`.

0 commit comments

Comments
 (0)