---
title: "Fluentd Forward Output"
description: "write TenXObject and template values to a log4j2 'forward' appender"
source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/forward/module.yaml"
icon: "simple/fluentd"

---
Defines a Fluentd/Bit [forward](https://docs.fluentbit.io/manual/pipeline/outputs/forward){target="\_blank"} Unix socket output to write [TenXObject](https://doc.log10x.com/api/js/#TenXObject "Provide structured, reflective access to log/trace events read from input(s).") instance and template field values.

For an example configuration, see the [Fluent Bit output](https://github.com/log-10x/modules/blob/main/pipelines/run/modules/input/forwarder/fluentbit/stream.yaml){target="\_blank"}.

## :material-wrench-outline: Config Files

To configure the Fluentd Forward output 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/output/event/forward/config.yaml "forward/config.yaml"){target="\_blank"}.  
  
<div class="edit-options">
    <a class="md-button tenx-edit-online-button" data-tooltip="Edit online on github.dev" href="https://github.dev/log-10x/config/blob/main/pipelines/run/output/event/forward/config.yaml" target="_blank" rel="noopener noreferrer">
        <span class="twemoji" style="margin-right: 0.3rem;">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
                <path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path>
            </svg>
        </span> Edit Online
    </a>
    <button class="md-button tenx-config.yaml0-edit-button" data-tooltip="Edit configuration file" data-dialog-id="config-yaml0-dialog">
        <span style="margin-right: 0.3rem;">
            <span class="twemoji">
                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
                    <path d="M20.71,7.04C21.1,6.65 21.1,6 20.71,5.63L18.37,3.29C18,2.9 17.35,2.9 16.96,3.29L15.12,5.12L18.87,8.87M3,17.25V21H6.75L17.81,9.93L14.06,6.18L3,17.25Z"></path>
                </svg>
            </span>
        </span>Edit Locally
    </button>
</div>

<dialog id="config-yaml0-dialog" class="md-dialog md-dialog--editor">
    <div class="editor-dialog-wrapper">
        <div class="editor-dialog-header">
            <span class="editor-dialog-title">Edit config.yaml Locally</span>
            <div class="editor-header-actions">
                <button class="editor-toolbar-btn yaml-editor-locations" data-tooltip="Save">
                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M5 20h14v-2H5v2m14-9h-4V3H9v8H5l7 7 7-7Z"></path></svg>
                </button>
                <button class="editor-toolbar-btn yaml-editor-reset" data-tooltip="Reset to default">
                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M12.5 8c-2.65 0-5.05 1-6.9 2.6L2 7v9h9l-3.62-3.62c1.39-1.16 3.16-1.88 5.12-1.88 3.54 0 6.55 2.31 7.6 5.5l2.37-.78C21.08 11.03 17.15 8 12.5 8z"></path></svg>
                </button>
                <button class="editor-toolbar-btn yaml-editor-copy" data-tooltip="Copy to clipboard">
                    <svg class="icon-copy" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M19 21H8V7h11m0-2H8a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h11a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2m-3-4H4a2 2 0 0 0-2 2v14h2V3h12V1Z"></path></svg>
                    <svg class="icon-check" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" style="display:none;"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg>
                </button>
                <span class="header-divider"></span>
                <button class="editor-toolbar-btn yaml-editor-fullscreen" data-tooltip="Fullscreen">
                    <svg class="icon-maximize" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M5,5H10V7H7V10H5V5M14,5H19V10H17V7H14V5M17,14H19V19H14V17H17V14M10,17V19H5V14H7V17H10Z"></path></svg>
                    <svg class="icon-minimize" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" style="display:none;"><path fill="currentColor" d="M5,16H8V19H10V14H5V16M14,14V19H16V16H19V14H14M16,5V8H19V10H14V5H16M10,5V10H5V8H8V5H10Z"></path></svg>
                </button>
                <span class="header-divider"></span>
                <button class="editor-toolbar-btn editor-dialog-close" onclick="closeDialog('config-yaml0-dialog')" data-tooltip="Close">
                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M19,6.41L17.59,5L12,10.59L6.41,5L5,6.41L10.59,12L5,17.59L6.41,19L12,13.41L17.59,19L19,17.59L13.41,12L19,6.41Z"></path></svg>
                </button>
            </div>
        </div>
        <div class="editor-dialog-content">
            <div class="yaml-editor-container"></div>
        </div>
        <div class="yaml-editor-statusbar">
            <span class="yaml-editor-status"></span>
        </div>
    </div>
    <!-- Locations Popup -->
    <div class="locations-popup" style="display: none;">
        <div class="locations-popup-content">
            <div class="locations-popup-header">
                <span class="locations-header-label">Download and save to:</span>
                <button class="locations-popup-close" aria-label="Close">
                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="16" height="16">
                        <path fill="currentColor" d="M19,6.41L17.59,5L12,10.59L6.41,5L5,6.41L10.59,12L5,17.59L6.41,19L12,13.41L17.59,19L19,17.59L13.41,12L19,6.41Z"></path>
                    </svg>
                </button>
            </div>
            <ul class="locations-list">
                <li>
                    <span class="location-label">Linux / Docker / macOS
                        <span class="help-icon" data-tooltip="Default system location. The engine automatically reads configs from here at startup. Best for production deployments.">
                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="12" height="12"><path fill="currentColor" d="M11 18h2v-2h-2v2m1-16A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8m0-14a4 4 0 0 0-4 4h2a2 2 0 0 1 2-2 2 2 0 0 1 2 2c0 2-3 1.75-3 5h2c0-2.25 3-2.5 3-5a4 4 0 0 0-4-4Z"/></svg>
                        </span>
                    </span>
                    <div class="location-path-row">
                        <code class="default-path location-path" data-tooltip=""
                            data-copy-osx="/etc/log10x/config/run/output/event/forward/config.yaml"
                            data-copy-nix="/etc/log10x/config/run/output/event/forward/config.yaml"
                            data-copy-win="C:\log10x\configs/run/output/event/forward/config.yaml"></code>
                        <button class="copy-btn" data-tooltip="Copy path">
                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="14" height="14">
                                <path fill="currentColor" d="M19 21H8V7h11m0-2H8a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h11a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2m-3-4H4a2 2 0 0 0-2 2v14h2V3h12V1Z"></path>
                            </svg>
                        </button>
                    </div>
                </li>
                <li>
                    <span class="location-label">Custom directory
                        <span class="help-icon" data-tooltip="Set TENX_CONFIG environment variable to point to a custom config directory. Useful when you want configs in a non-standard location.">
                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="12" height="12"><path fill="currentColor" d="M11 18h2v-2h-2v2m1-16A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8m0-14a4 4 0 0 0-4 4h2a2 2 0 0 1 2-2 2 2 0 0 1 2 2c0 2-3 1.75-3 5h2c0-2.25 3-2.5 3-5a4 4 0 0 0-4-4Z"/></svg>
                        </span>
                    </span>
                    <div class="location-path-row">
                        <code class="location-path" data-tooltip="$TENX_CONFIG/run/output/event/forward/config.yaml">$TENX_CONFIG/run/output/event/forward/config.yaml</code>
                        <button class="copy-btn" data-tooltip="Copy path">
                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="14" height="14">
                                <path fill="currentColor" d="M19 21H8V7h11m0-2H8a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h11a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2m-3-4H4a2 2 0 0 0-2 2v14h2V3h12V1Z"></path>
                            </svg>
                        </button>
                    </div>
                </li>
                <li>
                    <span class="location-label">Within cloned repo
                        <span class="help-icon" data-tooltip="First run: git clone github.com/log-10x/config. Then save the file to this path within the cloned folder. Use for version control.">
                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="12" height="12"><path fill="currentColor" d="M11 18h2v-2h-2v2m1-16A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8m0-14a4 4 0 0 0-4 4h2a2 2 0 0 1 2-2 2 2 0 0 1 2 2c0 2-3 1.75-3 5h2c0-2.25 3-2.5 3-5a4 4 0 0 0-4-4Z"/></svg>
                        </span>
                    </span>
                    <div class="location-path-row">
                        <code class="location-path" data-tooltip="./pipelines/run/output/event/forward/config.yaml">./pipelines/run/output/event/forward/config.yaml</code>
                        <button class="copy-btn" data-tooltip="Copy path">
                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="14" height="14">
                                <path fill="currentColor" d="M19 21H8V7h11m0-2H8a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h11a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2m-3-4H4a2 2 0 0 0-2 2v14h2V3h12V1Z"></path>
                            </svg>
                        </button>
                    </div>
                </li>
            </ul>
            <div class="locations-popup-footer">
                <button class="locations-download-btn" title="Download config file">
                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="14" height="14">
                        <path fill="currentColor" d="M5 20h14v-2H5v2m14-9h-4V3H9v8H5l7 7 7-7Z"></path>
                    </svg>
                    <span>Download</span>
                </button>
            </div>
        </div>
    </div>
</dialog>

<template class="tenx-config-schema" data-encoding="base64">{
  "type" : "object",
  "properties" : {
    "include" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "tenx" : {
      "type" : "string"
    },
    "outputForward" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
          "address" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "Location of target Unix domain socket for encoded object field values\n\nSpecifies a Unix domain socket address to write [TenXObject](https://doc.log10x.com/api/js/#TenXObject) instance and template field values. if specified, [outputForwardHostAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardhostaddress) and [outputForwardHostPort](https://doc.log10x.com/run/output/event/forward/#outputforwardhostport) are ignored"
          },
          "hostAddress" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "Host address of target fluent instance\n\nSpecifies a host address used together with [outputForwardHostPort](https://doc.log10x.com/run/output/event/forward/#outputforwardhostport) are ignored to encode object field values to. Ignored if [outputForwardAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardaddress) is specified (Default: 127.0.0.1)",
            "default" : "127.0.0.1"
          },
          "hostPort" : {
            "type" : [
              "string",
              "number",
              "null"
            ],
            "markdownDescription" : "Host port of target fluent instance\n\nSpecifies a host por used together with [outputForwardHostAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardhostaddress) are ignored to encode object field values to. Ignored if [outputForwardAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardaddress) is specified (Default: 24224)",
            "default" : "24224"
          },
          "fields" : {
            "type" : [
              "array",
              "string",
              "null"
            ],
            "markdownDescription" : "List of TenXObject field names to encode\n\nSpecifies a list of TenXObject intrinsic/calculated/extracted field names to extract and write to the output.",
            "items" : {
              "type" : "string"
            }
          },
          "writeObjects" : {
            "type" : [
              "string",
              "boolean",
              "null"
            ],
            "markdownDescription" : "If true, encode TenXObjects [outputForwardFields](https://doc.log10x.com/run/output/event/forward/#outputforwardfields) to this output\n\nDetermine whether to write [outputForwardFields](https://doc.log10x.com/run/output/event/forward/#outputforwardfields) values of an TenXObject passed to this output. This configuration is typically defined using a JavaScript expression.  To enable/disable the output depending on whether a launch argument, environment variable, or JVM -D option evaluates as truthy, use: ``` yaml   outputFileWriteObjects: $=TenXEnv.get(\"myForwardAddress\") ``` To learn more see [TenXEnv.get](https://doc.log10x.com/api/js/#TenXEnv.get). (Default: true)",
            "default" : "true"
          },
          "writeTemplates" : {
            "type" : [
              "string",
              "boolean",
              "null"
            ],
            "markdownDescription" : "If true, write new TenXTemplates to this output\n\nControls whether to write template values of TenXObjects passed to this output. The output will only emit TenXTemplates that the pipeline did not load at startup via the [templateFile](https://doc.log10x.com/run/template/#templatefiles) argument, and will only emit an TenXTemplate once based on its [templateHash](https://doc.log10x.com/api/js/#TenXBaseObject+templateHash) value. (Default: false)",
            "default" : "false"
          },
          "tagField" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "Field name to extract from an TenXObjects as its Fluentd 'tag' value\n\nSpecifies an intrinsic/extracted/calculated TenXObject field name to use as the TenXObject's forward `tag` value. To learn more see [Fluentd tagging](https://docs.fluentd.org/quickstart/life-of-a-fluentd-event#event-structure) (Default: the TenXObject's 'source' intrinsic field value, if present)",
            "default" : "the TenXObject's 'source' intrinsic field value, if present"
          },
          "tagValue" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "Default tag value for TenXObjects\n\nSpecifies an default value for TenXObject forward `tag` value, if the internal 'tag' and [outputForwardTagField](https://doc.log10x.com/run/output/event/forward/#outputforwardtagfield) returned empty"
          },
          "filter" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output\n\nSpecifies a JavaScript expression that an TenXObject must evaluate as truthy to write its instance/template field values to this output. For example, `outputForwardFilter: this.timestamp` will only emit [timestamped](https://doc.log10x.com/api/js/#TenXBaseObject+timestamped) TenXObjects."
          },
          "encodeType" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "The output format in which to encode TenXObject values. Possible values:[json, delimited]\n\nSpecifies how [outputForwardFields](https://doc.log10x.com/run/output/event/forward/#outputforwardfields) are encoded to a stream/event to this output. Possible values: - **json**: formats names and values for the current TenXObject as: {\"field\":\"str\",\"field2\":1, \"field3\": true} - **delimited**: formats values for the current TenXObject as: \"str\",1,true    The [outputForwardEncodeDelimiter](https://doc.log10x.com/run/output/event/forward/#outputforwardencodedelimiter) argument determines the separator to use. (Default: delimited)",
            "default" : "delimited"
          },
          "encodeDelimiter" : {
            "type" : [
              "string",
              "null"
            ],
            "markdownDescription" : "The delimiter placed between key and values pairs if 'outputForwardEncodeType' is 'delimited'\n\nSets the delimiter to separate TenXObject field values when [outputForwardEncodeType](https://doc.log10x.com/run/output/event/forward/#outputforwardencodetype) is `delimited`. (Default:  )",
            "default" : " "
          }
        }
      }
    }
  },
  "additionalProperties" : true
}</template>

