Global Options

Global options specify information required to start a 10x Engine such as account information, runtime instance name and the target pipeline (e.g., run, compile) to execute.

Options

Name	Description
pipeline	Name of pipeline to launch
licenseKey	10x license key
metricEndpoint	10x service Prometheus metrics endpoint
runtimeName	Name to report to the 10x service endpoint for this engine instance
configFolder	Pipeline configuration folder
dataFolder	Pipeline resource folder
quiet	Disable printing binary version information to the console

pipeline

Name of pipeline to launch.

Type	Required
String	✔

The 10x Engine scans the {$TENX_MODULES}/pipelines folder for sub-folders (e.g, {$TENX_MODULES}/pipelines/run) containing a pipeline specification .yaml file (e.g., run/pipeline.yaml). Each pipeline is registered as a sub-command of the 10x command line interface (e.g., $ tenx run [options], $ tenx compile [options]) and any option module specifications located within the pipeline's folder (e.g., Elastic input) are registered as sub-command options.

For example, to specify the 'run' pipeline and an 'elasticHost' argument value defined by the Elastic input module, use:

$ tenx run elasticHost acme.us-central1.gcp.cloud.es.io

Command line arguments may also be placed in a YAML configuration file:

$ tenx run @~/elastic.yaml

licenseKey

10x license key.

Type	Required	Names
String	✔	[licenseKey, TENX_LICENSE]

Specifies a license key used for authenticating against the 10x service. This value is accessible from your [account settings](Dor XXX).

metricEndpoint

10x service Prometheus metrics endpoint.

Type	Default
String	https://prometheus.log10x.com/api/v1/write

Specifies the address of the Prometheus remote write endpoint to write pipeline usage and health metrics. This argument is only settable in the 10x 'on-premises' build.

runtimeName

Name to report to the 10x service endpoint for this engine instance.

Type	Default
String	""

Specifies a logical name used as a tag value for pipeline metrics. This value identifies instances of the 10x run/compile pipelines when reporting to the 10x service. For example, for a 10x 'run' instance optimizing log/trace events collected by Fluent Bit forwarders from a 'broker' app, this value can be set to: 'optimize_fluentbit_broker'.

includePaths

Pipeline configuration folder.

Type	Default	Names
String	working directory of the 10x Engine process.	[includePaths, TENX_INCLUDE_PATHS]

Specifies a folder on disk to scan for pipeline specifications, module definitions, and configuration files.

quiet

Disable printing binary version information to the console.

Type	Default
Boolean	false

Disable printing build/version information to the console upon launch.