Forward

Forward is the protocol used by Fluent Bit and Fluentd to route messages between peers. This plugin implements the input service to listen for Forward messages.

Configuration Parameters

The plugin supports the following configuration parameters:

Key Description Default
Listen Listener network interface. 0.0.0.0
Port TCP port to listen for incoming connections. 24224
Buffer_Max_Size Specify the maximum buffer memory size used to receive a Forward message. The value must be according to the Unit Size specification. Buffer_Chunk_Size
Buffer_Chunk_Size By default the buffer to store the incoming Forward messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by Buffer_Chunk_Size. The value must be according to the Unit Size specification. 32KB

Getting Started

In order to receive Forward messages, you can run the plugin from the command line or through the configuration file:

Command Line

From the command line you can let Fluent Bit listen for Forward messages with the following options:

  1. $ fluent-bit -i forward -o stdout

By default the service will listen an all interfaces (0.0.0.0) through TCP port 24224, optionally you can change this directly, e.g:

  1. $ fluent-bit -i forward://192.168.3.2:9090 -o stdout

In the example the Forward messages will only arrive through network interface under 192.168.3.2 address and TCP Port 9090.

Configuration File

In your main configuration file append the following Input & Output sections:

  1. [INPUT]
  2.     Name              forward
  3.     Listen            0.0.0.0
  4.     Port              24224
  5.     Buffer_Chunk_Size 32KB
  6.     Buffer_Max_Size   64KB
  8. [OUTPUT]
  9.     Name   stdout
  10.     Match  *

Testing

Once Fluent Bit is running, you can send some messages using the fluent-cat tool (this tool is provided by Fluentd:

  1. $ echo '{"key 1": 123456789, "key 2": "abcdefg"}' | fluent-cat my_tag

In Fluent Bit we should see the following output:

  1. $ bin/fluent-bit -i forward -o stdout
  2. Fluent-Bit v0.9.0
  3. Copyright (C) Treasure Data
  5. [2016/10/07 21:49:40] [ info] [engine] started
  6. [2016/10/07 21:49:40] [ info] [in_fw] binding 0.0.0.0:24224
  7. [0] my_tag: [1475898594, {"key 1"=>123456789, "key 2"=>"abcdefg"}]