--- title: "Forward Protocol Input" description: "read events via the Fluent Forward protocol on a Unix domain socket\ \ or TCP port" source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/input/forward/module.yaml" --- Reads events via the [Fluent Forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1){target="\_blank"} on a Unix domain socket. Supports all standard Forward protocol modes: - **Message**: `[tag, time, record]` - **Forward**: `[tag, [[time, record], ...]]` - **PackedForward**: `[tag, packed_entries_bin]` Each record is decoded from msgpack and emitted as a JSON line with the Forward tag injected as a `"tag"` field. ## :material-wrench-outline: Config Files To configure the Forward protocol input module, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files. Below is the default configuration from: [forward/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/run/input/forward/config.yaml "forward/config.yaml"){target="\_blank"}.

Edit Online

```yaml # 🔟❎ 'run' Forward protocol input configuration # # Configure an input that receives events via the Fluent Forward protocol # on a Unix domain socket. To learn more see https://doc.log10x.com/run/input/forward/ # Set the 10x pipeline to 'run' tenx: run # =============================== Dependencies ================================ include: run/modules/input/forward # ======================== Forward Protocol Options ============================ forward: # ----------------------------- Input Options ----------------------------- # 'inputPort' specifies the TCP port to listen on for Forward protocol messages inputPort: $=TenXEnv.get("TENX_FORWARD_INPUT_SOCKET", "24224") # 'inputPath' specifies a Unix domain socket path to listen on instead of TCP. # When set, takes precedence over 'inputPort'. inputPath: $=TenXEnv.get("TENX_FORWARD_INPUT_ADDRESS", "") # ---------------------------- Parsing Options ---------------------------- # 'extractors' defines a list of JSON/regex extractor names # used to capture and redact event values from 'path' to transform # into TenXObjects. To learn more see: https://doc.log10x.com/run/input/extract extractors: [ ] # 'sourcePattern' defines a regex pattern that captures a 'source' value # for each event received via the Forward protocol and transformed into # a TenXObject. The Forward tag is injected as a "tag" field in each # record, so the default pattern extracts the source from the tag. sourcePattern: null ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") the Forward protocol input: |Name|Description| |---|---| |[forwardInputPort](#forwardinputport "TCP port for Forward protocol input")|TCP port for Forward protocol input| |[forwardInputPath](#forwardinputpath "Unix socket path for Forward protocol input (overrides port)")|Unix socket path for Forward protocol input (overrides port)| |[forwardSourcePattern](#forwardsourcepattern "event source capture regex pattern")|Event source capture regex pattern| |[forwardExtractors](#forwardextractors "JSON / regex extractor names applied to each Forward record")|JSON / regex extractor names applied to each Forward record| ### :material-menu-right-outline:**`forwardInputPort`** TCP port for Forward protocol input. |Type|Default| |---|---| |String|24224| TCP port where Log10x listens for incoming Fluent Forward protocol messages. Supports all standard Forward protocol modes (Message, Forward, PackedForward). Each incoming record is decoded from msgpack and emitted as JSON for the pipeline. Example: `24224`. ### :material-menu-right-outline:**`forwardInputPath`** Unix socket path for Forward protocol input (overrides port). |Type|Default| |---|---| |String|""| Unix domain socket path where Log10x listens for incoming Fluent Forward protocol messages. When set, takes precedence over the TCP port. Example: `/tmp/tenx-forward-in.sock`. ### :material-menu-right-outline:**`forwardSourcePattern`** Event source capture regex pattern. |Type|Default| |---|---| |String|"tag":"(.\*?)"| Defines a regex pattern to capture 'source' values for each transformed TenXObject. The Forward protocol tag is injected into each record as a "tag" field. The default pattern extracts this tag as the event source. ### :material-menu-right-outline:**`forwardExtractors`** JSON / regex extractor names applied to each Forward record. |Type|Default| |---|---| |List|\[\]| List of extractor names to apply to each event after Forward-protocol decoding. Each named extractor must be defined elsewhere in the pipeline (see https://doc.log10x.com/run/input/extract). Useful when the records coming over Forward carry a custom JSON shape and you want to capture specific fields as TenXObject properties.
:material-github: This module is defined in [forward/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/input/forward/module.yaml "forward/module.yaml"){target="\_blank"}.