---
title: "Stdin Device Input"
description: "read events from stdin"
source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/input/stdin/module.yaml"
icon: "octicons/command-palette-24"
---
Configures a stdin device input from which to read log/trace events to transform into typed [TenXObjects](https://doc.log10x.com/api/js/#TenXObject "Provide structured, reflective access to log/trace events read from input(s).").
## :material-wrench-outline: Config Files
To configure the stdin device 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: [stdin/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/run/input/stdin/config.yaml "stdin/config.yaml"){target="\_blank"}.
ewogICJ0eXBlIiA6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIiA6IHsKICAgICJpbmNsdWRlIiA6IHsKICAgICAgInR5cGUiIDogInN0cmluZyIKICAgIH0sCiAgICAidGVueCIgOiB7CiAgICAgICJ0eXBlIiA6ICJzdHJpbmciCiAgICB9LAogICAgInN0ZGluIiA6IHsKICAgICAgInR5cGUiIDogIm9iamVjdCIsCiAgICAgICJhZGRpdGlvbmFsUHJvcGVydGllcyIgOiBmYWxzZSwKICAgICAgInByb3BlcnRpZXMiIDogewogICAgICAgICJlbmFibGVkIiA6IHsKICAgICAgICAgICJ0eXBlIiA6IFsKICAgICAgICAgICAgInN0cmluZyIsCiAgICAgICAgICAgICJib29sZWFuIiwKICAgICAgICAgICAgIm51bGwiCiAgICAgICAgICBdLAogICAgICAgICAgIm1hcmtkb3duRGVzY3JpcHRpb24iIDogIkVuYWJsZS9kaXNhYmxlIHN0ZGluIGlucHV0XG5cblNwZWNpZmllcyB3aGV0aGVyIHRvIHJlYWQgZXZlbnQgZGF0YSBmcm9tIHRoZSBzdGRpbiBwaXBlIChEZWZhdWx0OiB0cnVlKSIsCiAgICAgICAgICAiZGVmYXVsdCIgOiAidHJ1ZSIKICAgICAgICB9LAogICAgICAgICJleHRyYWN0b3JzIiA6IHsKICAgICAgICAgICJ0eXBlIiA6IFsKICAgICAgICAgICAgImFycmF5IiwKICAgICAgICAgICAgInN0cmluZyIsCiAgICAgICAgICAgICJudWxsIgogICAgICAgICAgXSwKICAgICAgICAgICJtYXJrZG93bkRlc2NyaXB0aW9uIiA6ICJKU09OIC8gcmVnZXggZXh0cmFjdG9yIG5hbWVzXG5cbkRlZmluZXMgYSBsaXN0IG9mIEpTT04vcmVnZXggZXh0cmFjdG9yIG5hbWVzIHRvIGNhcHR1cmUgZXZlbnRzIGZyb20gJ2lucHV0RmlsZVBhdGgnIHRvIHRyYW5zZm9ybSBpbnRvIFRlblhPYmplY3RzLiBFYWNoIGl0ZW0gaW4gdGhlIGxpc3Qgc2hvdWxkIG1hcCB0byBhbiBleHRyYWN0b3IgZGVmaW5lZCB2aWEgYSBjb25maWd1cmF0aW9uIGZpbGUgb3Igc3RhcnR1cCBhcmd1bWVudHMgZ3JvdXAuIFRvIGxlYXJuIG1vcmUgc2VlOiBbZXh0cmFjdG9yc10oaHR0cHM6Ly9kb2MubG9nMTB4LmNvbS9ydW4vaW5wdXQvZXh0cmFjdCkuIiwKICAgICAgICAgICJpdGVtcyIgOiB7CiAgICAgICAgICAgICJ0eXBlIiA6ICJzdHJpbmciCiAgICAgICAgICB9CiAgICAgICAgfSwKICAgICAgICAic291cmNlUGF0dGVybiIgOiB7CiAgICAgICAgICAidHlwZSIgOiBbCiAgICAgICAgICAgICJzdHJpbmciLAogICAgICAgICAgICAibnVsbCIKICAgICAgICAgIF0sCiAgICAgICAgICAibWFya2Rvd25EZXNjcmlwdGlvbiIgOiAiRXZlbnQgc291cmNlIGNhcHR1cmUgcmVnZXggcGF0dGVyblxuXG5EZWZpbmVzIGEgcmVnZXggcGF0dGVybiB0byBjYXB0dXJlICdzb3VyY2UnIHZhbHVlcyBmb3IgZWFjaCB0cmFuc2Zvcm1lZCBUZW5YT2JqZWN0LiBUYWdzIHByb3ZpZGUgYSBtZXRob2QgZm9yIHNlcXVlbmNpbmcgVGVuWE9iamVjdHMgcmVhZCBmcm9tIHRoaXMgaW5wdXQgdmFsdWUgaW4gc2VwYXJhdGUgbG9naWNhbCBxdWV1ZXMuIEZvciBleGFtcGxlLCBjYXB0dXJpbmcgYSAnaG9zdCcgb3IgJ2ZpbGVOYW1lJyB2YWx1ZSBhcyBhICdzb3VyY2UnIGNyZWF0ZXMgYSBzZXBhcmF0ZSBsb2dpY2FsIHF1ZXVlIGZvciAgZWFjaCB1bmlxdWUgZmlsZS9ob3N0IG9yaWdpbiBieSB3aGljaCBUZW5YT2JqZWN0cyByZWFkIGZyb20gdGhpcyBpbnB1dCBhcmUgYWdncmVnYXRlZCBhbmQgd3JpdHRlbiB0byBvdXRwdXQuIFRoZSBbc291cmNlXShodHRwczovL2RvYy5sb2cxMHguY29tL2FwaS9qcy8jVGVuWE9iamVjdCtzb3VyY2UpIG1lbWJlciByZXR1cm5zIGVhY2ggVGVuWE9iamVjdCdzIGFzc2lnbmVkIHZhbHVlLiIKICAgICAgICB9CiAgICAgIH0KICAgIH0KICB9LAogICJhZGRpdGlvbmFsUHJvcGVydGllcyIgOiB0cnVlCn0=
```yaml
# 🔟❎ 'run' Stdin input configuration
# Configure a stdin event input. To learn more see https://doc.log10x.com/run/input/stdin/
# Set the 10x pipeline to 'run'
tenx: run
# =============================== Dependencies ================================
include: run/modules/input/stdin
# =============================== Stdin Options ===============================
# NOTE: a pipeline should configure no more than a single stdin input
stdin:
enabled: true
# ---------------------------- 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 read from the file and transformed into an TenXObject.
# This value will be used to sequence all events sharing this 'source' value correctly
# so they are not mixed with events originating from different locations.
sourcePattern: null
```
## :material-menu: Options
Specify the options below to [configure](/config "configure") the stdin device input:
|Name|Description|
|---|---|
|[stdinEnabled](#stdinenabled "enable/disable stdin input")|Enable/disable stdin input|
|[stdinExtractors](#stdinextractors "JSON / regex extractor names")|JSON / regex extractor names|
|[stdinSourcePattern](#stdinsourcepattern "event source capture regex pattern")|Event source capture regex pattern|
### :material-menu-right-outline:**`stdinEnabled`**
Enable/disable stdin input.
|Type|Default|Names|
|---|---|---|
|String|true|\[stdinEnabled, -in\]|
Specifies whether to read event data from the stdin pipe.
### :material-menu-right-outline:**`stdinExtractors`**
JSON / regex extractor names.
|Type|Default|
|---|---|
|List|\[\]|
Defines a list of JSON/regex extractor names to capture events from
'inputFilePath' to transform into TenXObjects. Each item in the list should map to an extractor
defined via a configuration file or startup arguments group.
To learn more see: [extractors](https://doc.log10x.com/run/input/extract "Filter, redact, and capture events from an input stream to transform into TenXObjects").
### :material-menu-right-outline:**`stdinSourcePattern`**
Event source capture regex pattern.
|Type|Default|
|---|---|
|String|""|
Defines a regex pattern to capture 'source' values for each transformed TenXObject.
Tags provide a method for sequencing TenXObjects read from this input value in separate logical queues.
For example, capturing a 'host' or 'fileName' value as a 'source' creates a separate logical queue for
each unique file/host origin by which TenXObjects read from this input are aggregated and written to output.
The [source](https://doc.log10x.com/api/js/#TenXObject+source "Returns the source value assigned to this instance by its input source pattern") member returns each TenXObject's assigned value.
:material-github: This module is defined in [stdin/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/input/stdin/module.yaml "stdin/module.yaml"){target="\_blank"}.