```yaml
# 🔟❎ 'run' fluent forward output configuration

# Configure fluent forward outputs to write TenXObject instance and template field values.
# To learn more see https://doc.log10x.com/run/output/event/forward

# Set the 10x pipeline to 'run'
tenx: run

# =============================== Dependencies ================================

include:
  - run/modules/output/event/forward

# ============================== File Options =================================

# Multiple forward outputs can be defined below
outputForward:

  # --------------------------- 10x Encoding Output ---------------------------

    # Encode TenXObjects: https://doc.log10x.com/run/transform/#template-encoding

    # 'hostAddress' specifies the host address of target fluent instance
  - hostAddress: $=TenXEnv.get("TENX_REMOTE_FORWARD_HOST", "127.0.0.1")

    # 'hostPort' specifies the host port of target fluent instance
    hostPort: $=parseInt(TenXEnv.get("TENX_REMOTE_FORWARD_PORT", 24224))

    # 'filter' sets a JavaScript expression that TenXObjects must evaluate as truthy to write to the output.
    #  To learn more see https://doc.log10x.com/run/output/receive/#filter-expressions
    filter: null

    # 'fields' defines the fields to write for each TenXObject sent to this output.
    #  To learn more see https://doc.log10x.com/run/output/stream/#outputfields
    fields:
      - fullText # https://doc.log10x.com/api/js/#fulltext-string

    # 'encodeType' specifies how 'fields' are encoded to output. Possible values: [json,delimited].
    #  To learn more see https://doc.log10x.com/run/output/event/forward/#outputforwardencodetype
    encodeType: delimited

    # 'writeTemplates' controls whether to write new templates for TenXObjects written to this output.
    writeTemplates: true

    # 'tagValue' specifies a default tag for forwarded events without a source tag
    tagValue: ""
```

