Skip to content

Commit c82e0a0

Browse files
edsiperedsiper
committed
inputs: clarify shared HTTP listener settings
Signed-off-by: Eduardo Silva <edsiper@gmail.com>
1 parent a58ebbb commit c82e0a0

5 files changed

Lines changed: 70 additions & 0 deletions

File tree

‎pipeline/inputs/elasticsearch.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ The _Elasticsearch_ input plugin handles both Elasticsearch and OpenSearch Bulk
1010

1111
The plugin supports the following configuration parameters:
1212

13+
The table below includes both:
14+
15+
- settings specific to the Elasticsearch input plugin
16+
- shared `http_server.*` listener settings that are used by several HTTP-based inputs
17+
18+
For a cross-plugin explanation of the shared listener settings, see
19+
[Shared HTTP listener settings for inputs](../../administration/configuring-fluent-bit/yaml/pipeline-section.md#shared-http-listener-settings-for-inputs).
20+
1321
| Key | Description | Default value |
1422
|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------|
1523
| `buffer_chunk_size` | Set the buffer chunk size. Compatibility alias for `http_server.buffer_chunk_size`. | `512K` |
@@ -18,13 +26,19 @@ The plugin supports the following configuration parameters:
1826
| `http2` | Enable HTTP/2 support. Compatibility alias for `http_server.http2`. | `true` |
1927
| `http_server.max_connections` | Maximum number of concurrent active HTTP connections. `0` means unlimited. | `0` |
2028
| `http_server.workers` | Number of HTTP listener worker threads. | `1` |
29+
| `http_server.ingress_queue_event_limit` | Maximum number of deferred ingress queue entries. Applies only when `http_server.workers` is greater than `1`. | `8192` |
30+
| `http_server.ingress_queue_byte_limit` | Maximum size of the deferred ingress queue. Applies only when `http_server.workers` is greater than `1`. | `256M` |
2131
| `listen` | The address to listen on. | `0.0.0.0` |
2232
| `meta_key` | Specify a key name for meta information. | `@meta` |
2333
| `port` | The port for Fluent Bit to listen on. | `9200` |
2434
| `tag_key` | Specify a key name for extracting as a tag. | `NULL` |
2535
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2636
| `version` | Specify the Elasticsearch version that Fluent Bit reports to clients during sniffing and API requests. | `8.0.0` |
2737

38+
The `http_server.ingress_queue_event_limit` and
39+
`http_server.ingress_queue_byte_limit` settings matter only when
40+
`http_server.workers` is greater than `1`.
41+
2842
### TLS / SSL
2943

3044
The Elasticsearch input plugin supports TLS/SSL for receiving data from Beats agents or other clients over encrypted connections. For more details about the properties available and general configuration, refer to [Transport Security](../../administration/transport-security.md).

‎pipeline/inputs/http.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ The _HTTP_ input plugin lets Fluent Bit open an HTTP port that you can then rout
99

1010
## Configuration parameters
1111

12+
The table below includes both:
13+
14+
- settings specific to the HTTP input plugin
15+
- shared `http_server.*` listener settings that are used by several HTTP-based inputs
16+
17+
For a cross-plugin explanation of the shared listener settings, see
18+
[Shared HTTP listener settings for inputs](../../administration/configuring-fluent-bit/yaml/pipeline-section.md#shared-http-listener-settings-for-inputs).
19+
1220
| Key | Description | Default |
1321
|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
1422
| `add_remote_addr` | Adds a `REMOTE_ADDR` field to the record. The value of `REMOTE_ADDR` is the client's address, which is extracted from the `X-Forwarded-For` header. | `false` |
@@ -17,6 +25,8 @@ The _HTTP_ input plugin lets Fluent Bit open an HTTP port that you can then rout
1725
| `http2` | Enable HTTP/2 support. Compatibility alias for `http_server.http2`. | `true` |
1826
| `http_server.max_connections` | Maximum number of concurrent active HTTP connections. `0` means unlimited. | `0` |
1927
| `http_server.workers` | Number of HTTP listener worker threads. | `1` |
28+
| `http_server.ingress_queue_event_limit` | Maximum number of deferred ingress queue entries. Applies only when `http_server.workers` is greater than `1`. | `8192` |
29+
| `http_server.ingress_queue_byte_limit` | Maximum size of the deferred ingress queue. Applies only when `http_server.workers` is greater than `1`. | `256M` |
2030
| `listen` | The address to listen on. | `0.0.0.0` |
2131
| `oauth2.allowed_audience` | Audience claim to enforce when validating incoming `OAuth 2.0` `JWT` tokens. | _none_ |
2232
| `oauth2.allowed_clients` | Authorized `client_id` or `azp` claim values. Can be specified multiple times. | _none_ |
@@ -31,6 +41,10 @@ The _HTTP_ input plugin lets Fluent Bit open an HTTP port that you can then rout
3141
| `tag_key` | Specify the key name to overwrite a tag. If set, the tag will be overwritten by a value of the key. | _none_ |
3242
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
3343

44+
The `http_server.ingress_queue_event_limit` and
45+
`http_server.ingress_queue_byte_limit` settings matter only when
46+
`http_server.workers` is greater than `1`.
47+
3448
### TLS / SSL
3549

3650
HTTP input plugin supports TLS/SSL. For more details about the properties available and general configuration, refer to [Transport Security](../../administration/transport-security.md).

‎pipeline/inputs/opentelemetry.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
1414

1515
## Configuration
1616

17+
The table below includes both:
18+
19+
- settings specific to the OpenTelemetry input plugin
20+
- shared `http_server.*` listener settings that are used by several HTTP-based inputs
21+
22+
For a cross-plugin explanation of the shared listener settings, see
23+
[Shared HTTP listener settings for inputs](../../administration/configuring-fluent-bit/yaml/pipeline-section.md#shared-http-listener-settings-for-inputs).
24+
1725
| Key | Description | Default |
1826
|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
1927
| `alias` | Sets an alias for multiple instances of the same input plugin. If no alias is specified, a default name will be assigned using the plugin name followed by a dot and a sequence number. | _none_ |
@@ -24,6 +32,8 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
2432
| `http2` | Enable HTTP/2 protocol support for the OpenTelemetry receiver. | `true` |
2533
| `http_server.max_connections` | Maximum number of concurrent active HTTP connections. `0` means unlimited. | `0` |
2634
| `http_server.workers` | Number of HTTP listener worker threads. | `1` |
35+
| `http_server.ingress_queue_event_limit` | Maximum number of deferred ingress queue entries. Applies only when `http_server.workers` is greater than `1`. | `8192` |
36+
| `http_server.ingress_queue_byte_limit` | Maximum size of the deferred ingress queue. Applies only when `http_server.workers` is greater than `1`. | `256M` |
2737
| `listen` | The network address to listen on. | `0.0.0.0` |
2838
| `log_level` | Specifies the log level for this plugin. If not set here, the plugin uses the global log level specified in the `service` section of your configuration file. | `info` |
2939
| `log_suppress_interval` | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
@@ -69,6 +79,10 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
6979
| `tls.verify_hostname` | Enable or disable to verify hostname. | `off` |
7080
| `tls.vhost` | Hostname to be used for TLS SNI extension. | _none_ |
7181

82+
The `http_server.ingress_queue_event_limit` and
83+
`http_server.ingress_queue_byte_limit` settings matter only when
84+
`http_server.workers` is greater than `1`.
85+
7286
When `raw_traces` is set to `false` (default), the traces endpoint (`/v1/traces`) processes incoming trace data using the unified JSON parser with strict validation. The endpoint accepts both `protobuf` and `JSON` encoded payloads. When `raw_traces` is set to `true`, any data forwarded to the traces endpoint will be packed and forwarded as a log message without processing, validation, or conversion to the Fluent Bit internal trace format.
7387

7488
### OpenTelemetry transport protocol endpoints

‎pipeline/inputs/prometheus-remote-write.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,34 @@ The _Prometheus remote write_ input plugin lets you ingest a payload in the Prom
1212

1313
## Configuration parameters
1414

15+
The table below includes both:
16+
17+
- settings specific to the Prometheus remote write input plugin
18+
- shared `http_server.*` listener settings that are used by several HTTP-based inputs
19+
20+
For a cross-plugin explanation of the shared listener settings, see
21+
[Shared HTTP listener settings for inputs](../../administration/configuring-fluent-bit/yaml/pipeline-section.md#shared-http-listener-settings-for-inputs).
22+
1523
| Key | Description | Default |
1624
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
1725
| `buffer_chunk_size` | Sets the chunk size for incoming data. These chunks are then stored and managed in the space specified by `buffer_max_size`. Compatibility alias for `http_server.buffer_chunk_size`. | `512K` |
1826
| `buffer_max_size` | Specifies the maximum buffer size to receive a request. Compatibility alias for `http_server.buffer_max_size`. | `4M` |
1927
| `http2` | Enable HTTP/2 support. Compatibility alias for `http_server.http2`. | `true` |
2028
| `http_server.max_connections` | Maximum number of concurrent active HTTP connections. `0` means unlimited. | `0` |
2129
| `http_server.workers` | Number of HTTP listener worker threads. | `1` |
30+
| `http_server.ingress_queue_event_limit` | Maximum number of deferred ingress queue entries. Applies only when `http_server.workers` is greater than `1`. | `8192` |
31+
| `http_server.ingress_queue_byte_limit` | Maximum size of the deferred ingress queue. Applies only when `http_server.workers` is greater than `1`. | `256M` |
2232
| `listen` | The address to listen on. | `0.0.0.0` |
2333
| `port` | The port to listen on. | `8080` |
2434
| `successful_response_code` | Specifies the success response code. Supported values are `200`, `201`, and `204`. | `201` |
2535
| `tag_from_uri` | If true, a tag will be created from the `uri` parameter (for example, `api_prom_push` from `/api/prom/push`), and any tag specified in the configuration will be ignored. If false, you must provide a tag in the configuration for this plugin. | `true` |
2636
| `threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2737
| `uri` | Specifies an optional HTTP URI for the target web server listening for Prometheus remote write payloads (for example, `/api/prom/push`). | _none_ |
2838

39+
The `http_server.ingress_queue_event_limit` and
40+
`http_server.ingress_queue_byte_limit` settings matter only when
41+
`http_server.workers` is greater than `1`.
42+
2943
## Configuration file
3044

3145
The following examples are sample configuration files for this input plugin:

0 commit comments

Comments
 (0)