Skip to content

out_forward: document undocumented parameters and Plugin Helpers #680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenhys merged 2 commits into from
Aug 13, 2026
+56 −3
Merged

out_forward: document undocumented parameters and Plugin Helpers #680

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa75522
out_forward: document undocumented parameters and Plugin Helpers
Watson1978 Aug 12, 2026
75616c4
Clarify tls_ca_cert_path and tls_cert_path precedence
Watson1978 Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 56 additions & 3 deletions output/forward.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ See [Output Plugin Overview](./) for more details.
* [`timer`](../plugin-helper-overview/api-plugin-helper-timer.md)
* [`thread`](../plugin-helper-overview/api-plugin-helper-thread.md)
* [`compat_parameters`](../plugin-helper-overview/api-plugin-helper-compat_parameters.md)
* [`service_discovery`](../plugin-helper-overview/api-plugin-helper-service_discovery.md)

## Parameters

Expand Down Expand Up @@ -180,9 +181,19 @@ Use service discovery plugin instead of fixed `<server>` list. See also [Service
@type file
path /path/to/servers.yaml
</service_discovery>
</source>
</match>
```

### `transport`

| type | default | available | version |
| :--- | :--- | :--- | :--- |
| enum | tcp | tcp, tls | 0.14.12 |

The transport protocol used to connect to the destination servers.

Set `tls` to use TLS. All the `tls_*` parameters take effect only with `transport tls`. See [How to connect to a TLS/SSL enabled server?](#how-to-connect-to-a-tlsssl-enabled-server) for a complete configuration.

### `require_ack_response`

| type | default | version |
Expand All @@ -201,6 +212,28 @@ This option is used when `require_ack_response` is `true`. This default value is

If set `0`, this plugin does not wait for the ack response.

### `read_interval_msec`

| type | default | version |
| :--- | :--- | :--- |
| integer | 50 | 0.14.5 |

The wait time in milliseconds before retrying to read the handshake response from a server.

The handshake is a part of the authentication, so this parameter takes effect only when the [`<security>`](#security-section) section is configured.

### `read_length`

| type | default | version |
| :--- | :--- | :--- |
| size | 512 | 0.14.5 |

The read size for the data which this plugin receives from a server.

It applies to the handshake response of the [`<security>`](#security-section) section, the ack response of [`require_ack_response`](#requireackresponse) and the heartbeat response of `heartbeat_type udp`.

This is a low-level tuning parameter, so you rarely need to change it.

### `send_timeout`

| type | default | version |
Expand Down Expand Up @@ -233,6 +266,10 @@ The wait time before accepting a server fault recovery.

Specifies the transport protocol for heartbeats. Set `none` to disable.

The default value `transport` means the protocol which [`transport`](#transport) specifies.

`tcp` is deprecated since v0.14.12. It is treated as `transport`.

### `heartbeat_interval`

| type | default | version |
Expand Down Expand Up @@ -283,7 +320,7 @@ Sets TTL to expire DNS cache in seconds. Set 0 not to use DNS Cache.

Enable client-side DNS round robin. Uniform randomly pick an IP address to send data when a hostname has several IP addresses.

`heartbeat_type udp` is not available with `dns_round_robintrue`. Use `heartbeat_type tcp` or `heartbeat_type none`.
`heartbeat_type udp` is not available with `dns_round_robin true`. Use `heartbeat_type transport` or `heartbeat_type none`.

### `ignore_network_errors_at_startup`

Expand Down Expand Up @@ -376,13 +413,29 @@ If the following conditions are met, you must set `tls_verify_hostname false` ex
* specify `host` in `<server>` section with IP address, not hostname
* specify server certificate file with `tls_cert_path` which contains common name (CN) field with IP address, not hostname

### `tls_ca_cert_path`

| type | default | version |
| :--- | :--- | :--- |
| array of string | nil | 1.3.1 |

The additional CA certificate path for TLS.

This is the new name of [`tls_cert_path`](#tlscertpath), which was renamed in v1.3.1 to clarify its meaning.
Comment thread
Watson1978 marked this conversation as resolved.

If both of this parameter and [`tls_cert_path`](#tlscertpath) are specified, `tls_cert_path` is used and this parameter is NOT used.

### `tls_cert_path`

| type | default | version |
| :--- | :--- | :--- |
| array of string | nil | 0.14.12 |

The additional CA certificate path for TLS.
The additional certificate path for TLS.

This parameter was the one for the CA certificate until v1.3.0. [`tls_ca_cert_path`](#tlscacertpath) took over that role in v1.3.1.

If both of [`tls_ca_cert_path`](#tlscacertpath) and this parameter are specified, this parameter is used and `tls_ca_cert_path` is NOT used.

### `tls_client_cert_path`

Expand Down