## :material-menu: Options

Specify the options below to [configure](/config "configure") multiple Fluentd Forward output:

|Name|Description|Category|
|---|---|---|
|[outputForwardAddress](#outputforwardaddress "location of target Unix domain socket for encoded object field values")|Location of target Unix domain socket for encoded object field values|Host|
|[outputForwardHostAddress](#outputforwardhostaddress "host address of target fluent instance")|Host address of target fluent instance|Host|
|[outputForwardHostPort](#outputforwardhostport "host port of target fluent instance")|Host port of target fluent instance|Host|
|[outputForwardFields](#outputforwardfields "list of TenXObject field names to encode")|List of TenXObject field names to encode|Encoding|
|[outputForwardWriteObjects](#outputforwardwriteobjects "if true, encode TenXObjects [outputForwardFields](https://doc.log10x.com/run/output/event/forward/#outputforwardfields) to this output")|If true, encode TenXObjects \[outputForwardFields\](https://doc.log10x.com/run/output/event/forward/#outputforwardfields) to this output|Encoding|
|[outputForwardWriteTemplates](#outputforwardwritetemplates "if true, write new TenXTemplates to this output")|If true, write new TenXTemplates to this output|Encoding|
|[outputForwardTagField](#outputforwardtagfield "field name to extract from an TenXObjects as its Fluentd 'tag' value")|Field name to extract from an TenXObjects as its Fluentd 'tag' value|Encoding|
|[outputForwardTagValue](#outputforwardtagvalue "default tag value for TenXObjects")|Default tag value for TenXObjects|Encoding|
|[outputForwardFilter](#outputforwardfilter "a JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output")|A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output|Encoding|
|[outputForwardEncodeType](#outputforwardencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]")|The output format in which to encode TenXObject values. Possible values:\[json, delimited\]|Encoding|
|[outputForwardEncodeDelimiter](#outputforwardencodedelimiter "the delimiter placed between key and values pairs if 'outputForwardEncodeType' is 'delimited'")|The delimiter placed between key and values pairs if 'outputForwardEncodeType' is 'delimited'|Encoding|

### Host

#### :material-menu-right-outline:**`outputForwardAddress`**

Location of target Unix domain socket for encoded object field values.

|Type|Default|Category|
|---|---|---|
|File||Host|

Specifies a Unix domain socket address to write [TenXObject](https://doc.log10x.com/api/js/#TenXObject "Provide structured, reflective access to log/trace events read from input(s).") instance and template field values.
if specified, [outputForwardHostAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardhostaddress "host address of target fluent instance") and [outputForwardHostPort](https://doc.log10x.com/run/output/event/forward/#outputforwardhostport "host port of target fluent instance") are ignored.


#### :material-menu-right-outline:**`outputForwardHostAddress`**

Host address of target fluent instance.

|Type|Default|Category|
|---|---|---|
|String|127.0.0.1|Host|

Specifies a host address used together with [outputForwardHostPort](https://doc.log10x.com/run/output/event/forward/#outputforwardhostport "host port of target fluent instance") are ignored to encode object field values to.
Ignored if [outputForwardAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardaddress "location of target Unix domain socket for encoded object field values") is specified.


#### :material-menu-right-outline:**`outputForwardHostPort`**

Host port of target fluent instance.

|Type|Default|Category|
|---|---|---|
|String|24224|Host|

Specifies a host por used together with [outputForwardHostAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardhostaddress "host address of target fluent instance") are ignored to encode object field values to.
Ignored if [outputForwardAddress](https://doc.log10x.com/run/output/event/forward/#outputforwardaddress "location of target Unix domain socket for encoded object field values") is specified.


### Encoding

#### :material-menu-right-outline:**`outputForwardFields`**

List of TenXObject field names to encode.

|Type|Default|Category|
|---|---|---|
|List|\[\]|Encoding|

Specifies a list of TenXObject intrinsic/calculated/extracted field names to extract and write to the output.


#### :material-menu-right-outline:**`outputForwardWriteObjects`**

If true, encode TenXObjects \[outputForwardFields\](https://doc.log10x.com/run/output/event/forward/#outputforwardfields) to this output.

|Type|Default|Category|
|---|---|---|
|String|true|Encoding|

Determine whether to write [outputForwardFields](https://doc.log10x.com/run/output/event/forward/#outputforwardfields "list of TenXObject field names to encode") values of an TenXObject passed to this output.
This configuration is typically defined using a JavaScript expression.

To enable/disable the output depending on whether a launch argument, environment variable,
or JVM -D option evaluates as truthy, use:

```yaml
  outputFileWriteObjects: $=TenXEnv.get("myForwardAddress")
```

To learn more see [TenXEnv.get](https://doc.log10x.com/api/js/#TenXEnv.get).


#### :material-menu-right-outline:**`outputForwardWriteTemplates`**

If true, write new TenXTemplates to this output.

|Type|Default|Category|
|---|---|---|
|String|false|Encoding|

Controls whether to write template values of TenXObjects passed to this output.
The output will only emit TenXTemplates that the pipeline did not load at startup via the [templateFile](https://doc.log10x.com/run/template/#templatefiles "input files or glob patterns containing JSON-encoded TenXTemplates") argument,
and will only emit an TenXTemplate once based on its [templateHash](https://doc.log10x.com/api/js/#TenXBaseObject+templateHash "An alphanumeric encoded value of a 64bit hash of the current object's template field.") value.


#### :material-menu-right-outline:**`outputForwardTagField`**

Field name to extract from an TenXObjects as its Fluentd 'tag' value.

|Type|Default|Category|
|---|---|---|
|String|the TenXObject's 'source' intrinsic field value, if present|Encoding|

Specifies an intrinsic/extracted/calculated TenXObject field name
to use as the TenXObject's forward `tag` value.
To learn more see [Fluentd tagging](https://docs.fluentd.org/quickstart/life-of-a-fluentd-event#event-structure){target="\_blank"}.


#### :material-menu-right-outline:**`outputForwardTagValue`**

Default tag value for TenXObjects.

|Type|Default|Category|
|---|---|---|
|String|""|Encoding|

Specifies an default value for TenXObject forward `tag` value, if the internal 'tag'
and [outputForwardTagField](https://doc.log10x.com/run/output/event/forward/#outputforwardtagfield "field name to extract from an TenXObjects as its Fluentd 'tag' value") returned empty.


#### :material-menu-right-outline:**`outputForwardFilter`**

A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output.

|Type|Default|Category|
|---|---|---|
|String|""|Encoding|

Specifies a JavaScript expression that an TenXObject must evaluate as truthy to write its
instance/template field values to this output.
For example, `outputForwardFilter: this.timestamp` will only emit [timestamped](https://doc.log10x.com/api/js/#TenXBaseObject+timestamped "Return true if length of timestamp is greater than 0") TenXObjects.


#### :material-menu-right-outline:**`outputForwardEncodeType`**

The output format in which to encode TenXObject values. Possible values:\[json, delimited\].

|Type|Default|Category|
|---|---|---|
|String|delimited|Encoding|

Specifies how [outputForwardFields](https://doc.log10x.com/run/output/event/forward/#outputforwardfields "list of TenXObject field names to encode") are encoded to a stream/event to this output. Possible values:

- **json**: formats names and values for the current TenXObject as: {"field":"str","field2":1, "field3": true}
- **delimited**: formats values for the current TenXObject as: "str",1,true
  The [outputForwardEncodeDelimiter](https://doc.log10x.com/run/output/event/forward/#outputforwardencodedelimiter "the delimiter placed between key and values pairs if 'outputForwardEncodeType' is 'delimited'") argument determines the separator to use.


#### :material-menu-right-outline:**`outputForwardEncodeDelimiter`**

The delimiter placed between key and values pairs if 'outputForwardEncodeType' is 'delimited'.

|Type|Default|Category|
|---|---|---|
|String| |Encoding|

Sets the delimiter to separate TenXObject field values when [outputForwardEncodeType](https://doc.log10x.com/run/output/event/forward/#outputforwardencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is `delimited`.


<br/>:material-github: This module is defined in [forward/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/forward/module.yaml "forward/module.yaml"){target="\_blank"}.

