--- title: "Stdout/err Output" description: "write TenXObject and template values to a log4j2 stdout appender" source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/stdout/module.yaml" icon: "octicons/command-palette-24" --- Writes [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 to stdout. ## :material-wrench-outline: Config Files To configure the Stdout/err 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: [stdout/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/run/output/event/stdout/config.yaml "stdout/config.yaml"){target="\_blank"}.
Edit Online
Edit config.yaml Locally
```yaml # 🔟❎ 'run' stdout output configuration # Configure stdout/err streams for writing TenXObject instance and template values. # To learn more see https://doc.log10x.com/run/output/event/stdout # Set the 10x pipeline to 'run' tenx: run # =============================== Dependencies ================================ include: run/modules/output/event/stdout # ============================= Stdout Options ================================ # Multiple stdout outputs can be defined below stdout: # ---------------------------10x Encoding Output ---------------------------- # Encode TenXObjects: https://doc.log10x.com/run/transform/#template-encoding # 'target' can be SYSTEM_OUT or SYSTEM_ERR - target: SYSTEM_OUT # '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: isObject # '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: - encode() # https://doc.log10x.com/api/js/#TenXObject+encode # ----------------------------- Decode Output ------------------------------- # Template-decode TenXObjects: https://doc.log10x.com/run/transform/#expand - target: SYSTEM_OUT filter: isEncoded # https://doc.log10x.com/api/js/#TenXBaseObject+isEncoded fields: - text # https://doc.log10x.com/api/js/#TenXBaseObject+text # ---------------------------- Template Output ------------------------------ # Writes TenXTemplate values: https://doc.log10x.com/run/transform/#template - target: SYSTEM_OUT # 'writeTemplates' controls whether to write new TenXObjects templates to stdout. # To learn more see https://doc.log10x.com/run/output/event/stdout/#stdoutwritetemplates writeTemplates: true # ----------------------------- Summary Output ------------------------------ # Writes aggregated TenXSummaries: https://doc.log10x.com/run/aggregate/ - target: SYSTEM_OUT filter: isSummary # https://doc.log10x.com/api/js/#TenXBaseObject+isSummary fields: - $=yield TenXEnv.get("enrichmentFields") # https://doc.log10x.com/run/initialize/#enrichmentFields - summaryVolume # https://doc.log10x.com/api/js/#TenXSummary+summaryVolume - summaryBytes # https://doc.log10x.com/api/js/#TenXSummary+summaryBytes - summaryTotals # https://doc.log10x.com/api/js/#TenXSummary+summaryTotals ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") multiple Stdout/err output: |Name|Description|Category| |---|---|---| |[stdoutTarget](#stdouttarget "target pipe to write to")|Target pipe to write to|Stdout| |[stdoutFields](#stdoutfields "list of TenXObject field names to encode")|List of TenXObject field names to encode|Encoding| |[stdoutFilter](#stdoutfilter "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| |[stdoutWriteObjects](#stdoutwriteobjects "if true, encode TenXObjects [stdoutFields](https://doc.log10x.com/run/output/event/stdout/#stdoutfields) to this output")|If true, encode TenXObjects \[stdoutFields\](https://doc.log10x.com/run/output/event/stdout/#stdoutfields) to this output|Encoding| |[stdoutWriteTemplates](#stdoutwritetemplates "if true, write new TenXTemplates to this output")|If true, write new TenXTemplates to this output|Encoding| |[stdoutEncodeType](#stdoutencodetype "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| |[stdoutEncodedLinePrefix](#stdoutencodedlineprefix "the line prefix prepended to the encoded event if 'stdoutEncodeType' is 'delimited'")|The line prefix prepended to the encoded event if 'stdoutEncodeType' is 'delimited'|Encoding| |[stdoutEncodeDelimiter](#stdoutencodedelimiter "the delimiter placed between key and values pairs if 'stdoutEncodeType' is 'delimited'")|The delimiter placed between key and values pairs if 'stdoutEncodeType' is 'delimited'|Encoding| |[stdoutEncodeGroupDelimiter](#stdoutencodegroupdelimiter "string delimiter to use when separating individual 10x events inside a group")|String delimiter to use when separating individual 10x events inside a group|Encoding| |[stdoutLog4j2](#stdoutlog4j2 "if true, write using log4j2 appender")|If true, write using log4j2 appender|Advanced| ### Stdout #### :material-menu-right-outline:**`stdoutTarget`** Target pipe to write to. |Type|Required|Category| |---|---|---| |String|✔|Stdout| Output device to write to. Possible values: SYSTEM\_OUT or SYSTEM\_ERR. ### Encoding #### :material-menu-right-outline:**`stdoutFields`** 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:**`stdoutFilter`** 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, 'stdoutFilter: 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:**`stdoutWriteObjects`** If true, encode TenXObjects \[stdoutFields\](https://doc.log10x.com/run/output/event/stdout/#stdoutfields) to this output. |Type|Default|Category| |---|---|---| |String|true|Encoding| Determine whether to write [stdoutFields](https://doc.log10x.com/run/output/event/stdout/#stdoutfields "list of TenXObject field names to encode") values of an TenXObject passed to this output. This configuration is typically defined using a JavaScript expression. For example, setting 'stdoutWriteObjects' to '$=TenXEnv.get("stdout")' enables/disables the output depending on whether a launch argument, environment variable, or JVM -D option evaluates as truthy. #### :material-menu-right-outline:**`stdoutWriteTemplates`** 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/#tetemplatefilesmplatefile) 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:**`stdoutEncodeType`** The output format in which to encode TenXObject values. Possible values:\[json, delimited\]. |Type|Default|Category| |---|---|---| |String|delimited|Encoding| Specifies how to encode [stdoutFields](https://doc.log10x.com/run/output/event/stdout/#stdoutfields "list of TenXObject field names to encode") values 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 [stdoutEncodeDelimiter](https://doc.log10x.com/run/output/event/stdout/#stdoutencodedelimiter "the delimiter placed between key and values pairs if 'stdoutEncodeType' is 'delimited'") argument determines the separator to use. #### :material-menu-right-outline:**`stdoutEncodedLinePrefix`** The line prefix prepended to the encoded event if 'stdoutEncodeType' is 'delimited'. |Type|Default|Category| |---|---|---| |String|~|Encoding| Sets the char which is prepended to the emitted TenXObject field values when [stdoutEncodeType](https://doc.log10x.com/run/output/event/stdout/#stdoutencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is `delimited`. #### :material-menu-right-outline:**`stdoutEncodeDelimiter`** The delimiter placed between key and values pairs if 'stdoutEncodeType' is 'delimited'. |Type|Default|Category| |---|---|---| |String| |Encoding| Sets the char delimiter to separate TenXObject field values when [stdoutEncodeType](https://doc.log10x.com/run/output/event/stdout/#stdoutencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is `delimited`. #### :material-menu-right-outline:**`stdoutEncodeGroupDelimiter`** String delimiter to use when separating individual 10x events inside a group. |Type|Default|Category| |---|---|---| |String|""|Encoding| Sets the string delimiter used to separate individual 10x events inside a group when encoded to a stream/event output. ### Advanced #### :material-menu-right-outline:**`stdoutLog4j2`** If true, write using log4j2 appender. |Type|Default|Category| |---|---|---| |Boolean|false|Advanced| Controls whether to write to file using an [OutputStream](https://doc.log10x.com/api/output/#outputstream) or a [log4j2 appender](https://doc.log10x.com/api/output/#log4j2).
:material-github: This module is defined in [stdout/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/stdout/module.yaml "stdout/module.yaml"){target="\_blank"}.