Skip to content

Commit 87ff27f

Browse files
committed
administration: document shared HTTP ingress queue settings
Signed-off-by: Eduardo Silva <edsiper@gmail.com>
1 parent 7e804b4 commit 87ff27f

4 files changed

Lines changed: 19 additions & 1 deletion

File tree

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,27 @@ The `name` parameter is required and defines for Fluent Bit which input plugin s
8181

8282
Some HTTP-based input plugins share the same listener implementation and support the following common settings in addition to their plugin-specific parameters:
8383

84+
These settings are shared by HTTP-based inputs such as `http`, `splunk`,
85+
`elasticsearch`, `opentelemetry`, and `prometheus_remote_write`.
86+
Use these keys the same way across those plugins.
87+
88+
If a plugin page shows one of the `http_server.*` keys in its configuration
89+
table, it is documenting one of these shared listener settings, not a
90+
plugin-specific behavior.
91+
8492
| Key | Description | Default |
8593
| --- | ----------- | ------- |
8694
| `http_server.http2` | Enable HTTP/2 support for the input listener. | `true` |
8795
| `http_server.buffer_max_size` | Set the maximum size of the HTTP request buffer. | `4M` |
8896
| `http_server.buffer_chunk_size` | Set the allocation chunk size used for the HTTP request buffer. | `512K` |
8997
| `http_server.max_connections` | Set the maximum number of concurrent active HTTP connections. `0` means unlimited. | `0` |
9098
| `http_server.workers` | Set the number of HTTP listener worker threads. | `1` |
99+
| `http_server.ingress_queue_event_limit` | Set the maximum number of deferred ingress queue entries. This setting applies only when `http_server.workers` is greater than `1`. | `8192` |
100+
| `http_server.ingress_queue_byte_limit` | Set the maximum size of the deferred ingress queue. This setting applies only when `http_server.workers` is greater than `1`. | `256M` |
101+
102+
When `http_server.workers` is `1`, Fluent Bit does not use the deferred
103+
ingress queue, so the two `http_server.ingress_queue_*` settings have no
104+
effect.
91105

92106
For backward compatibility, some plugins also accept the legacy aliases `http2`, `buffer_max_size`, `buffer_chunk_size`, `max_connections`, and `workers`.
93107

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The `service` section of YAML configuration files defines global properties of t
3636
| `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_ |
3737
| `windows.maxstdio` | If specified, adjusts the limit of `stdio`. Only provided for Windows. Values from `512` to `2048` are allowed. | `512` |
3838

39-
The `service` section only controls the built-in monitoring and control HTTP server. Plugin-specific HTTP listener settings such as `http_server.http2`, `http_server.buffer_max_size`, `http_server.buffer_chunk_size`, `http_server.max_connections`, and `http_server.workers` are configured on the relevant input plugin in the [`pipeline.inputs`](../yaml/pipeline-section.md#shared-http-listener-settings-for-inputs) section.
39+
The `service` section only controls the built-in monitoring and control HTTP server. Plugin-specific HTTP listener settings such as `http_server.http2`, `http_server.buffer_max_size`, `http_server.buffer_chunk_size`, `http_server.max_connections`, `http_server.workers`, `http_server.ingress_queue_event_limit`, and `http_server.ingress_queue_byte_limit` are configured on the relevant input plugin in the [`pipeline.inputs`](../yaml/pipeline-section.md#shared-http-listener-settings-for-inputs) section.
4040

4141
## Storage configuration
4242

installation/upgrade-notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ The HTTP-based input plugins now use a shared HTTP listener configuration model.
2525
- `http_server.buffer_max_size`
2626
- `http_server.max_connections`
2727
- `http_server.workers`
28+
- `http_server.ingress_queue_event_limit`
29+
- `http_server.ingress_queue_byte_limit`
2830

2931
Legacy per-plugin names such as `http2`, `buffer_chunk_size`, and `buffer_max_size` are still accepted as compatibility aliases, but new configurations should use the `http_server.*` names.
3032

installation/whats-new-in-fluent-bit-v5.0.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ HTTP-based inputs now use a shared listener configuration model. The preferred s
4444
- `http_server.buffer_max_size`
4545
- `http_server.max_connections`
4646
- `http_server.workers`
47+
- `http_server.ingress_queue_event_limit`
48+
- `http_server.ingress_queue_byte_limit`
4749

4850
Legacy aliases such as `http2`, `buffer_chunk_size`, and `buffer_max_size` still work, but new configurations should use the `http_server.*` names.
4951

0 commit comments

Comments
 (0)