Stdin Device Input

Configures a stdin device input from which to read log/trace events to transform into typed TenXObjects.

Configuration

To configure the stdin device input module, Edit these settings.

Below is the default configuration from: stdin/config.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:

  # ---------------------------- 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

Options

Specify the options below to configure the stdin device input:

Name	Description
stdinEnabled	Enable/disable stdin input
stdinExtractors	JSON / regex extractor names
stdinSourcePattern	Event source capture regex pattern

`stdinEnabled`

Enable/disable stdin input.

Type	Default
Boolean	true

Specifies whether to read event data from the stdin pipe.

`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.

`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 member returns each TenXObject's assigned value.

This module is defined in stdin/module.yaml.