--- title: "Pipeline Bootstrapper" description: "Authenticate the log10x account and launch a target pipeline" source: "https://github.com/log-10x/modules/tree/main/pipelines/shared/units/bootstrap/unit.yaml" icon: "material/launch" --- Authenticates the log10x account, validates launch arguments, and starts the specified pipeline ([run](https://doc.log10x.com/run/), [compile](https://doc.log10x.com/compile/)). ## :material-wrench-outline: Config Files To configure the Pipeline Bootstrapper unit, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files: ??? tenx-run "Run" ### Run {.hidden-heading} Launch a [run pipeline](https://doc.log10x.com/run "run pipeline") to report, receive and optimize log/trace events in edge and cloud environments. Below is the default configuration from: [bootstrap/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/pipelines/run/bootstrap/config.yaml "bootstrap/config.yaml"){target="\_blank"}.
Edit Online
Edit Pipeline Bootstrapper Config Locally
```yaml # 🔟❎ run bootstrap configuration # This config file specifies bootstrap options for the run pipeline. # To learn more see https://doc.log10x.com/run/bootstrap # To learn more see https://doc.log10x.com/config/ tenx: run # =============================== Launch Settings ============================== # 'licenseKey' specifies a signed JWT license token used for authenticating against the 10x service licenseKey: $=TenXEnv.get("TENX_LICENSE_KEY", "NO-LICENSE") # 'licenseFile' specifies a path to a file containing the signed JWT license token. # Preferred over 'licenseKey' on production hosts: the token does not appear in 'ps' output. licenseFile: $=TenXEnv.get("TENX_LICENSE_FILE") # 'airgapped' suppresses every call to the 10x SaaS gateway: the license is verified locally against the embedded # public key, and ALL outbound calls to the 10x SaaS gateway are suppressed (no DNS, no TCP). # Use for deployments where security review forbids vendor phone-home. airgapped: $=TenXEnv.get("TENX_AIRGAPPED", "false") # 'includePaths' specifies folders on disk for resolving relative config file/folder references in addition to the working folder includePaths: [] # 'quiet' disables printing version information to the console. # quiet: true # 'jarFiles' specifies .jar files to dynamically load for use by compile, input and output API extensions. jarFiles: [] # 'metricEndpoint' specifies a Prometheus remote-write endpoint for pipeline usage and health metrics. # Unset by default. The endpoint is a self-hosted or vendor Prometheus-compatible store, never a 10x # service, and is where the MCP reads engine state back from to tune policy such as regulator rates. # metricEndpoint: https://prometheus.example.com/api/v1/write # 'disabledArgs' specifies a list of launch arguments that are disallowed from either command line or user config files. disabledArgs: [] # 'debugEnvVars' list environment variables to debug debugEnvVars: [] ``` ??? tenx-compile "Compile" ### Compile {.hidden-heading} Launch a [compile pipeline](https://doc.log10x.com/compile "compile pipeline") to scan source code and binary files to generate symbol unit and library files. Below is the default configuration from: [bootstrap/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/pipelines/compile/bootstrap/config.yaml "bootstrap/config.yaml"){target="\_blank"}.
Edit Online
Edit Pipeline Bootstrapper Config Locally
```yaml # 🔟❎ compile bootstrap configuration # This config file specifies bootstrap options for the compile pipeline. # To learn more see https://doc.log10x.com/compile/bootstrap # To learn more see https://doc.log10x.com/config/ tenx: compile # =============================== Launch Settings ============================== # 'licenseKey' specifies a signed JWT license token used for authenticating against the 10x service licenseKey: $=TenXEnv.get("TENX_LICENSE_KEY", "NO-LICENSE") # 'licenseFile' specifies a path to a file containing the signed JWT license token. # Preferred over 'licenseKey' on production hosts: the token does not appear in 'ps' output. licenseFile: $=TenXEnv.get("TENX_LICENSE_FILE") # 'airgapped' suppresses every call to the 10x SaaS gateway: the license is verified locally against the embedded # public key, and ALL outbound calls to the 10x SaaS gateway are suppressed (no DNS, no TCP). airgapped: $=TenXEnv.get("TENX_AIRGAPPED", "false") # 'includePaths' specifies folders on disk for resolving relative config file/folder references in addition to the working folder includePaths: [] # 'quiet' disables printing version information to the console. # quiet: true # 'jarFiles' specifies .jar files to dynamically load for use by compile, input and output API extensions. jarFiles: [] # 'metricEndpoint' specifies a Prometheus remote-write endpoint for pipeline usage and health metrics. # Unset by default. The endpoint is a self-hosted or vendor Prometheus-compatible store, never a 10x # service, and is where the MCP reads engine state back from to tune policy such as regulator rates. # metricEndpoint: https://prometheus.example.com/api/v1/write # specifies a list of launch arguments that are disallowed from either command line or user config files. disabledArgs: [] ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") the Pipeline Bootstrapper: |Name|Description| |---|---| |[tenx](#tenx "name of pipeline to execute")|Name of pipeline to execute| |[licenseFile](#licensefile "path to a file containing the 10x license JWT")|Path to a file containing the 10x license JWT| |[licenseKey](#licensekey "10x license JWT (inline)")|10x license JWT (inline)| |[airgapped](#airgapped "run without contacting the 10x service")|Run without contacting the 10x service| |[metricEndpoint](#metricendpoint "10x service Prometheus metrics endpoint")|10x service Prometheus metrics endpoint| |[runtimeName](#runtimename "name to report to the 10x service endpoint for this runtime instance")|Name to report to the 10x service endpoint for this runtime instance| |[runtimeAttributes](#runtimeattributes "list of attributes to add to all metrics reporting")|List of attributes to add to all metrics reporting| |[includePaths](#includepaths "pipeline include folders")|Pipeline include folders| |[jarFiles](#jarfiles "jar files to load")|Jar files to load| |[quiet](#quiet "disable printing binary version information to the console")|Disable printing binary version information to the console| |[disabledArgs](#disabledargs "limit argument values that can be set by users")|Limit argument values that can be set by users| |[debugEnvVars](#debugenvvars "list environment variables to debug")|List environment variables to debug| ### :material-menu-right-outline:**`tenx`** Name of pipeline to execute. |Type|Required|Names| |---|---|---| |String|✔|\[tenx, pipeline\]| Target [pipeline](https://doc.log10x.com/engine/pipeline/) to execute. For example, to specify the [run](https://doc.log10x.com/run/) pipeline and a [YAML](https://doc.log10x.com/config/yaml/) config file containing launch arguments, use: ```console $ tenx run @~/my.yaml ``` The YAML file may specify the pipeline name via a 'tenx' entry, allowing the 'pipeline' argument to be omitted from the command line. For example (my.yaml): ```yaml tenx: run # set the pipeline to 'run' licenseKey: ... ``` Allows for launching the run pipeline via: ```console $ tenx @~/my.yaml ``` ### :material-menu-right-outline:**`licenseFile`** Path to a file containing the 10x license JWT. |Type|Default|Names| |---|---|---| |String|""|\[licenseFile, TENX\_LICENSE\_FILE\]| Path to a file containing the signed 10x license JWT. Preferred over `licenseKey` for production: the token is not visible in `ps` output and is easy to rotate by replacing the file. Without a license the engine runs on the built-in 30-day evaluation license. See [licensing](https://doc.log10x.com/manage/license/) for production licenses. If both `licenseFile` and `licenseKey` are provided, the file wins. ### :material-menu-right-outline:**`licenseKey`** 10x license JWT (inline). |Type|Default|Names| |---|---|---| |String|""|\[licenseKey, TENX\_LICENSE\_KEY\]| The signed 10x license JWT, passed inline. Discouraged on the command line because the value is visible in `ps` output; prefer `licenseFile` in production. Without a license the engine runs on the built-in 30-day evaluation license. See [licensing](https://doc.log10x.com/manage/license/) for production licenses. ### :material-menu-right-outline:**`airgapped`** Run without contacting the 10x service. |Type|Default|Names| |---|---|---| |Boolean|false|\[airgapped, TENX\_AIRGAPPED\]| When `true`, the license is verified locally (signature + claims) and no calls are made to the 10x service: no startup validation, no metrics reporting, no user-attribute enrichment. Suitable for fully airgapped deployments where the engine has no path to the vendor SaaS. When `false` (default), the engine additionally calls the 10x service at startup, and only when a service endpoint is actually configured; the default configuration names none, so an unconfigured engine makes no call either way. The call is best-effort enrichment: the local verification is the gate, and a service that cannot be reached, or that answers with an error, produces a warning and the engine runs. Airgapped mode is honored for every license type. ### :material-menu-right-outline:**`metricEndpoint`** 10x service Prometheus metrics endpoint. |Type|Default| |---|---| |String|""| Specifies the address of the Prometheus remote write endpoint to write pipeline usage and health metrics. Unset by default: an engine with no metric endpoint configured collects metrics locally and sends them nowhere. !!! note "" This argument is only settable in the 10x 'on-premises' build. ### :material-menu-right-outline:**`runtimeName`** Name to report to the 10x service endpoint for this runtime instance. |Type|Default| |---|---| |String|""| Specifies a logical name used as a [tag value](https://www.baeldung.com/micrometer#4-meters){target="\_blank"} for pipeline metrics. This value identifies instances of the 10x run/compile pipelines when reporting to the 10x service. For example, for a 10x [Receiver](https://doc.log10x.com/apps/receiver/) with optimization enabled for Fluent Bit forwarders collecting events from a `broker` user-app, this value can be set to: `receive_fluentbit_broker`. ### :material-menu-right-outline:**`runtimeAttributes`** List of attributes to add to all metrics reporting. |Type|Default| |---|---| |List|\[\]| Specifies a list of key-value pairs in the format `key:value` to be added as tags to pipeline metrics reported to the 10x service. These tags enable finer-grained filtering and analysis in monitoring systems like Prometheus. Multiple attributes can be combined into a single string using a semicolon (`;`), e.g., `key1:val1;key2:val2`. If a key does not start with tenx\_, the prefix tenx\_ is automatically prepended to ensure consistency in tag naming conventions. For example, a provided attribute app:my-app will be reported as tenx\_app:my-app ```yaml runtimeAttributes: - app:reporter - env:edge ``` ### :material-menu-right-outline:**`includePaths`** Pipeline include folders. |Type|Default| |---|---| |List|\[working directory of current process\]| Specifies folders on disk for resoling relative references within [include directives](https://doc.log10x.com/config/yaml/#include-directives). ### :material-menu-right-outline:**`jarFiles`** Jar files to load. |Type|Default| |---|---| |List|\[\]| Specifies a list of .jar files to load into the host JVM for use by [compile](https://doc.log10x.com/api/compile/), [input](https://doc.log10x.com/api/input/) and [output](https://doc.log10x.com/api/output/) API extensions. !!! note "" This argument is not supported in the [Runtime](https://doc.log10x.com/engine/flavors/#runtime) flavor. ### :material-menu-right-outline:**`quiet`** Disable printing binary version information to the console. |Type|Default| |---|---| |Boolean|false| Disable printing build/version information to the console upon launch. ### :material-menu-right-outline:**`disabledArgs`** Limit argument values that can be set by users. |Type|Default| |---|---| |List|\[\]| specifies a list of launch arguments that are disallowed from either command line or user config files. This argument provides a method of limiting the target [pipeline](https://doc.log10x.com/shared/bootstrap/#pipeline), [source](https://doc.log10x.com/config/#sources) and and [command line](https://doc.log10x.com/config/cli/) settable by the user. This mechanism enables pipeline launchers such as the [Quarkus launcher](https://doc.log10x.com/api/launch/#quarkus) to limit user input received via REST requests to a target subset of 'safe' arguments. For example, adding [procOutCommand](https://doc.log10x.com/run/output/event/process/#procoutcommand "command to launch") to this list ensures that no external process outputs can be launched by the runtime. An optional regex pattern can limit arguments to a certain subset of values in the form of: `[:pattern]` (e.g., specific process names). Multiple patterns can be specified per argument. Matching the `source` argument determines which source locations to inspect (e.g., folders, files, GitHub repos). For example, an admin may place .yaml config files containing preset Fluent Bit outputs in `/etc/log10x/`, excluding their enclosed arguments from limits set by this list, while disallowing users to directly set them via the command-line or by sourcing them from their local/GitHub config files (see example below). To limit: The target pipeline (e.g., [run](https://doc.log10x.com/run/), [compile](https://doc.log10x.com/compile/)): ```yaml disabledArgs: - "pipeline:^run" # disallow compile ``` Target arguments (e.g., [process outputs](https://doc.log10x.com/run/output/event/process/ "Write TenXObject and template values to a sub-process stdin")): ```yaml - "procOutCommand:^fluent-bit$" # limit to Fluent Bit only # - procOutArgs: # further limit args for Fluent Bit ``` Control which argument [sources](https://doc.log10x.com/config/#sources) to inspect: ```yaml - "source:^github.*" # inspect of all arguments sourced from GitHub against this list - "source:^(?!/etc/log10x/).*" # inspect of all arguments sourced from config files NOT contained in: /etc/log10x/ ``` ### :material-menu-right-outline:**`debugEnvVars`** List environment variables to debug. |Type|Default| |---|---| |List|\[\]| Specifies a list of env var names for which to log information relating to how they are resolved. For example, the following call: `L1Env.get("myVar", "myDefault")` can be resolved from a number of [sources](https://doc.log10x.com/api/js/#TenXEnv.get) ranging from launch arguments, to OS/JVM properties and a default value (e.g., myDefault). Setting this value to `myVar` will log INFO level information detailing how the value of the `myVar` was resolved.
:material-github: This unit is defined in [bootstrap/unit.yaml](https://github.com/log-10x/modules/tree/main/pipelines/shared/units/bootstrap/unit.yaml "bootstrap/unit.yaml"){target="\_blank"}. ## :material-wrench-outline: Config Files To configure the Pipeline Bootstrapper unit, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files: ??? tenx-run "Run" ### Run {.hidden-heading} Launch a [run pipeline](https://doc.log10x.com/run "run pipeline") to report, receive and optimize log/trace events in edge and cloud environments. Below is the default configuration from: [bootstrap/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/pipelines/run/bootstrap/config.yaml "bootstrap/config.yaml"){target="\_blank"}.
Edit Online
Edit Pipeline Bootstrapper Config Locally
```yaml # 🔟❎ run bootstrap configuration # This config file specifies bootstrap options for the run pipeline. # To learn more see https://doc.log10x.com/run/bootstrap # To learn more see https://doc.log10x.com/config/ tenx: run # =============================== Launch Settings ============================== # 'licenseKey' specifies a signed JWT license token used for authenticating against the 10x service licenseKey: $=TenXEnv.get("TENX_LICENSE_KEY", "NO-LICENSE") # 'licenseFile' specifies a path to a file containing the signed JWT license token. # Preferred over 'licenseKey' on production hosts: the token does not appear in 'ps' output. licenseFile: $=TenXEnv.get("TENX_LICENSE_FILE") # 'airgapped' suppresses every call to the 10x SaaS gateway: the license is verified locally against the embedded # public key, and ALL outbound calls to the 10x SaaS gateway are suppressed (no DNS, no TCP). # Use for deployments where security review forbids vendor phone-home. airgapped: $=TenXEnv.get("TENX_AIRGAPPED", "false") # 'includePaths' specifies folders on disk for resolving relative config file/folder references in addition to the working folder includePaths: [] # 'quiet' disables printing version information to the console. # quiet: true # 'jarFiles' specifies .jar files to dynamically load for use by compile, input and output API extensions. jarFiles: [] # 'metricEndpoint' specifies a Prometheus remote-write endpoint for pipeline usage and health metrics. # Unset by default. The endpoint is a self-hosted or vendor Prometheus-compatible store, never a 10x # service, and is where the MCP reads engine state back from to tune policy such as regulator rates. # metricEndpoint: https://prometheus.example.com/api/v1/write # 'disabledArgs' specifies a list of launch arguments that are disallowed from either command line or user config files. disabledArgs: [] # 'debugEnvVars' list environment variables to debug debugEnvVars: [] ``` ??? tenx-compile "Compile" ### Compile {.hidden-heading} Launch a [compile pipeline](https://doc.log10x.com/compile "compile pipeline") to scan source code and binary files to generate symbol unit and library files. Below is the default configuration from: [bootstrap/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/pipelines/compile/bootstrap/config.yaml "bootstrap/config.yaml"){target="\_blank"}.
Edit Online
Edit Pipeline Bootstrapper Config Locally
```yaml # 🔟❎ compile bootstrap configuration # This config file specifies bootstrap options for the compile pipeline. # To learn more see https://doc.log10x.com/compile/bootstrap # To learn more see https://doc.log10x.com/config/ tenx: compile # =============================== Launch Settings ============================== # 'licenseKey' specifies a signed JWT license token used for authenticating against the 10x service licenseKey: $=TenXEnv.get("TENX_LICENSE_KEY", "NO-LICENSE") # 'licenseFile' specifies a path to a file containing the signed JWT license token. # Preferred over 'licenseKey' on production hosts: the token does not appear in 'ps' output. licenseFile: $=TenXEnv.get("TENX_LICENSE_FILE") # 'airgapped' suppresses every call to the 10x SaaS gateway: the license is verified locally against the embedded # public key, and ALL outbound calls to the 10x SaaS gateway are suppressed (no DNS, no TCP). airgapped: $=TenXEnv.get("TENX_AIRGAPPED", "false") # 'includePaths' specifies folders on disk for resolving relative config file/folder references in addition to the working folder includePaths: [] # 'quiet' disables printing version information to the console. # quiet: true # 'jarFiles' specifies .jar files to dynamically load for use by compile, input and output API extensions. jarFiles: [] # 'metricEndpoint' specifies a Prometheus remote-write endpoint for pipeline usage and health metrics. # Unset by default. The endpoint is a self-hosted or vendor Prometheus-compatible store, never a 10x # service, and is where the MCP reads engine state back from to tune policy such as regulator rates. # metricEndpoint: https://prometheus.example.com/api/v1/write # specifies a list of launch arguments that are disallowed from either command line or user config files. disabledArgs: [] ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") the Pipeline Bootstrapper: |Name|Description| |---|---| |[tenx](#tenx "name of pipeline to execute")|Name of pipeline to execute| |[licenseFile](#licensefile "path to a file containing the 10x license JWT")|Path to a file containing the 10x license JWT| |[licenseKey](#licensekey "10x license JWT (inline)")|10x license JWT (inline)| |[airgapped](#airgapped "run without contacting the 10x service")|Run without contacting the 10x service| |[metricEndpoint](#metricendpoint "10x service Prometheus metrics endpoint")|10x service Prometheus metrics endpoint| |[runtimeName](#runtimename "name to report to the 10x service endpoint for this runtime instance")|Name to report to the 10x service endpoint for this runtime instance| |[runtimeAttributes](#runtimeattributes "list of attributes to add to all metrics reporting")|List of attributes to add to all metrics reporting| |[includePaths](#includepaths "pipeline include folders")|Pipeline include folders| |[jarFiles](#jarfiles "jar files to load")|Jar files to load| |[quiet](#quiet "disable printing binary version information to the console")|Disable printing binary version information to the console| |[disabledArgs](#disabledargs "limit argument values that can be set by users")|Limit argument values that can be set by users| |[debugEnvVars](#debugenvvars "list environment variables to debug")|List environment variables to debug| ### :material-menu-right-outline:**`tenx`** Name of pipeline to execute. |Type|Required|Names| |---|---|---| |String|✔|\[tenx, pipeline\]| Target [pipeline](https://doc.log10x.com/engine/pipeline/) to execute. For example, to specify the [run](https://doc.log10x.com/run/) pipeline and a [YAML](https://doc.log10x.com/config/yaml/) config file containing launch arguments, use: ```console $ tenx run @~/my.yaml ``` The YAML file may specify the pipeline name via a 'tenx' entry, allowing the 'pipeline' argument to be omitted from the command line. For example (my.yaml): ```yaml tenx: run # set the pipeline to 'run' licenseKey: ... ``` Allows for launching the run pipeline via: ```console $ tenx @~/my.yaml ``` ### :material-menu-right-outline:**`licenseFile`** Path to a file containing the 10x license JWT. |Type|Default|Names| |---|---|---| |String|""|\[licenseFile, TENX\_LICENSE\_FILE\]| Path to a file containing the signed 10x license JWT. Preferred over `licenseKey` for production: the token is not visible in `ps` output and is easy to rotate by replacing the file. Without a license the engine runs on the built-in 30-day evaluation license. See [licensing](https://doc.log10x.com/manage/license/) for production licenses. If both `licenseFile` and `licenseKey` are provided, the file wins. ### :material-menu-right-outline:**`licenseKey`** 10x license JWT (inline). |Type|Default|Names| |---|---|---| |String|""|\[licenseKey, TENX\_LICENSE\_KEY\]| The signed 10x license JWT, passed inline. Discouraged on the command line because the value is visible in `ps` output; prefer `licenseFile` in production. Without a license the engine runs on the built-in 30-day evaluation license. See [licensing](https://doc.log10x.com/manage/license/) for production licenses. ### :material-menu-right-outline:**`airgapped`** Run without contacting the 10x service. |Type|Default|Names| |---|---|---| |Boolean|false|\[airgapped, TENX\_AIRGAPPED\]| When `true`, the license is verified locally (signature + claims) and no calls are made to the 10x service: no startup validation, no metrics reporting, no user-attribute enrichment. Suitable for fully airgapped deployments where the engine has no path to the vendor SaaS. When `false` (default), the engine additionally calls the 10x service at startup, and only when a service endpoint is actually configured; the default configuration names none, so an unconfigured engine makes no call either way. The call is best-effort enrichment: the local verification is the gate, and a service that cannot be reached, or that answers with an error, produces a warning and the engine runs. Airgapped mode is honored for every license type. ### :material-menu-right-outline:**`metricEndpoint`** 10x service Prometheus metrics endpoint. |Type|Default| |---|---| |String|""| Specifies the address of the Prometheus remote write endpoint to write pipeline usage and health metrics. Unset by default: an engine with no metric endpoint configured collects metrics locally and sends them nowhere. !!! note "" This argument is only settable in the 10x 'on-premises' build. ### :material-menu-right-outline:**`runtimeName`** Name to report to the 10x service endpoint for this runtime instance. |Type|Default| |---|---| |String|""| Specifies a logical name used as a [tag value](https://www.baeldung.com/micrometer#4-meters){target="\_blank"} for pipeline metrics. This value identifies instances of the 10x run/compile pipelines when reporting to the 10x service. For example, for a 10x [Receiver](https://doc.log10x.com/apps/receiver/) with optimization enabled for Fluent Bit forwarders collecting events from a `broker` user-app, this value can be set to: `receive_fluentbit_broker`. ### :material-menu-right-outline:**`runtimeAttributes`** List of attributes to add to all metrics reporting. |Type|Default| |---|---| |List|\[\]| Specifies a list of key-value pairs in the format `key:value` to be added as tags to pipeline metrics reported to the 10x service. These tags enable finer-grained filtering and analysis in monitoring systems like Prometheus. Multiple attributes can be combined into a single string using a semicolon (`;`), e.g., `key1:val1;key2:val2`. If a key does not start with tenx\_, the prefix tenx\_ is automatically prepended to ensure consistency in tag naming conventions. For example, a provided attribute app:my-app will be reported as tenx\_app:my-app ```yaml runtimeAttributes: - app:reporter - env:edge ``` ### :material-menu-right-outline:**`includePaths`** Pipeline include folders. |Type|Default| |---|---| |List|\[working directory of current process\]| Specifies folders on disk for resoling relative references within [include directives](https://doc.log10x.com/config/yaml/#include-directives). ### :material-menu-right-outline:**`jarFiles`** Jar files to load. |Type|Default| |---|---| |List|\[\]| Specifies a list of .jar files to load into the host JVM for use by [compile](https://doc.log10x.com/api/compile/), [input](https://doc.log10x.com/api/input/) and [output](https://doc.log10x.com/api/output/) API extensions. !!! note "" This argument is not supported in the [Runtime](https://doc.log10x.com/engine/flavors/#runtime) flavor. ### :material-menu-right-outline:**`quiet`** Disable printing binary version information to the console. |Type|Default| |---|---| |Boolean|false| Disable printing build/version information to the console upon launch. ### :material-menu-right-outline:**`disabledArgs`** Limit argument values that can be set by users. |Type|Default| |---|---| |List|\[\]| specifies a list of launch arguments that are disallowed from either command line or user config files. This argument provides a method of limiting the target [pipeline](https://doc.log10x.com/shared/bootstrap/#pipeline), [source](https://doc.log10x.com/config/#sources) and and [command line](https://doc.log10x.com/config/cli/) settable by the user. This mechanism enables pipeline launchers such as the [Quarkus launcher](https://doc.log10x.com/api/launch/#quarkus) to limit user input received via REST requests to a target subset of 'safe' arguments. For example, adding [procOutCommand](https://doc.log10x.com/run/output/event/process/#procoutcommand "command to launch") to this list ensures that no external process outputs can be launched by the runtime. An optional regex pattern can limit arguments to a certain subset of values in the form of: `[:pattern]` (e.g., specific process names). Multiple patterns can be specified per argument. Matching the `source` argument determines which source locations to inspect (e.g., folders, files, GitHub repos). For example, an admin may place .yaml config files containing preset Fluent Bit outputs in `/etc/log10x/`, excluding their enclosed arguments from limits set by this list, while disallowing users to directly set them via the command-line or by sourcing them from their local/GitHub config files (see example below). To limit: The target pipeline (e.g., [run](https://doc.log10x.com/run/), [compile](https://doc.log10x.com/compile/)): ```yaml disabledArgs: - "pipeline:^run" # disallow compile ``` Target arguments (e.g., [process outputs](https://doc.log10x.com/run/output/event/process/ "Write TenXObject and template values to a sub-process stdin")): ```yaml - "procOutCommand:^fluent-bit$" # limit to Fluent Bit only # - procOutArgs: # further limit args for Fluent Bit ``` Control which argument [sources](https://doc.log10x.com/config/#sources) to inspect: ```yaml - "source:^github.*" # inspect of all arguments sourced from GitHub against this list - "source:^(?!/etc/log10x/).*" # inspect of all arguments sourced from config files NOT contained in: /etc/log10x/ ``` ### :material-menu-right-outline:**`debugEnvVars`** List environment variables to debug. |Type|Default| |---|---| |List|\[\]| Specifies a list of env var names for which to log information relating to how they are resolved. For example, the following call: `L1Env.get("myVar", "myDefault")` can be resolved from a number of [sources](https://doc.log10x.com/api/js/#TenXEnv.get) ranging from launch arguments, to OS/JVM properties and a default value (e.g., myDefault). Setting this value to `myVar` will log INFO level information detailing how the value of the `myVar` was resolved.
:material-github: This unit is defined in [bootstrap/unit.yaml](https://github.com/log-10x/modules/tree/main/pipelines/shared/units/bootstrap/unit.yaml "bootstrap/unit.yaml"){target="\_blank"}. ## :material-wrench-outline: Config Files To configure the Pipeline Bootstrapper unit, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files: ??? tenx-run "Run" ### Run {.hidden-heading} Launch a [run pipeline](https://doc.log10x.com/run "run pipeline") to report, receive and optimize log/trace events in edge and cloud environments. Below is the default configuration from: [bootstrap/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/pipelines/run/bootstrap/config.yaml "bootstrap/config.yaml"){target="\_blank"}.
Edit Online
Edit Pipeline Bootstrapper Config Locally
```yaml # 🔟❎ run bootstrap configuration # This config file specifies bootstrap options for the run pipeline. # To learn more see https://doc.log10x.com/run/bootstrap # To learn more see https://doc.log10x.com/config/ tenx: run # =============================== Launch Settings ============================== # 'licenseKey' specifies a signed JWT license token used for authenticating against the 10x service licenseKey: $=TenXEnv.get("TENX_LICENSE_KEY", "NO-LICENSE") # 'licenseFile' specifies a path to a file containing the signed JWT license token. # Preferred over 'licenseKey' on production hosts: the token does not appear in 'ps' output. licenseFile: $=TenXEnv.get("TENX_LICENSE_FILE") # 'airgapped' suppresses every call to the 10x SaaS gateway: the license is verified locally against the embedded # public key, and ALL outbound calls to the 10x SaaS gateway are suppressed (no DNS, no TCP). # Use for deployments where security review forbids vendor phone-home. airgapped: $=TenXEnv.get("TENX_AIRGAPPED", "false") # 'includePaths' specifies folders on disk for resolving relative config file/folder references in addition to the working folder includePaths: [] # 'quiet' disables printing version information to the console. # quiet: true # 'jarFiles' specifies .jar files to dynamically load for use by compile, input and output API extensions. jarFiles: [] # 'metricEndpoint' specifies a Prometheus remote-write endpoint for pipeline usage and health metrics. # Unset by default. The endpoint is a self-hosted or vendor Prometheus-compatible store, never a 10x # service, and is where the MCP reads engine state back from to tune policy such as regulator rates. # metricEndpoint: https://prometheus.example.com/api/v1/write # 'disabledArgs' specifies a list of launch arguments that are disallowed from either command line or user config files. disabledArgs: [] # 'debugEnvVars' list environment variables to debug debugEnvVars: [] ``` ??? tenx-compile "Compile" ### Compile {.hidden-heading} Launch a [compile pipeline](https://doc.log10x.com/compile "compile pipeline") to scan source code and binary files to generate symbol unit and library files. Below is the default configuration from: [bootstrap/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/pipelines/compile/bootstrap/config.yaml "bootstrap/config.yaml"){target="\_blank"}.
Edit Online
Edit Pipeline Bootstrapper Config Locally
```yaml # 🔟❎ compile bootstrap configuration # This config file specifies bootstrap options for the compile pipeline. # To learn more see https://doc.log10x.com/compile/bootstrap # To learn more see https://doc.log10x.com/config/ tenx: compile # =============================== Launch Settings ============================== # 'licenseKey' specifies a signed JWT license token used for authenticating against the 10x service licenseKey: $=TenXEnv.get("TENX_LICENSE_KEY", "NO-LICENSE") # 'licenseFile' specifies a path to a file containing the signed JWT license token. # Preferred over 'licenseKey' on production hosts: the token does not appear in 'ps' output. licenseFile: $=TenXEnv.get("TENX_LICENSE_FILE") # 'airgapped' suppresses every call to the 10x SaaS gateway: the license is verified locally against the embedded # public key, and ALL outbound calls to the 10x SaaS gateway are suppressed (no DNS, no TCP). airgapped: $=TenXEnv.get("TENX_AIRGAPPED", "false") # 'includePaths' specifies folders on disk for resolving relative config file/folder references in addition to the working folder includePaths: [] # 'quiet' disables printing version information to the console. # quiet: true # 'jarFiles' specifies .jar files to dynamically load for use by compile, input and output API extensions. jarFiles: [] # 'metricEndpoint' specifies a Prometheus remote-write endpoint for pipeline usage and health metrics. # Unset by default. The endpoint is a self-hosted or vendor Prometheus-compatible store, never a 10x # service, and is where the MCP reads engine state back from to tune policy such as regulator rates. # metricEndpoint: https://prometheus.example.com/api/v1/write # specifies a list of launch arguments that are disallowed from either command line or user config files. disabledArgs: [] ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") the Pipeline Bootstrapper: |Name|Description| |---|---| |[tenx](#tenx "name of pipeline to execute")|Name of pipeline to execute| |[licenseFile](#licensefile "path to a file containing the 10x license JWT")|Path to a file containing the 10x license JWT| |[licenseKey](#licensekey "10x license JWT (inline)")|10x license JWT (inline)| |[airgapped](#airgapped "run without contacting the 10x service")|Run without contacting the 10x service| |[metricEndpoint](#metricendpoint "10x service Prometheus metrics endpoint")|10x service Prometheus metrics endpoint| |[runtimeName](#runtimename "name to report to the 10x service endpoint for this runtime instance")|Name to report to the 10x service endpoint for this runtime instance| |[runtimeAttributes](#runtimeattributes "list of attributes to add to all metrics reporting")|List of attributes to add to all metrics reporting| |[includePaths](#includepaths "pipeline include folders")|Pipeline include folders| |[jarFiles](#jarfiles "jar files to load")|Jar files to load| |[quiet](#quiet "disable printing binary version information to the console")|Disable printing binary version information to the console| |[disabledArgs](#disabledargs "limit argument values that can be set by users")|Limit argument values that can be set by users| |[debugEnvVars](#debugenvvars "list environment variables to debug")|List environment variables to debug| ### :material-menu-right-outline:**`tenx`** Name of pipeline to execute. |Type|Required|Names| |---|---|---| |String|✔|\[tenx, pipeline\]| Target [pipeline](https://doc.log10x.com/engine/pipeline/) to execute. For example, to specify the [run](https://doc.log10x.com/run/) pipeline and a [YAML](https://doc.log10x.com/config/yaml/) config file containing launch arguments, use: ```console $ tenx run @~/my.yaml ``` The YAML file may specify the pipeline name via a 'tenx' entry, allowing the 'pipeline' argument to be omitted from the command line. For example (my.yaml): ```yaml tenx: run # set the pipeline to 'run' licenseKey: ... ``` Allows for launching the run pipeline via: ```console $ tenx @~/my.yaml ``` ### :material-menu-right-outline:**`licenseFile`** Path to a file containing the 10x license JWT. |Type|Default|Names| |---|---|---| |String|""|\[licenseFile, TENX\_LICENSE\_FILE\]| Path to a file containing the signed 10x license JWT. Preferred over `licenseKey` for production: the token is not visible in `ps` output and is easy to rotate by replacing the file. Without a license the engine runs on the built-in 30-day evaluation license. See [licensing](https://doc.log10x.com/manage/license/) for production licenses. If both `licenseFile` and `licenseKey` are provided, the file wins. ### :material-menu-right-outline:**`licenseKey`** 10x license JWT (inline). |Type|Default|Names| |---|---|---| |String|""|\[licenseKey, TENX\_LICENSE\_KEY\]| The signed 10x license JWT, passed inline. Discouraged on the command line because the value is visible in `ps` output; prefer `licenseFile` in production. Without a license the engine runs on the built-in 30-day evaluation license. See [licensing](https://doc.log10x.com/manage/license/) for production licenses. ### :material-menu-right-outline:**`airgapped`** Run without contacting the 10x service. |Type|Default|Names| |---|---|---| |Boolean|false|\[airgapped, TENX\_AIRGAPPED\]| When `true`, the license is verified locally (signature + claims) and no calls are made to the 10x service: no startup validation, no metrics reporting, no user-attribute enrichment. Suitable for fully airgapped deployments where the engine has no path to the vendor SaaS. When `false` (default), the engine additionally calls the 10x service at startup, and only when a service endpoint is actually configured; the default configuration names none, so an unconfigured engine makes no call either way. The call is best-effort enrichment: the local verification is the gate, and a service that cannot be reached, or that answers with an error, produces a warning and the engine runs. Airgapped mode is honored for every license type. ### :material-menu-right-outline:**`metricEndpoint`** 10x service Prometheus metrics endpoint. |Type|Default| |---|---| |String|""| Specifies the address of the Prometheus remote write endpoint to write pipeline usage and health metrics. Unset by default: an engine with no metric endpoint configured collects metrics locally and sends them nowhere. !!! note "" This argument is only settable in the 10x 'on-premises' build. ### :material-menu-right-outline:**`runtimeName`** Name to report to the 10x service endpoint for this runtime instance. |Type|Default| |---|---| |String|""| Specifies a logical name used as a [tag value](https://www.baeldung.com/micrometer#4-meters){target="\_blank"} for pipeline metrics. This value identifies instances of the 10x run/compile pipelines when reporting to the 10x service. For example, for a 10x [Receiver](https://doc.log10x.com/apps/receiver/) with optimization enabled for Fluent Bit forwarders collecting events from a `broker` user-app, this value can be set to: `receive_fluentbit_broker`. ### :material-menu-right-outline:**`runtimeAttributes`** List of attributes to add to all metrics reporting. |Type|Default| |---|---| |List|\[\]| Specifies a list of key-value pairs in the format `key:value` to be added as tags to pipeline metrics reported to the 10x service. These tags enable finer-grained filtering and analysis in monitoring systems like Prometheus. Multiple attributes can be combined into a single string using a semicolon (`;`), e.g., `key1:val1;key2:val2`. If a key does not start with tenx\_, the prefix tenx\_ is automatically prepended to ensure consistency in tag naming conventions. For example, a provided attribute app:my-app will be reported as tenx\_app:my-app ```yaml runtimeAttributes: - app:reporter - env:edge ``` ### :material-menu-right-outline:**`includePaths`** Pipeline include folders. |Type|Default| |---|---| |List|\[working directory of current process\]| Specifies folders on disk for resoling relative references within [include directives](https://doc.log10x.com/config/yaml/#include-directives). ### :material-menu-right-outline:**`jarFiles`** Jar files to load. |Type|Default| |---|---| |List|\[\]| Specifies a list of .jar files to load into the host JVM for use by [compile](https://doc.log10x.com/api/compile/), [input](https://doc.log10x.com/api/input/) and [output](https://doc.log10x.com/api/output/) API extensions. !!! note "" This argument is not supported in the [Runtime](https://doc.log10x.com/engine/flavors/#runtime) flavor. ### :material-menu-right-outline:**`quiet`** Disable printing binary version information to the console. |Type|Default| |---|---| |Boolean|false| Disable printing build/version information to the console upon launch. ### :material-menu-right-outline:**`disabledArgs`** Limit argument values that can be set by users. |Type|Default| |---|---| |List|\[\]| specifies a list of launch arguments that are disallowed from either command line or user config files. This argument provides a method of limiting the target [pipeline](https://doc.log10x.com/shared/bootstrap/#pipeline), [source](https://doc.log10x.com/config/#sources) and and [command line](https://doc.log10x.com/config/cli/) settable by the user. This mechanism enables pipeline launchers such as the [Quarkus launcher](https://doc.log10x.com/api/launch/#quarkus) to limit user input received via REST requests to a target subset of 'safe' arguments. For example, adding [procOutCommand](https://doc.log10x.com/run/output/event/process/#procoutcommand "command to launch") to this list ensures that no external process outputs can be launched by the runtime. An optional regex pattern can limit arguments to a certain subset of values in the form of: `[:pattern]` (e.g., specific process names). Multiple patterns can be specified per argument. Matching the `source` argument determines which source locations to inspect (e.g., folders, files, GitHub repos). For example, an admin may place .yaml config files containing preset Fluent Bit outputs in `/etc/log10x/`, excluding their enclosed arguments from limits set by this list, while disallowing users to directly set them via the command-line or by sourcing them from their local/GitHub config files (see example below). To limit: The target pipeline (e.g., [run](https://doc.log10x.com/run/), [compile](https://doc.log10x.com/compile/)): ```yaml disabledArgs: - "pipeline:^run" # disallow compile ``` Target arguments (e.g., [process outputs](https://doc.log10x.com/run/output/event/process/ "Write TenXObject and template values to a sub-process stdin")): ```yaml - "procOutCommand:^fluent-bit$" # limit to Fluent Bit only # - procOutArgs: # further limit args for Fluent Bit ``` Control which argument [sources](https://doc.log10x.com/config/#sources) to inspect: ```yaml - "source:^github.*" # inspect of all arguments sourced from GitHub against this list - "source:^(?!/etc/log10x/).*" # inspect of all arguments sourced from config files NOT contained in: /etc/log10x/ ``` ### :material-menu-right-outline:**`debugEnvVars`** List environment variables to debug. |Type|Default| |---|---| |List|\[\]| Specifies a list of env var names for which to log information relating to how they are resolved. For example, the following call: `L1Env.get("myVar", "myDefault")` can be resolved from a number of [sources](https://doc.log10x.com/api/js/#TenXEnv.get) ranging from launch arguments, to OS/JVM properties and a default value (e.g., myDefault). Setting this value to `myVar` will log INFO level information detailing how the value of the `myVar` was resolved.
:material-github: This unit is defined in [bootstrap/unit.yaml](https://github.com/log-10x/modules/tree/main/pipelines/shared/units/bootstrap/unit.yaml "bootstrap/unit.yaml"){target="\_blank"}.