Symbol

Load symbol library files which enable the run pipeline to transform input log/trace events into typed TenXObjects.

The pipeline can pull up-to-date symbol library files from GitHub at start-up/periodically as part of a centralized GitOps configuration management approach.

Configuration

To configure the Symbol loader unit, Edit these settings.

Below is the default configuration from: symbol/config.yaml.

Edit Online

# 🔟❎ 'run' symbol file configuration

# Loads symbol library files to transform events into well-defined TenXObjects.
# To learn more see https://doc.log10x.com/run/symbol

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

# ============================ Symbol Options =================================

symbol:

  # 'paths' specifies the file/folder locations to scan for symbol library files.
  #  To learn more see https://doc.log10x.com/run/symbol/#symbolpaths
  paths:
    - $=path("data/shared/symbols", false)
    - $=path("<TENX_SYMBOLS_PATH>",  false)

  literals: []

Options

Specify the options below to configure the Symbol loader:

Name	Description	Category
symbolPaths	Input symbol files and folders	General
symbolLiterals	Symbol literal values	General
maxSymbolUnitsPerToken	Number of symbol units to retrieve when searching for the origin of an TenXTemplate symbol sequence	Advanced

General

`symbolPaths`

Input symbol files and folders.

Type	Default	Category
List	[path("sample/symbols")]	General

Specifies a list of glob patterns used to load symbols files (.json, .csv) into the pipeline upon initialization. Zip archives are extracted to the temp folder and deleted on exit.

`symbolLiterals`

Symbol literal values.

Type	Default	Category
List	[]	General

Specifies a list of literal symbol values to add to the host pipeline's symbol collection. This option enables declaring symbol values directly through the command line or via YAML/JSON configuration.

Advanced

`maxSymbolUnitsPerToken`

Number of symbol units to retrieve when searching for the origin of an TenXTemplate symbol sequence.

Type	Default	Category
Number	128	Advanced

Controls the maximum number of symbol units to load from the pipeline's symbol library when searching for the origin of a specific TenXTemplate symbol.

The symbolSequence function queries the source code/binary origin of symbol sequences in a target TenXTemplate to identify the logical "message" portions of app/infra events vs. variable values and MDC context.

Since symbols may appear in hundreds or more locations across a code base, limiting the number of symbol units to load is necessary to reduce memory consumption.
A second consideration in placing an upper limit on the number of units to load from the symbol library is the more frequent a symbol is, the lower the probability of selecting its correct origin.

This unit is defined in symbol/unit.yaml.