Skip to content

Commit 8ea70e7

Browse files
committed
docs: pipeline: outputs: forward: explicit warning for v5.0.4 default config param change
- document v5.0.4 default change and Fluentd incompatibility for retain_metadata_in_forward_mode Applies to fluent/fluent-bit#11877 Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 6462381 commit 8ea70e7

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

installation/upgrade-notes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ If you tune `http`, `splunk`, `elasticsearch`, `opentelemetry`, or `prometheus_r
3636

3737
Input plugins that support TLS now also support `tls.verify_client_cert`. Enable this option to require and validate the client certificate presented by the sender.
3838

39-
If you terminate TLS directly in Fluent Bit and need mutual TLS (`mTLS`), add `tls.verify_client_cert on` together with the usual `tls.crt_file` and `tls.key_file` settings.
39+
If you end TLS directly in Fluent Bit and need mutual TLS (`mTLS`), add `tls.verify_client_cert on` together with the usual `tls.crt_file` and `tls.key_file` settings.
4040

4141
### New internal logs input
4242

43-
Fluent Bit `v5.0` adds the `fluentbit_logs` input plugin, which mirrors Fluent Bit's own internal log stream back into the data pipeline as structured log records.
43+
Fluent Bit `v5.0` adds the `fluentbit_logs` input plugin, which mirrors the Fluent Bit internal log stream back into the data pipeline as structured log records.
4444

4545
Use this input if you want to forward Fluent Bit diagnostics to another destination, filter them, or store them alongside the rest of your telemetry.
4646

@@ -65,7 +65,7 @@ If you previously handled authentication outside Fluent Bit for these cases, rev
6565

6666
Starting in Fluent Bit v5.0.4, the `forward` output plugin's `retain_metadata_in_forward_mode` option defaults to `true` (previously `false`). When `true`, Fluent Bit embeds event metadata into the Forward protocol payload using the extended MessagePack format.
6767

68-
Fluentd receivers do not understand this format and will reject events with a warning similar to:
68+
Fluentd receivers don't understand this format and will reject events with a warning similar to:
6969

7070
```text
7171
[input1] skip invalid event: host="..." tag="..." time=[..., {}] record={...}

pipeline/outputs/forward.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The following parameters are mandatory for both Forward and Secure Forward modes
2929
| `require_ack_response` | Send the `chunk` option and wait for an `ack` response from the server. This enables at-least-once delivery and lets the receiving server control traffic rate. Requires Fluentd `v0.14.0` or later. | `false` |
3030
| `compress` | Set to `gzip` to enable gzip compression. Incompatible with `time_as_integer true` and tags set dynamically using the [Rewrite Tag](../filters/rewrite-tag.md) filter. Requires Fluentd server `v0.14.7` or later. | _none_ |
3131
| `fluentd_compat` | Send metrics and traces using a Fluentd-compatible format. | `false` |
32-
| `retain_metadata_in_forward_mode` | Retain metadata when operating in forward mode. | `true` |
32+
| `retain_metadata_in_forward_mode` | Retain metadata when operating in forward mode. **Changed to `true` in v5.0.4.** Set to `false` when sending to Fluentd. Fluentd doesn't support the extended metadata format and will log `[input1] skip invalid event` and drop all records. | `true` |
3333
| `add_option` | Add an extra Forward protocol option. This is an advanced setting and can be specified multiple times. Enabling it also enables `send_options`. | _none_ |
3434
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `2` |
3535

0 commit comments

Comments
 (0)