fluent-forward¶

enabled¶

This indicates if the module is enabled or disabled.

socket_path¶

This indicates the path of the UDP socket to be listen. The socket will be created at runtime in the designated path.

For example <socket_path>/var/run/fluentd.sock</socket_path>.

tag¶

This indicates the tag to be added to the messages forwarded to the Fluentd server.

For example <tag>debug.test</tag>.

object_key¶

Fluent Forward packs every log into an object. This option defines the key of that object, whose value is the log itself.

For example <object_key>message</object_key>.

address¶

This indicates the address of the Fluentd server.

For example <address>localhost</address>.

port¶

This indicates de port number of the Fluentd server.

For example <port>24224</port>.

shared_key¶

This indicates the key known by the Fluentd server for authentication. This implicitly enables the TLS secure mode;

For example <shared_key>secret_string</shared_key>.

ca_file¶

This indicates path to a CA certificate file to validate the Fluentd server in TLS (secure mode only).

For example <ca_file>/root/conf/fluentd.crt</ca_file>.

user¶

This indicates the user name for authentication used on the Fluentd server TLS (secure mode only).

For example <user>foo</user>.

password¶

This indicates the user password for authentication used on the Fluentd server TLS (secure mode only).

For example <password>bar</password>.

timeout¶

This indicates the timeout in seconds for sending and receiving responses from the Fluentd server.

For example <timeout>10</timeout>.

poll_interval¶

Defines the connection health check interval (in seconds). If the module keeps idle during the defined time, it will poll the connection. If the connection is broken, the module will reconnect to the Fluent server.

For instance: <poll_interval>60</poll_interval>

keepalive¶

Enables TCP keepalive on the connection with the Fluent server. With the default configuration, the agent will wait indefinitely for the server to confirm a delivery. If <timeout> is disabled, or no data is available to send, the agent is unable to detect a broken connection.

This option allows enabling TCP keepalive and tune its options. When the connection becomes idle during <idle> seconds, the agent will start delivering one keepalive probe every <interval> seconds. If no response is received after <count> attempts, the agent will reset the connection.