Skip to content

Commit d07f48a

Browse files
committed
output: align forward option names with Fluent Bit 5.0
Signed-off-by: Eduardo Silva <edsiper@gmail.com>
1 parent 548211c commit d07f48a

1 file changed

Lines changed: 18 additions & 15 deletions

File tree

pipeline/outputs/forward.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,31 @@ The following parameters are mandatory for both Forward and Secure Forward modes
1919

2020
| Key | Description | Default |
2121
| --- | ------------ | --------- |
22-
| `Host` | Target host where Fluent Bit or Fluentd are listening for Forward messages. | `127.0.0.1` |
23-
| `Port` | TCP Port of the target service. | `24224` |
24-
| `Time_as_Integer` | Set timestamps in integer format, it enables compatibility mode for Fluentd v0.12 series. | `False` |
25-
| `Upstream` | If Forward will connect to an `Upstream` instead of a basic host, this property defines the absolute path for the Upstream configuration file, for more details about this, see [Upstream Servers ](../../administration/configuring-fluent-bit/classic-mode/upstream-servers.md). | _none_ |
26-
| `Unix_Path` | Specify the path to a Unix socket to send a Forward message. If set, `Upstream` is ignored. | _none_ |
27-
| `Tag` | Overwrite the tag as Fluent Bit transmits. This allows the receiving pipeline start fresh, or to attribute a source. | _none_ |
28-
| `Send_options` | Always send options (with `"size"=count of messages`) | `False` |
29-
| `Require_ack_response` | Send `chunk` option and wait for an `ack` response from the server. Enables at-least-once and receiving server can control rate of traffic. Requires Fluentd v0.14.0+ or later | `False` |
30-
| `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_ |
31-
| `Workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `2` |
22+
| `host` | Target host where Fluent Bit or Fluentd are listening for Forward messages. | `127.0.0.1` |
23+
| `port` | TCP port of the target service. | `24224` |
24+
| `time_as_integer` | Set timestamps in integer format. This enables compatibility mode for Fluentd `v0.12`. | `false` |
25+
| `upstream` | If Forward connects to an `upstream` definition instead of a basic host, this property defines the absolute path for the upstream configuration file. See [Upstream Servers](../../administration/configuring-fluent-bit/classic-mode/upstream-servers.md). | _none_ |
26+
| `unix_path` | Specify the path to a Unix socket to send a Forward message. If set, `upstream` is ignored. | _none_ |
27+
| `tag` | Overwrite the tag as Fluent Bit transmits. This lets the receiving pipeline start fresh or attribute a source. | _none_ |
28+
| `send_options` | Always send Forward protocol options, including `"size"`. | `false` |
29+
| `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` |
30+
| `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_ |
31+
| `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. | `false` |
33+
| `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_ |
34+
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `2` |
3235

3336
## Secure Forward mode configuration parameters
3437

3538
When using Secure Forward mode, the [TLS](../../administration/transport-security.md) mode must be enabled. The following additional configuration parameters are available:
3639

3740
| Key | Description | Default |
3841
| --- | ----------- | ------- |
39-
| `Shared_Key` | A key string known by the remote Fluentd used for authorization. | _none_ |
40-
| `Empty_Shared_Key` | Use this option to connect to Fluentd with a zero-length secret. | `False` |
41-
| `Username` | Specify the username to present to a Fluentd server that enables `user_auth`. | _none_ |
42-
| `Password` | Specify the password corresponding to the username. | _none_ |
43-
| `Self_Hostname` | Default value of the auto-generated certificate common name (CN). | `localhost` |
42+
| `shared_key` | A key string known by the remote Fluentd used for authorization. | _none_ |
43+
| `empty_shared_key` | Connect to Fluentd with a zero-length shared secret. | `false` |
44+
| `username` | Specify the username to present to a Fluentd server that enables `user_auth`. | _none_ |
45+
| `password` | Specify the password corresponding to the username. | _none_ |
46+
| `self_hostname` | Default value of the auto-generated certificate common name (CN). | `localhost` |
4447
| `tls` | Enable or disable TLS support. | `Off` |
4548
| `tls.verify` | Force certificate validation. | `On` |
4649
| `tls.debug` | Set TLS debug verbosity level. Allowed values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational), and `4` (Verbose). | `1` |

0 commit comments

Comments
 (0)